Recurso WindowsFeatureSet de DSC

Se aplica a: 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. Este es un recurso compuesto que llama al recurso WindowsFeature de cada una de las características especificadas en la propiedad Name.

Este recurso se usa cuando se desea configurar varias características de Windows para que tengan el mismo estado.

Nota

Esta documentación de este recurso de DSC trata la versión que se incluye con PowerShell antes de la versión 7.2. El módulo PSDscResources contiene recursos de DSC nuevos y actualizados compatibles oficialmente con Microsoft. El módulo PSDscResources está disponible en la Galería de PowerShell.

Para obtener más información y documentación actualizada, consulte la documentación de referencia de PSDscResources.

Sintaxis

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

Propiedades

Propiedad	Descripción
Nombre	Los nombres de los roles o características que quiere garantizar que se agreguen o se quiten. 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.
Source	Indica la ubicación del archivo de origen que se utilizará para la instalación, si es necesario.
IncludeAllSubFeature	Establezca esta propiedad en $true para incluir todas las subcaracterísticas requeridas de las características que se especifican con la propiedad Name.
Credential:	Las credenciales que se usarán para agregar o quitar los roles o las características.
LogPath	La ruta de acceso al archivo de registro en el que desea que el proveedor de recursos registre la operación.

Propiedades comunes

Propiedad	Descripción
DependsOn	Indica que la configuración de otro recurso debe ejecutarse antes de que se configure este recurso. 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".
Ensure	Indica si se agregan las funciones o características. Para asegurarse de que se agregan los roles o características, establezca esta propiedad en Present. Para asegurarse de que se quitan los roles o características, establezca la propiedad en Absent. El valor predeterminado es Present.
PsDscRunAsCredential	Establece la credencial con la que se ejecutará todo el recurso.

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. Para obtener más información, vea Uso de las credenciales con recursos de DSC.

Ejemplo

La siguiente configuración garantiza que se instalen las características servidor web (IIS) y servidor SMTP , y todas las subvalaciones de cada una de ellas.

configuration FeatureSetTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration

    Node localhost
    {

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