Remove-DscConfigurationDocument

  • Ссылка
Модуль:
PSDesiredStateConfiguration

Удаляет документ конфигурации из хранилища конфигураций DSC.

Синтаксис

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

Описание

Командлет Remove-DscConfigurationDocument удаляет документ конфигурации (.mofфайл) из хранилища конфигураций Windows PowerShell Desired State Configuration (DSC). Во время настройки Start-DscConfiguration командлет копирует файл в .mof папку на целевом компьютере. Этот командлет удаляет этот документ конфигурации и выполняет дополнительную очистку.

Этот командлет доступен только в составе накопительного пакета обновления за ноябрь 2014 г. для Windows RT 8.1, Windows 8.1 и Windows Server 2012 R2.

Примеры

Пример 1. Удаление текущего документа конфигурации

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

Первая команда создает сеанс CIM с помощью командлета New-CimSession , а затем сохраняет объект CimSession в переменной $Session. Команда запрашивает пароль. Для получения дополнительных сведений введите Get-Help New-CimSession.

Вторая команда удаляет текущий документ конфигурации для компьютера, указанного в CimSession , хранящейся в $Session.

Параметры

-AsJob

Указывает, что этот командлет выполняет команду как фоновое задание.

Если указать параметр AsJob, команда возвращает объект, представляющий задание, а затем появляется командная строка. Вы можете продолжить работу в рамках данного сеанса, пока задание не будет завершено. Задание создается на локальном компьютере, а результаты с удаленных компьютеров автоматически возвращаются на локальный компьютер. Для управления заданием используйте командлеты Job. Чтобы получить результаты задания, используйте Receive-Job командлет .

Чтобы использовать этот параметр, локальный и удаленный компьютеры должны быть настроены для удаленного взаимодействия, а в Windows Vista и более поздних версиях операционной системы Windows необходимо также запустить Windows PowerShell от имени администратора. Дополнительные сведения см. в разделе about_Remote_Requirements.

Дополнительные сведения о фоновых заданиях Windows PowerShell см. в разделах about_Jobs и about_Remote_Jobs.

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

-CimSession

Запуск командлета в удаленном сеансе или на удаленном компьютере. Введите имя компьютера или объект сеанса, например выходные данные командлета New-CimSession или Get-CimSession .

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Запрос подтверждения перед выполнением командлета.

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

-Force

Указывает, что этот командлет останавливает выполнение задания конфигурации перед удалением документа конфигурации. Принудительное выполнение команды без запроса на подтверждение пользователем.

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

-Stage

Указывает, какой документ конфигурации необходимо удалить. Можно указать несколько документов. Допустимые значения для этого параметра:

  • Current — Удалить документ конфигурации, описывающий текущее состояние системы.
  • Pending — удалите документ конфигурации, описывающий состояние системы в состоянии ожидания.
  • Previous — Удалите документ конфигурации, описывающий предыдущее состояние системы.
Type:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Accepted values:Current, Pending, Previous
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

Указание максимального количества одновременных операций, которые можно выполнять для запуска командлета. Если этот параметр опущен или введено значение 0 , то Windows PowerShell вычисляет оптимальное ограничение регулирования для командлета на основе количества командлетов CIM, запущенных на компьютере. Предел регулирования применим только к текущему командлету, а не к сеансу или компьютеру.

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

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

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

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

None

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

None