Recurso WindowsFeatureSet de DSCDSC WindowsFeatureSet Resource

Se aplica a: Windows PowerShell 5.xApplies To: Windows PowerShell 5.x

El recurso WindowsFeatureSet de la configuración de estado deseado (DSC) de Windows PowerShell ofrece un mecanismo para asegurarse de que los roles y las características se agreguen o quiten en un nodo de destino.The WindowsFeatureSet resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to ensure that roles and features are added or removed on a target node. Este es un recurso compuesto que llama al recurso WindowsFeature de cada una de las características especificadas en la propiedad Name .This resource is a composite resource that calls the WindowsFeature resource for each feature specified in the Name property.

Este recurso se usa cuando se desea configurar varias características de Windows para que tengan el mismo estado.Use this resource when you want to configure a number of Windows Features to the same state.

Nota

Esta documentación de este recurso de DSC abarca la versión que se incluye con PowerShell.This documentation of this DSC resource covers the version that is included with PowerShell. El módulo PSDscResources contiene recursos nuevos y actualizados que Microsoft admite oficialmente.The PSDscResources module contains new and updated that are officially supported by Microsoft. El módulo PSDscResources está disponible en la Galería de PowerShell.The PSDscResources module is available from the PowerShell Gallery.

Para obtener más información y documentación actualizada, consulte el archivo Léame en el repositorio de GitHub.For more information and updated documentation, see the README in the GitHub repository.

SintaxisSyntax

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

PropiedadesProperties

PropiedadProperty DescripciónDescription
NombreName Los nombres de los roles o características que quiere garantizar que se agreguen o se quiten.The names of the roles or features that you want to ensure are added or removed. Estos son los mismos que con la propiedad Name del cmdlet Get-WindowsFeature y no el nombre para mostrar de los roles o características.This is the same as the Name property of the Get-WindowsFeature cmdlet, and not the display name of the roles or features.
SourceSource Indica la ubicación del archivo de origen que se utilizará para la instalación, si es necesario.Indicates the location of the source file to use for installation, if necessary.
IncludeAllSubFeatureIncludeAllSubFeature Establezca esta propiedad en $true para incluir todas las subcaracterísticas requeridas de las características que se especifican con la propiedad Name .Set this property to $true to include all required subfeatures with of the features you specify with the Name property.
Credential:Credential Las credenciales que se usarán para agregar o quitar los roles o las características.The credentials to use to add or remove the roles or features.
LogPathLogPath La ruta de acceso al archivo de registro en el que desea que el proveedor de recursos registre la operación.The path to a log file where you want the resource provider to log the operation.

Propiedades comunesCommon properties

PropiedadProperty DescripciónDescription
DependsOnDependsOn Indica que la configuración de otro recurso debe ejecutarse antes de que se configure este recurso.Indicates that the configuration of another resource must run before this resource is configured. Por ejemplo, si el elemento ID del bloque del script de configuración del recurso que quiere ejecutar primero es ResourceName y su tipo es ResourceType, la sintaxis para usar esta propiedad es DependsOn = "[ResourceType]ResourceName".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
EnsureEnsure Indica si se agregan las funciones o características.Indicates whether the roles or features are added. Para asegurarse de que se agregan los roles o características, establezca esta propiedad en Present .To ensure that the roles or features are added, set this property to Present . Para asegurarse de que se quitan los roles o características, establezca la propiedad en Absent .To ensure that the roles or features are removed, set the property to Absent . El valor predeterminado es Present .The default value is Present .
PsDscRunAsCredentialPsDscRunAsCredential Establece la credencial con la que se ejecutará todo el recurso.Sets the credential for running the entire resource as.

Nota

Se ha agregado la propiedad común PsDscRunAsCredential en WMF 5.0 para permitir la ejecución de cualquier recurso de DSC en el contexto de otras credenciales.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. Para obtener más información, vea Uso de las credenciales con recursos de DSC.For more information, see Use Credentials with DSC Resources.

EjemploExample

La siguiente configuración garantiza que las características de Web Server (IIS) y del servidor SMTP , y todas las subcaracterísticas de cada uno, se instalan.The following configuration ensures that the Web-Server (IIS) and SMTP Server features, and all subfeatures of each, are installed.

configuration FeatureSetTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration
    Node localhost
    {

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