Recurso WindowsOptionalFeature de DSCDSC WindowsOptionalFeature Resource

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

El recurso WindowsOptionalFeature de la configuración de estado deseado (DSC) de Windows PowerShell proporciona un mecanismo para asegurarse de que las características óptimas están habilitadas en un nodo de destino.The WindowsOptionalFeature resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to ensure that optional features are enabled on a target node.

Nota

WindowsOptionalFeature solo funciona en máquinas cliente de Windows, como Windows 10.WindowsOptionalFeature only works on Windows client machines like Windows 10.

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

WindowsOptionalFeature [string] #ResourceName
{
    Name = [string]
    [ NoWindowsUpdateCheck = [bool] ]
    [ RemoveFilesOnDisable = [bool] ]
    [ LogLevel = [string] { ErrorsOnly | ErrorsAndWarning | ErrorsAndWarningAndInformation }  ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Enable | Disable }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

PropiedadesProperties

PropiedadProperty DescripciónDescription
NombreName Indica el nombre de la característica que desea asegurarse de que está habilitada o deshabilitada.Indicates the name of the feature that you want to ensure is enabled or disabled.
NoWindowsUpdateCheckNoWindowsUpdateCheck Especifica si DISM se pone en contacto con Windows Update (WU) al buscar los archivos de origen para habilitar una característica.Specifies whether DISM contacts Windows Update (WU) when searching for the source files to enable a feature. Si el valor es $true, DISM no se pone en contacto con WU.If $true, DISM does not contact WU.
RemoveFilesOnDisableRemoveFilesOnDisable Establézcalo en $true para quitar todos los archivos asociados con la característica cuando el valor de Ensure sea Absent .Set to $true to remove all files associated with the feature when Ensure is set to Absent .
LogLevelLogLevel El nivel de salida máximo que se muestra en los registros.The maximum output level shown in the logs. Los valores aceptados son: ErrorsOnly , ErrorsAndWarning , y ErrorsAndWarningAndInformation .The accepted values are: ErrorsOnly , ErrorsAndWarning , and ErrorsAndWarningAndInformation .
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 Especifica si está habilitada la característica.Specifies whether the feature is enabled. Para asegurarse de que la característica está habilitada, establezca esta propiedad en Enable .To ensure that the feature is enabled, set this property to Enable . Para asegurarse de que la característica está deshabilitada, establezca esta propiedad en Disable .To ensure that the feature is disabled, set the property to Disable . El valor predeterminado es Enable .The default value is Enable .
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.