Recurso de DSC WindowsFeature

  • Artículo

Se aplica a: Windows PowerShell 4.0, Windows PowerShell 5.x

El recurso WindowsFeature 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.

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

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

Propiedades

Propiedad Descripción
Nombre Indica el nombre del rol o la característica que quiere garantizar que se agregue o se quite. Esto es el mismo que la propiedad Name del cmdlet Get-WindowsFeature y no el nombre para mostrar del rol o la característica.
Credential: Indica las credenciales que se usarán para agregar o quitar el rol o la característica.
IncludeAllSubFeature Establezca esta propiedad en $true para garantizar el estado de todas las subcaracterísticas requeridas con el estado de la característica que se especifique con la propiedad Name.
LogPath Indica la ruta de acceso a un archivo de registro donde quiera 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 agrega el rol o la característica. Para asegurarse de que se agrega el rol o la característica, establezca esta propiedad en Present. Para asegurarse de que se quita el rol o la característica, 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

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
}