Windows PowerShell command on Get-command Publish-DscConfiguration

NAME

Publish-DscConfiguration

SYNOPSIS

Publishes a DSC configuration to a set of computers.

SYNTAX

Publish-DscConfiguration [-Path] -CimSession [-Confirm] [-Force] [-ThrottleLimit ]

[-WhatIf] []

Publish-DscConfiguration [-Path] [[-ComputerName] ] [-Confirm] [-Credential ]

[-Force] [-ThrottleLimit ] [-WhatIf] []

DESCRIPTION

The Publish-DscConfiguration cmdlet publishes a Windows PowerShell Desired State Configuration (DSC) configuration

document on set of computers. This cmdlet does not apply the configuration. Configurations are applied by either

the Start-DscConfiguration cmdlet when it is used with the UseExisting parameter or when the DSC engine runs its

consistency cycle. The DSC engine is also known as the Local Configuration Manager (LCM). This cmdlet is especially useful when fragments of multiple configuration documents are delivered. When multiple configuration documents fragments are delivered, they overwrite the older configuration document fragments.

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 one or more computers on which this cmdlet publishes the configuration. 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 credentials that are used to access the target device. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Force []

Forces the cmdlet to finish. If the Local Configuration Manager refresh mode is set to PULL, usage of this parameter changes it to PUSH and enables publication of the DSC configuration. Also, if a pending DSC configuration exists, usage of this parameter overwrites that pending configuration. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Path

Specifies a path that contains configurations to publish to target computers. Required? true Position? 0 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

-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: Publish a configuration to a remote computer

PS C:\>Publish-DscConfiguration -Path '$home\WebServer' -ComputerName "ContosoWebServer" -Credential

(get-credential Contoso\webadministrator)

This command publishes a configuration to a remote computer. The user who runs the cmdlet should be administrator on the remote computer.