Windows PowerShell command on Get-command Update-DscConfiguration

NAME

Update-DscConfiguration

SYNOPSIS

Checks the pull server for an updated configuration and applies it.

SYNTAX

Update-DscConfiguration -CimSession [-Confirm] [-JobName ] [-ThrottleLimit ] [-Wait]

[-WhatIf] []

Update-DscConfiguration [[-ComputerName] ] [-Confirm] [-Credential ] [-JobName ]

[-ThrottleLimit ] [-Wait] [-WhatIf] []

DESCRIPTION

The Update-DscConfiguration cmdlet connects to a pull server, downloads the configuration if it differs from what

is current on the node, and then applies the configuration to the computer. This cmdlet is available only as part of the November 2014 update rollup for Windows RT 8.1, Windows 8.1, and

Windows Server 2012 R2http://support.microsoft.com/en-us/kb/3000850

(http://support.microsoft.com/en-us/kb/3000850) from the Microsoft Support library. Before you use this cmdlet,

review the information in What's New in Windows PowerShellhttp://technet.microsoft.com/library/hh857339.aspx (http://technet.microsoft.com/library/hh857339.aspx) in the TechNet library.

PARAMETERS

-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? true Position? named Default value None Accept pipeline input? True (ByValue) Accept wildcard characters? false

-ComputerName

Specifies an array of computer names. The cmdlet applies the configuration settings to the computers that this parameter specifies. Required? false Position? 1 Default value None Accept pipeline input? True (ByValue) Accept wildcard characters? false

-Confirm []

Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Credential

Specifies a user name and password, as a PSCredential object, for the target computer. To obtain a

PSCredential object, use the Get-Credential cmdlet. For more information, type `Get-Help Get-Credential`.

Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-JobName

Specifies a friendly name for a job. If you specify this parameter, the cmdlet runs as a job, and it returns a Job object. By default, Windows PowerShell assigns the name JobN where N is an integer. If you specify the Wait parameter, do not specify this parameter. 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

-Wait []

Indicates that the cmdlet blocks the console until it finishes all configuration tasks.

If you specify this parameter, do not specify the JobName parameter.

Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-WhatIf []

Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value False 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: Update a configuration

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

PS C:\> Update-DscConfiguration -CimSession $Session -Wait

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 updates the computer specified in the CimSession stored in $Session. The command specifies the

Wait parameter. The console does not accept additional commands until the current command finishes.