Skip to content
PowerShell Commands

Set-DscLocalConfigurationManager

Set-DscLocalConfigurationManager [-Path*] <String> -CimSession* <CimSession[]> [-Confirm] [-Force] [-ThrottleLimit<Int32>] [-WhatIf] [<CommonParameters>]
Set-DscLocalConfigurationManager [-Path*] <String> [[-ComputerName] <String[]>] [-Confirm] [-Credential<PSCredential>] [-Force] [-ThrottleLimit <Int32>] [-WhatIf] [<CommonParameters>]

The Set-DscLocalConfigurationManager cmdlet applies Local Configuration Manager (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.

Parameters

-CimSession <CimSession[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input ByValue

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.

-ComputerName <String[]>

  • Default value is None
  • Accepts pipeline input ByValue

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.

-Confirm [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Prompts you for confirmation before running the cmdlet.

-Credential <PSCredential>

  • Default value is None
  • Accepts pipeline input False

Specifies a user name and password, as a PSCredential object, for the target computer. To obtain a PSCredential object, use the Get-Credential cmdlet.

-Force [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

@{Text=}

-Path <String>

  • This value is required
  • Default value is None
  • Accepts pipeline input False

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.

-ThrottleLimit <Int32>

  • Default value is None
  • Accepts pipeline input False

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.

-WhatIf [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Examples
  1. Apply LCM settings: 
    PS C:\>  Set-DscLocalConfigurationManager -Path "C:\DSC\Configurations\"

    This command applies the LCM settings from C:\DSC\Configurations\ to the targeted notes. After receiving the settings, LCM processes them.

  2. Apply LCM settings by using a CIM session: 
    PS C:\>  $Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
PS C:\>  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 the receiving the settings, LCM processes them.

Additional Notes




This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.
PowerShell Commands