DSC WindowsFeatureSet-resurs

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

WindowsFeatureSet-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. Den här resursen är en sammansatt resurs som anropar WindowsFeature-resursen för varje funktion som anges i egenskapen Namn .

Använd den här resursen när du vill konfigurera ett antal Windows-funktioner till samma tillstånd.

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

WindowsFeatureSet [string] #ResourceName
{
    Name = [string[]]
    [ Source = [string] ]
    [ IncludeAllSubFeature = [Boolean] ]
    [ Credential = [PSCredential] ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Egenskaper

Egenskap Beskrivning
Name Namnen på de roller eller funktioner som du vill kontrollera läggs till eller tas bort. Detta är samma som egenskapen Namn för cmdleten Get-WindowsFeature och inte visningsnamnet för rollerna eller funktionerna.
Källa Anger platsen för källfilen som ska användas för installation, om det behövs.
IncludeAllSubFeature Ställ in den här egenskapen på $true för att inkludera alla nödvändiga underfunktioner med de funktioner som du anger med egenskapen Namn .
Autentiseringsuppgift De autentiseringsuppgifter som ska användas för att lägga till eller ta bort roller eller funktioner.
LogPath 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 resurskonfigurationsskriptblocket 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 roller eller funktioner läggs till. För att säkerställa att rollerna eller funktionerna har lagts till ställer du in den här egenskapen på Presentera. För att säkerställa att rollerna eller funktionerna 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

Följande konfiguration säkerställer att funktionerna Web-Server (IIS) och SMTP Server , och alla underfunktioner för var och en, är installerade.

configuration FeatureSetTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration

    Node localhost
    {

        WindowsFeatureSet WindowsFeatureSetExample
        {
            Name                    = @("SMTP-Server", "Web-Server")
            Ensure                  = 'Present'
            IncludeAllSubFeature    = $true
        }
    }
}