Set-DscLocalConfigurationManager

  • Reference
Module:
PSDesiredStateConfiguration

Applies Local Configuration Manager (LCM) settings to nodes.

Syntax

Set-DscLocalConfigurationManager
   [-Path] <String>
   [-Force]
   [[-ComputerName] <String[]>]
   [-Credential <PSCredential>]
   [-ThrottleLimit <Int32>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-DscLocalConfigurationManager
   [-Path] <String>
   [-Force]
   [-ThrottleLimit <Int32>]
   -CimSession <CimSession[]>
   [-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.

Type:CimSession[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:String[]
Aliases:CN, ServerName
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required: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.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:0
Default value:None
Required:True
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 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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False