Set-DscLocalConfigurationManager
Applies Local Configuration Manager (LCM) settings to nodes.
Syntax
ComputerNameSet (Default)
Set-DscLocalConfigurationManager
[-Path] <String>
[[-ComputerName] <String[]>]
[-Force]
[-Credential <PSCredential>]
[-ThrottleLimit <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CimSessionSet
Set-DscLocalConfigurationManager
[-Path] <String>
-CimSession <CimSession[]>
[-Force]
[-ThrottleLimit <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-DscLocalConfigurationManager cmdlet applies LCM settings,
or meta-configuration, to nodes. Specify computers by specifying computer names or by using Common
Information Model (CIM) sessions. If you do not specify a target computer, the cmdlet applies
settings to the local computer.
Examples
Example 1: Apply LCM settings
Set-DscLocalConfigurationManager -Path "C:\DSC\Configurations\"
This command applies the LCM settings from C:\DSC\Configurations\ to the targeted nodes. After
receiving the settings, LCM processes them.
Warning
If there are multiple meta mofs for the same computer stored in the specified folder, only the first meta mof will be applied.
Example 2: Apply LCM settings by using a CIM session
$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Set-DscLocalConfigurationManager -Path "C:\DSC\Configurations\" -CimSession $Session
This example applies LCM settings to a computer and applies the settings. 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 applies LCM settings for the targeted node from C:\DSC\Configurations\ to the
computer identified by the CimSession objects stored in the $Session variable. In this example,
the $Session variable contains a CIM session only for the computer named Server01. The command
applies the settings. After receiving the settings, LCM processes them.
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
CimSessionSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ComputerName
Specifies an array of computer names. This parameter restricts the computers that have meta-configuration documents in the Path parameter to those specified in the array.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CN, ServerName |
Parameter sets
ComputerNameSet
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ComputerNameSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Path
Specifies a file path of a folder that contains configuration settings files. The cmdlet publishes
and applies these LCM settings to computers that have settings files in the specified path. Each
target node must have a settings file of the following format: NetBIOS Name.meta.mof.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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 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
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
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.
