Ресурс DSC WindowsOptionalFeature

Область применения: Windows PowerShell 5.x

Ресурс WindowsOptionalFeature в DSC Windows PowerShell предоставляет механизм включения дополнительных компонентов на целевом узле.

Примечание

WindowsOptionalFeature работает только на клиентских компьютерах Windows, таких как Windows 10.

Примечание

В этой документации по этому ресурсу DSC рассматривается версия, которая входит в состав PowerShell до версии 7.2. Модуль PSDscResources содержит новые и обновленные ресурсы DSC, которые официально поддерживаются корпорацией Майкрософт. Модуль PSDscResources доступен из коллекции PowerShell.

Дополнительные сведения и обновленную документацию см. в справочной документации по PSDscResources.

Синтаксис

WindowsOptionalFeature [string] #ResourceName
{
    Name = [string]
    [ NoWindowsUpdateCheck = [bool] ]
    [ RemoveFilesOnDisable = [bool] ]
    [ LogLevel = [string] { ErrorsOnly | ErrorsAndWarning | ErrorsAndWarningAndInformation }  ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Enable | Disable }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Свойства

Свойство Описание
Имя Указывает имя компонента, который необходимо включить или отключить.
NoWindowsUpdateCheck Указывает, обращается ли система DISM к Центру обновления Windows при поиске исходных файлов для включения компонента. Если задано значение $true, система DISM не обращается к Центру обновления Windows.
RemoveFilesOnDisable Задайте значение $true, чтобы удалить все файлы, связанные с компонентом, при его отключении (то есть когда свойству Ensure присваивается значение Absent).
LogLevel Максимальный уровень результатов, показываемый в журналах. Допустимые значения: ErrorsOnly, ErrorsAndWarning и ErrorsAndWarningAndInformation.
LogPath Путь к файлу журнала, в котором поставщик ресурсов должен вести журнал работы.

Общие свойства

Свойство Описание
DependsOn Указывает, что перед настройкой этого ресурса необходимо запустить настройку другого ресурса. Например, если идентификатор первого запускаемого блока сценария для конфигурации ресурса — ResourceName, а его тип — ResourceType, то синтаксис использования этого свойства таков: DependsOn = "[ResourceType]ResourceName".
Ensure Указывает, включена ли функция. Чтобы гарантировать, что эта функция включена, присвойте этому свойству значение Enable. Чтобы гарантировать, что эта функция отключена, присвойте этому свойству значение Disable. По умолчанию используется значение Enable.
PsDscRunAsCredential Задает учетные данные для выполнения всего ресурса от другого имени.

Примечание

В WMF 5.0 было добавлено общее свойство PsDscRunAsCredential, разрешающее запуск любого ресурса DSC в контексте других учетных данных. Дополнительные сведения см. в разделе Использование учетных данных с ресурсами DSC.