PowerShell Logo Small

Get-DscConfiguration



This is the built-in help made by Microsoft for the command 'Get-DscConfiguration', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Gets the current configuration of the nodes.

SYNTAX


Get-DscConfiguration [-AsJob] [-CimSession [<CimSession[]>]] [-ThrottleLimit [<Int32>]] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Get-DscConfiguration cmdlet gets the current configuration of the nodes, if the configuration exists. Specify computers by using Common Information Model (CIM) sessions.
If you do not specify a target computer, the cmdlet gets the configuration from the local computer.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=288760
Windows PowerShell Desired State Configuration Overview
Get-DscConfigurationStatus
Restore-DscConfiguration
Start-DscConfiguration
Test-DscConfiguration

REMARKS

<

Examples


Example 1: Get the configuration for the local computer

PS C:\> Get-DscConfiguration



This command gets the current state for the local computer.






Example 2: Get the configuration for a specified computer

PS C:\> $Session = New-CimSession –ComputerName "Server01" –Credential ACCOUNTS\PattiFuller
PS C:\> Get-DscConfiguration -CimSession $Session



This example gets the current state from a computer specified by a CIM session. The example creates a CIM session for a computer named Server01 for use with the cmdlet.
Alternatively, create an array of CIM sessions to apply the cmdlet to multiple specified computers.

The first command creates a CIM session by using the New-CimSession cmdlet, and then stores the CimSession object in the $Session variable. The command prompts you for a
password. For more information, type Get-Help New-CimSession.

The second command gets the current configuration for the computers identified by the CimSession objects stored in the $Session variable, in this case, the computer named
Server01.