Windows PowerShell Desired State Configuration Cmdlets

  • Article

Applies To: Windows Server 2012 R2 Preview

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Desired State Configuration Cmdlets

This reference provides cmdlet descriptions and syntax for all Desired State Configuration cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

Cmdlet Description

Get-DscConfiguration

Gets the current configuration of the node.

Get-DscLocalConfigurationManager

Gets Local Configuration Manager settings for the node.

Restore-DscConfiguration

Restores the previous configuration for the node.

Set-DscLocalConfigurationManager

Applies Local Configuration Manager settings to nodes.

Start-DscConfiguration

Applies configuration to nodes.

Test-DscConfiguration

Tests whether the actual configuration on the nodes matches the desired configuration.

Note

To list all the cmdlets that are available, use the Get-Command –Module PSDesiredStateConfiguration cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

● Get-Help <cmdlet name> -Detailed
● Get-Help <cmdlet name> -Examples
● Get-Help <cmdlet name> -Full

More Information

For more information about the cmdlets, see the following:

Windows PowerShell Desired State Configuration Overview