Get-DscConfigurationStatus

Retrieves data about completed configuration runs.
Get-DscConfigurationStatus [-All] [-AsJob] [-CimSession [<CimSession[]>]] [-ThrottleLimit [<Int32>]][<CommonParameters>]

The Get-DscConfigurationStatus cmdlet retrieves detailed information about completed configuration runs on the system. By default, it returns the information about the last configuration run. This cmdlet is useful for finding historical information about configuration runs, such as when the configurations were run, the status of the runs, the number of resources in the configurations, and which resources succeeded or failed.

Parameters
-All [<SwitchParameter>]

Indicates that this cmdlet retrieves information about all the configuration runs on the computer, including the configuration application and the consistency check.

-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 information on the last configuration run:
    PS C:> Get-DscConfigurationStatus
    

    This command gets information on the last configuration run.

  2. Get information on all configurations:
    PS C:> Get-DscConfigurationStatus -All
    

    This command gets information about all the configurations that were run on the system, including the Windows PowerShell Desired State Configuration (DSC) consistency check.

  3. Get information on the configuration run on a remote computer:
    PS C:> Get-DscConfigurationStaus -CimSession "Server01"
    

    This command gets the configuration run details of the remote computer named Server01. This uses the WSMan transport to connect to the remote computer and requires that the connecting user be an administrator on the remote computer.

Related Links

Get-DscConfiguration
Get-DscLocalConfigurationManager
Restore-DscConfiguration
Start-DscConfiguration
Test-DscConfiguration