Prostředek DSC WindowsFeature

Platí pro: Windows PowerShell 4.0, Windows PowerShell 5.x

Prostředek WindowsFeature v Windows PowerShell Desired State Configuration (DSC) poskytuje mechanismus, který zajišťuje přidání nebo odebrání rolí a funkcí na cílovém uzlu.

Poznámka

Tato dokumentace k tomuto prostředku DSC se zabývá verzí, která je součástí PowerShellu před verzí 7.2. Modul PSDscResources obsahuje nové a aktualizované prostředky DSC, které microsoft oficiálně podporuje. Modul PSDscResources je k dispozici v Galerie prostředí PowerShell.

Další informace a aktualizovanou dokumentaci najdete v referenční dokumentaci k PSDscResources.

Syntax

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

Vlastnosti

Vlastnost	Popis
Název	Označuje název role nebo funkce, u které chcete zajistit přidání nebo odebrání. Tato vlastnost je stejná jako vlastnost Name z rutiny Get-WindowsFeature , a ne zobrazovaný název role nebo funkce.
Přihlašovací údaj	Označuje přihlašovací údaje, které se mají použít k přidání nebo odebrání role nebo funkce.
IncludeAllSubFeature	Nastavte tuto vlastnost na, $true abyste zajistili stav všech požadovaných dílčích funkcí se stavem funkce, kterou zadáte pomocí vlastnosti Name .
LogPath	Označuje cestu k souboru protokolu, do kterého má poskytovatel prostředků protokolovat operaci.

Společné vlastnosti

Vlastnost	Popis
DependsOn	Označuje, že před konfigurací tohoto prostředku se musí spustit konfigurace jiného prostředku. Pokud je například ID bloku skriptu konfigurace prostředku, který chcete spustit jako první, ResourceName a jeho typ je ResourceType, syntaxe pro použití této vlastnosti je DependsOn = "[ResourceType]ResourceName".
Zajištění	Označuje, jestli je přidána role nebo funkce. Chcete-li zajistit, aby byla přidána role nebo funkce, nastavte tuto vlastnost na Hodnotu Prezentovat. Pokud chcete zajistit, aby byla role nebo funkce odebrána, nastavte vlastnost na Hodnotu Chybí. Výchozí hodnota je Present (Prezentovat).
PsDscRunAsCredential	Nastaví přihlašovací údaje pro spuštění celého prostředku jako.

Poznámka

Společná vlastnost PsDscRunAsCredential byla přidána ve WMF 5.0, aby bylo možné spouštět libovolný prostředek DSC v kontextu jiných přihlašovacích údajů. Další informace najdete v tématu Použití přihlašovacích údajů s prostředky DSC.

Příklad

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
}