Compartilhar via

Test-DscConfiguration

  • Referência
Módulo:
PSDesiredStateConfiguration

Testa se a configuração real nos nós corresponde à configuração desejada.

Sintaxe

Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-Detailed]
    [<CommonParameters>]
Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-Path] <String>
    [<CommonParameters>]
Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    -ReferenceConfiguration <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    [-Path] <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    -ReferenceConfiguration <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    [-Detailed]
    [<CommonParameters>]

Description

O cmdlet Test-DscConfiguration testa se a configuração real nos nós corresponde à configuração desejada. Especifique quais computadores você deseja testar configurações usando nomes de computador ou sessões de CIM (Common Information Model). Se você não especificar um computador de destino, o cmdlet testará a configuração do computador local.

Se as configurações desejadas e reais corresponderem, o cmdlet retornará um valor de cadeia de caracteres de 'True'. Caso contrário, ele retornará um valor de cadeia de caracteres de 'False'.

Exemplos

Exemplo 1: Testar a configuração do computador local

Test-DscConfiguration

Esse comando testa a configuração do computador local.

Exemplo 2: Testar a configuração de um computador especificado

$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Test-DscConfiguration -CimSession $Session

Este exemplo de configuração de teste de um computador especificado por uma sessão CIM. O exemplo cria uma sessão CIM para um computador chamado Server01 para uso com o cmdlet. Como alternativa, crie uma matriz de sessões CIM para aplicar o cmdlet a vários computadores especificados.

O primeiro comando cria uma sessão CIM usando o cmdlet New-CimSession e armazena o objeto CimSession na variável $Session. O comando solicita uma senha. Para obter mais informações, digite Get-Help New-CimSession.

O segundo comando testa a configuração dos computadores identificados pelo objetos cimSession armazenados na variável $Session, nesse caso, o computador chamado Server01.

Exemplo 3: Testar configurações com resultados detalhados

Test-DscConfiguration -ComputerName "Server01", "Server02", "Server03" -Detailed

Esse comando testa as configurações de um conjunto de computadores especificado pelo parâmetro ComputerName e retorna informações detalhadas que incluem o estado geral, os recursos que estão no estado desejado, os recursos que não estão no estado desejado e o nome do computador.

Exemplo 4: Testar configurações especificadas em uma pasta

Test-DscConfiguration -Path "C:\Dsc\Configurations"

Esse comando testa as configurações definidas em uma pasta especificada pelo parâmetro caminho. As configurações são testadas em um conjunto de computadores, cada um identificado pelo nome do arquivo de configuração.

Exemplo 5: Testar configurações especificadas em um arquivo

Test-DscConfiguration -ReferenceConfiguration "C:\Dsc\Configurations\WebServer.mof" -ComputerName "Server01", "Server02", "Server03"

Esse comando testa uma configuração definida em um arquivo em relação a um conjunto de computadores especificado pelo parâmetro ComputerName.

Parâmetros

-AsJob

Indica que esse cmdlet executa o comando como um trabalho em segundo plano.

Se você especificar o parâmetro AsJob, o comando retornará um objeto que representa o trabalho e exibirá o prompt de comando. Você pode continuar a trabalhar na sessão até que o trabalho seja concluído. O trabalho é criado no computador local e os resultados de computadores remotos são retornados automaticamente para o computador local. Para gerenciar o trabalho, use os cmdlets de trabalho. Para obter os resultados do trabalho, use o cmdlet Receive-Job.

Para usar esse parâmetro, os computadores locais e remotos devem ser configurados para comunicação remota e, no Windows Vista e versões posteriores do sistema operacional Windows, você deve abrir o Windows PowerShell com a opção Executar como administrador. Para obter mais informações, consulte about_Remote_Requirements.

Para obter mais informações sobre trabalhos em segundo plano do Windows PowerShell, consulte about_Jobs e about_Remote_Jobs.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-CimSession

Executa o cmdlet em uma sessão remota ou em um computador remoto. Insira um nome de computador ou um objeto de sessão, como a saída de um cmdlet New-CimSession ou Get-CimSession. O padrão é a sessão atual no computador local.

Tipo:CimSession[]
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ComputerName

Especifica uma matriz de nomes de computador em que esse cmdlet testa a configuração. O cmdlet testa o documento de configuração no local especificado pelo parâmetro Path para esses computadores.

Tipo:String[]
Aliases:CN, ServerName
Cargo:1
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Credential

Especifica um nome de usuário e uma senha, como um objeto PSCredential, para o computador de destino. Para obter um objeto PSCredential, use o cmdlet Get-Credential. Para obter mais informações, digite Get-Help Get-Credential.

Tipo:PSCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Detailed

Indica que esse cmdlet retorna um resultado detalhado da comparação do documento de configuração com o estado desejado dos nós. O resultado inclui informações como estado geral, recursos que estão no estado desejado, recursos que não estão no estado desejado e nome do computador.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Path

Especifica o caminho de uma pasta que contém arquivos de documento de configuração. O cmdlet testa a configuração em relação ao estado desejado dos computadores especificado pelo parâmetro ComputerName ou cimSession.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ReferenceConfiguration

Especifica o caminho do arquivo de documento de configuração. Esse cmdlet testa a configuração em relação ao estado real dos computadores especificado pelo parâmetro ComputerName ou cimSession.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ThrottleLimit

Especifica o número máximo de operações simultâneas que podem ser estabelecidas para executar o cmdlet. Se esse parâmetro for omitido ou um valor de 0 for inserido, o Windows PowerShell calculará um limite ideal para o cmdlet com base no número de cmdlets CIM em execução no computador. O limite de limitação se aplica somente ao cmdlet atual, não à sessão ou ao computador.

Tipo:Int32
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False