ComputerSettings.adoc

DSC Resource 'ComputerSettings'

ComputerSettings configures a computer by changing its name and description and modifying its Active Directory domain or workgroup membership.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/ComputerSettings
DSC Resource	ComputerManagementDsc
Documentation	Computer, TimeZone, RemoteDesktopAdmin

Table 1. Attributes of category 'ComputerSettings'

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The desired computer name.
Description		String	The value assigned here will be set as the local computer description.
DomainName		String	The name of the domain to join.
WorkGroupName		String	The name of the workgroup.
JoinOU		String	The distinguished name of the organizational unit that the computer account will be created in.
Credential		PSCredential	Credential to be used to join a domain.
TimeZone		String	Specifies the TimeZone.	Use Get-TimeZone -ListAvailable | Format-Table to get valid time zone strings.
AllowRemoteDesktop		Bool	Enables or disabled remote desktop.
RemoteDesktopUserAuthentication		String	Configures the authentication for remote desktop.	Secure Unsecure

Example

ComputerSettings:
  Name: TestServer
  Description: This is a test server
  DomainName: Contoso
  Credential: '[ENC=PE9ianMgVmVyc2lvbj0i...=]'
  TimeZone: Fiji Standard Time
  AllowRemoteDesktop: true
  RemoteDesktopUserAuthentication: Secure