Windows PowerShell command on Get-command Get-DscConfigurationStatus

NAME

Get-DscConfigurationStatus

SYNOPSIS

Retrieves data about completed configuration runs.

SYNTAX

Get-DscConfigurationStatus [-All] [-AsJob] [-CimSession ] [-ThrottleLimit ]

[]

DESCRIPTION

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 []

Indicates that this cmdlet retrieves information about all the configuration runs on the computer, including the configuration application and the consistency check. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-AsJob []

{{Fill AsJob Description}} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or

Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on

the local computer. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-ThrottleLimit

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. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

Example 1: Get information on the last configuration run

PS C:\>Get-DscConfigurationStatus

This command gets information on the last configuration run.

Example 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.

Example 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.