Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Publish-DscConfiguration
Publishes a DSC configuration to a set of computers.
Syntax
ComputerNameSet (Default)
Publish-DscConfiguration
[-Path] <String>
[[-ComputerName] <String[]>]
[-Force]
[-Credential <PSCredential>]
[-ThrottleLimit <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CimSessionSet
Publish-DscConfiguration
[-Path] <String>
-CimSession <CimSession[]>
[-Force]
[-ThrottleLimit <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Examples
Example 1: Publish a configuration to a remote computer
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.
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ComputerName
Specifies one or more computers on which this cmdlet publishes the configuration.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CN, ServerName |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-Credential
Specifies credentials that are used to access the target device.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Path
Specifies a path that contains configurations to publish to target computers.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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 PowerShell 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Related Links
Feedback
Was this page helpful?