Remove-DscConfigurationDocument

Синтаксис

Default (по умолчанию)

Remove-DscConfigurationDocument
    -Stage <Stage>
    [-Force]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

Примеры

Example 1: Remove the current configuration document

$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Remove-DscConfigurationDocument -Stage Current -CimSession $Session

Параметры

-AsJob

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. For more information, see about_Remote_Requirements.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

Свойства параметра

Наборы параметров

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

Свойства параметра

Наборы параметров

-Confirm

Prompts you for confirmation before running the cmdlet.

Свойства параметра

Наборы параметров

-Force

Indicates that this cmdlet stops the running configuration job before it removes the configuration document. Forces the command to run without asking for user confirmation.

Свойства параметра

Наборы параметров

-Stage

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

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.

Свойства параметра

Наборы параметров

-WhatIf

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

Свойства параметра

Наборы параметров

CommonParameters

Входные данные

Выходные данные

Связанные ссылки

• Windows PowerShell Desired State Configuration Overview
• Get-DscConfiguration
• Get-DscConfigurationStatus