Ресурс WindowsFeature в DSC

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

Ресурс WindowsFeature в DSC Windows PowerShell предоставляет механизм добавления и удаления ролей и компонентов на целевом узле.

Примечание

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

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

Синтаксис

WindowsFeature [string] #ResourceName
{
    Name = [string]
    [ Credential = [PSCredential] ]
    [ IncludeAllSubFeature = [bool] ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Свойства

Свойство	Описание
Имя	Указывает имя роли или компонента, которые необходимо добавить или удалить. Это свойство аналогично свойству Name командлета Get-WindowsFeature и не является отображаемым именем роли или компонента.
Учетные данные	Указывает учетные данные для добавления или удаления роли или компонента.
IncludeAllSubFeature	Присвойте этому свойству значение $true для синхронизации состояния всех необходимых дополнительных компонентов с состоянием компонента, указанного в свойстве Name.
LogPath	Указывает путь к файлу журнала, в котором поставщик ресурсов должен вести журнал работы.

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

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

Примечание

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

Пример

WindowsFeature RoleExample
{
    Ensure = "Present"
    # Alternatively, to ensure the role is uninstalled, set Ensure to "Absent"
    Name = "Web-Server" # Use the Name property from Get-WindowsFeature
}