Introdução a DSC (Desired State Configuration) para Windows

Este artigo explica como começar a usar o PowerShell Desired State Configuration (DSC) para Windows. Para obter informações gerais sobre o DSC, consulte Introdução à Configuração de Estado Desejado do Windows PowerShell.

Versões do sistema operacional Windows com suporte

As seguintes versões são compatíveis:

• Windows Server 2022
• Windows Server 2019
• Windows Server 2016
• Windows 11
• Windows 10

O produto autônomo Microsoft Hyper-V Server não contém uma implementação de Desired State Configuration para que você não possa gerenciá-lo usando o DSC do PowerShell ou Automação do Azure State Configuration.

Instalando a DSC

A Desired State Configuration do PowerShell está incluída no Windows e é atualizada por meio do Windows Management Framework. A versão mais recente é Windows Management Framework 5.1.

Observação

Você não precisa habilitar o recurso do Windows Server 'DSC-Service' para gerenciar um computador usando o DSC. Esse recurso só é necessário ao criar uma instância de servidor de pull do Windows.

Usar DSC para Windows

As seções a seguir explicam como criar e executar configurações da DSC em computadores Windows.

Criando um documento MOF de configuração

A palavra-chave Configuration do Windows PowerShell é usada para criar uma configuração. As etapas a seguir descrevem a criação de um documento de configuração usando o Windows PowerShell.

Instalar um módulo que contém recursos da DSC

A Desired State Configuration do Windows PowerShell inclui módulos internos que contêm recursos da DSC. Você também pode carregar módulos de fontes externas, como o Galeria do PowerShell, usando os cmdlets do PowerShellGet.

Install-Module 'PSDscResources' -Verbose

Definir uma configuração e gerar o documento de configuração:

Configuration EnvironmentVariable_Path
{
    param ()

    Import-DscResource -ModuleName 'PSDscResources'

    Node localhost
    {
        Environment CreatePathEnvironmentVariable
        {
            Name = 'TestPathEnvironmentVariable'
            Value = 'TestValue'
            Ensure = 'Present'
            Path = $true
            Target = @('Process', 'Machine')
        }
    }
}

EnvironmentVariable_Path -OutputPath:"./EnvironmentVariable_Path"

Aplicar a configuração ao computador

Observação

Para permitir que a DSC seja executada, o Windows precisa ser configurado para receber comandos remotos do PowerShell, mesmo quando você estiver executando uma configuração de localhost. Para configurar seu ambiente corretamente, apenas Set-WsManQuickConfig -Force em um Terminal do PowerShell com privilégios elevados.

Você pode aplicar documentos de configuração (arquivos MOF) a um computador com o cmdlet Start-DscConfiguration .

Start-DscConfiguration -Path 'C:\EnvironmentVariable_Path' -Wait -Verbose

Obter o estado atual da configuração

O cmdlet Get-DscConfiguration consulta o status atual do computador e retorna os valores atuais para a configuração.

Get-DscConfiguration

O cmdlet Get-DscLocalConfigurationManager retorna a metaconfiguração atual aplicada ao computador.

Get-DscLocalConfigurationManager

Remover a configuração atual de um computador

O Remove-DscConfigurationDocument

Remove-DscConfigurationDocument -Stage Current -Verbose

Configurar o Local Configuration Manager

Aplique um arquivo MOF de metaconfiguração ao computador usando o cmdlet Set-DSCLocalConfigurationManager. Exige o caminho até o MOF de metaconfiguração.

Set-DSCLocalConfigurationManager -Path 'c:\metaconfig\localhost.meta.mof' -Verbose

Arquivo de log da Desired State Configuration do Windows PowerShell

Os logs para DSC são gravados no Log de Eventos do Microsoft-Windows-Dsc/Operational Windows. Você pode habilitar outros logs para fins de depuração seguindo as etapas em Onde estão os logs de eventos DSC.