NAME
Get-DscConfiguration
SYNOPSIS
Gets the current configuration of the nodes.SYNTAX
Get-DscConfiguration [-AsJob] [-CimSession
] [-ThrottleLimit ] [ ] 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.PARAMETERS
-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, suchas 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? falseThis 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 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 inthe $Session variable, in this case, the computer named Server01.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821455Windows PowerShell Desired State Configuration Overview http://go.microsoft.com/fwlink/?LinkID=311940
Get-DscConfigurationStatus
Restore-DscConfiguration
Start-DscConfiguration
Test-DscConfiguration