Recurso do WindowsOptionalFeature DSC

Aplica-se a: Windows PowerShell 5.x

O recurso WindowsOptionalFeature na DSC (Configuração de Estado Desejado) do Windows PowerShell oferece um mecanismo para garantir que os recursos opcionais sejam habilitados em um nó de destino.

Observação

O WindowsOptionalFeature só funciona em computadores cliente do Windows, como o Windows 10.

Observação

Esta documentação desse recurso DSC aborda a versão incluída no PowerShell antes da versão 7.2. O módulo PSDscResources contém recursos de DSC novos e atualizados com suporte oficial da Microsoft. O módulo PSDscResources está disponível na Galeria do PowerShell.

Para obter mais informações e documentação atualizada, consulte a documentação de referência PSDscResources.

Sintaxe

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

Propriedades

Propriedade	Descrição
Nome	Indica o nome do recurso que você deseja garantir que esteja habilitado ou desabilitado.
NoWindowsUpdateCheck	Especifica se o DISM contata o WU (Windows Update) ao procurar os arquivos de origem para habilitar um recurso. Se $true, o DISM não contatará o WU.
RemoveFilesOnDisable	Definido como $true para remover todos os arquivos associados ao recurso quando Ensure estiver definido como Absent.
LogLevel	O nível máximo de saída mostrado nos logs. Os valores aceitos são: ErrorsOnly, ErrorsAndWarning e ErrorsAndWarningAndInformation.
LogPath	O caminho até um arquivo de log em que você deseja que o provedor de recursos registre a operação.

Propriedades comuns

Propriedade	Descrição
DependsOn	Indica que a configuração de outro recurso deve ser executada antes de ele ser configurado. Por exemplo, se a ID do bloco de script de configuração do recurso que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será DependsOn = "[ResourceType]ResourceName".
Ensure	Especifica se o recurso está habilitado. Para garantir que o recurso seja habilitado, defina essa propriedade como Enable. Para garantir que o recurso seja desabilitado, defina essa propriedade como Disable. O valor padrão é Enable.
PsDscRunAsCredential	Define a credencial para executar todo o recurso.

Observação

A propriedade comum PsDscRunAsCredential foi adicionada ao WMF 5.0 para permitir a execução de qualquer recurso de DSC no contexto de outras credenciais. Para saber mais, confira Usar credenciais com recursos de DSC.