Remove-DscConfigurationDocument
Удаляет документ конфигурации из хранилища конфигурации DSC.
Синтаксис
Default (по умолчанию)
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 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-CimSession
Выполняет командлет в удаленном сеансе или на удаленном компьютере. Введите имя компьютера или объект сеанса, например выходные данные командлета New-CimSession или Get-CimSession.
Свойства параметра
| Тип: | |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | Сессия |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Confirm
Запрашивает подтверждение перед запуском cmdlet.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Force
Указывает, что этот командлет останавливает выполнение задания конфигурации перед удалением документа конфигурации. Принудительно выполняется команда без запроса подтверждения пользователя.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Stage
Указывает, какой документ конфигурации следует удалить. Можно указать несколько документов. Допустимые значения для этого параметра:
-
Current. Удалите документ конфигурации, описывающий текущее состояние системы. -
Pending. Удалите документ конфигурации, описывающий ожидающее состояние системы. -
Previous. Удалите документ конфигурации, описывающий предыдущее состояние системы.
Свойства параметра
| Тип: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage |
| Default value: | None |
| Допустимые значения: | Current, Pending, Previous |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ThrottleLimit
Указывает максимальное количество параллельных операций, которые можно установить для выполнения командлета. Если этот параметр опущен или введено значение 0, Windows PowerShell вычисляет оптимальное ограничение регулирования для командлета на основе количества командлетов CIM, работающих на компьютере. Ограничение регулирования применяется только к текущему командлету, а не к сеансу или к компьютеру.
Свойства параметра
| Тип: | Int32 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-WhatIf
Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
