Поделиться через

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, команда возвращает объект, представляющий задание, а затем отображает командную строку. Вы можете продолжать работать в сеансе, пока задание не завершится. Задание создается на локальном компьютере, а результаты удаленных компьютеров автоматически возвращаются на локальный компьютер. Чтобы управлять заданием, используйте командлеты задания. Чтобы получить результаты задания, используйте командлет Receive-Job.

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

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-CimSession

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

Тип:CimSession[]
Aliases:Session
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Force

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Stage

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

  • Current. Удалите документ конфигурации, описывающий текущее состояние системы.
  • Pending. Удалите документ конфигурации, описывающий ожидающее состояние системы.
  • Previous. Удалите документ конфигурации, описывающий предыдущее состояние системы.
Тип:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Допустимые значения:Current, Pending, Previous
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ThrottleLimit

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

Тип:Int32
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-WhatIf

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

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

None

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

None