DSC WindowsFeature-resurs

Gäller för: Windows PowerShell 4.0, Windows PowerShell 5.x

WindowsFeature-resursen i Windows PowerShell Desired State Configuration (DSC) tillhandahåller en mekanism för att säkerställa att roller och funktioner läggs till eller tas bort på en målnod.

Anteckning

Den här dokumentationen för den här DSC-resursen omfattar den version som ingår i PowerShell före version 7.2. MODULen PSDscResources innehåller nya och uppdaterade DSC-resurser som stöds officiellt av Microsoft. Modulen PSDscResources är tillgänglig från PowerShell-galleriet.

Mer information och uppdaterad dokumentation finns i referensdokumentationen för PSDscResources.

Syntax

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

Egenskaper

Egenskap	Beskrivning
Name	Anger namnet på den roll eller funktion som du vill se till att läggs till eller tas bort. Detta är samma som egenskapen Namn från cmdleten Get-WindowsFeature och inte visningsnamnet för rollen eller funktionen.
Autentiseringsuppgift	Anger de autentiseringsuppgifter som ska användas för att lägga till eller ta bort rollen eller funktionen.
IncludeAllSubFeature	Ange den här egenskapen för $true att säkerställa tillståndet för alla nödvändiga underfunktioner med tillståndet för den funktion som du anger med egenskapen Namn .
LogPath	Anger sökvägen till en loggfil där du vill att resursprovidern ska logga åtgärden.

Gemensamma egenskaper

Egenskap	Beskrivning
DependsOn	Anger att konfigurationen av en annan resurs måste köras innan den här resursen har konfigurerats. Om till exempel ID:t för det resurskonfigurationsskriptblock som du vill köra först är ResourceName och dess typ är ResourceType är DependsOn = "[ResourceType]ResourceName"syntaxen för att använda den här egenskapen .
Säkerställa	Anger om rollen eller funktionen läggs till. Om du vill se till att rollen eller funktionen har lagts till anger du den här egenskapen till Presentera. Om du vill se till att rollen eller funktionen tas bort anger du egenskapen till Frånvarande. Standardvärdet är Present.
PsDscRunAsCredential	Anger autentiseringsuppgifterna för att köra hela resursen som.

Anteckning

Den vanliga egenskapen PsDscRunAsCredential lades till i WMF 5.0 för att tillåta körning av valfri DSC-resurs i kontexten för andra autentiseringsuppgifter. Mer information finns i Använda autentiseringsuppgifter med DSC-resurser.

Exempel

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
}