Get-DscConfiguration

Gets the current configuration of the nodes.
Get-DscConfiguration [-AsJob] [-CimSession [<CimSession[]>]] [-ThrottleLimit [<Int32>]] [<CommonParameters>]

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.

Parameters
-AsJob [<SwitchParameter>]

Indicates that this cmdlet runs the command as a background job.

If you specify the AsJob parameter, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session until the job finishes. The job is created on the local computer and the results from remote computers are automatically returned to the local computer. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.

To use this parameter, the local and remote computers must be configured for remoting, and on Windows Vista and later versions of the Windows operating system, you must open Windows PowerShell with the Run as administrator option.

-CimSession [<CimSession[]>]

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShellr calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Examples
  1. Get the configuration for the local computer:
    PS C:>  Get-DscConfiguration
    

    This command gets the current state for the local computer.

  2. Get the configuration for a specified computer:
    PS C:>  $Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTSPattiFuller
    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.

Related Links

Get-DscConfigurationStatus
Restore-DscConfiguration
Start-DscConfiguration
Test-DscConfiguration