Remove-DscConfigurationDocument

Removes a configuration document from the DSC configuration store.
Remove-DscConfigurationDocument [-AsJob] [-CimSession [<CimSession[]>]] [-Force] [-ThrottleLimit [<Int32>]] -Stage*{Current | Pending | Previous} [-Confirm] [-WhatIf] [<CommonParameters>]

The Remove-DscConfigurationDocument cmdlet removes a configuration document (.mof file) from the Windows PowerShell Desired State Configuration (DSC) configuration store. During configuration, the Start-DscConfiguration cmdlet copies a .mof file to a folder on the target computer. This cmdlet removes that configuration document and does additional cleanup.

This cmdlet is available only as part of the November 2014 update rollup for Windows RT 8.1, Windows 8.1, and Windows Server 2012 R2 (http://support.microsoft.com/en-us/kb/3000850) from the Microsoft Support library. Before you use this cmdlet, review the information in What’s New in Windows PowerShell (http://technet.microsoft.com/library/hh857339.aspx) in the TechNet library.

Parameters
-AsJob [<SwitchParameter>]

Indicates that this cmdlet runs the command as a background job.

If you specify the AsJob parameter, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session until the job finishes. The job is created on the local computer and the results from remote computers are automatically returned to the local computer. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.

To use this parameter, the local and remote computers must be configured for remoting, and on Windows Vista and later versions of the Windows operating system, you must open Windows PowerShell with the Run as administrator option.

-CimSession [<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.

-Force [<SwitchParameter>]

Indicates that this cmdlet stops the running configuration job before it removes the configuration document.

-Stage <Stage>

  • This value is required

Specifies which configuration document to remove. You can specify multiple documents. The acceptable values for this parameter are:

— Current. Remove the configuration document that describes the current state of the system. — Pending. Remove the configuration document that describes the pending state of the system. — Previous. Remove the configuration document that describes the previous state of the system.

-ThrottleLimit [<Int32>]

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.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

Shows what would happen if the cmdlet runs. The cmdlet is not run.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.

Inputs

None

Outputs

None

Examples
  1. Remove the current configuration document:
    PS C:> $Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTSPattiFuller
    PS C:>  Remove-DscConfigurationDocument -Stage Current -CimSession $Session
    

    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 removes the current configuration document for the computer specified in the CimSession stored in $Session.

Related Links

Get-DscConfiguration
Get-DscConfigurationStatus