Start-DscConfiguration

  • Referência
Módulo:
PSDesiredStateConfiguration

Aplica configuração a nós.

Syntax

Start-DscConfiguration
     [-Wait]
     [-Force]
     [[-Path] <String>]
     [[-ComputerName] <String[]>]
     [-Credential <PSCredential>]
     [-ThrottleLimit <Int32>]
     [-JobName <String>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-DscConfiguration
     [-Wait]
     [-Force]
     [[-Path] <String>]
     -CimSession <CimSession[]>
     [-ThrottleLimit <Int32>]
     [-JobName <String>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-DscConfiguration
     [-Wait]
     [-Force]
     [[-ComputerName] <String[]>]
     [-Credential <PSCredential>]
     [-ThrottleLimit <Int32>]
     [-UseExisting]
     [-JobName <String>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-DscConfiguration
     [-Wait]
     [-Force]
     -CimSession <CimSession[]>
     [-ThrottleLimit <Int32>]
     [-UseExisting]
     [-JobName <String>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

O Start-DscConfiguration cmdlet aplica a configuração a nós. Quando usado com o parâmetro UseExisting , a configuração existente no computador de destino é aplicada. Especifique a quais computadores você deseja aplicar a configuração especificando nomes de computador ou usando sessões do CIM (Common Information Model).

Por padrão, esse cmdlet cria um trabalho e retorna um objeto Job. Para obter mais informações sobre trabalhos em segundo plano, digite Get-Help about_Jobs. Para usar esse cmdlet interativamente, especifique o parâmetro Wait.

Especifique o parâmetro Verbose para ver os detalhes do que o cmdlet faz ao aplicar as definições de configuração.

Exemplos

Exemplo 1: Aplicar definições de configuração

Start-DscConfiguration -Path "C:\DSC\Configurations\"

Esse comando aplica as definições de configuração de C:\DSC\Configurations\ a cada computador que tem configurações nessa pasta. O comando retorna objetos Job para cada nó de destino implantado.

Exemplo 2: aplicar definições de configuração e aguardar a conclusão da configuração

Start-DscConfiguration -Path "C:\DSC\Configurations\" -Wait -Verbose

Esse comando aplica a configuração de C:\DSC\Configurations\ ao computador local. O comando retorna objetos Job para cada nó de destino implantado, nesse caso, apenas o computador local. Este exemplo especifica o parâmetro Verbose . Portanto, o comando envia mensagens para o console conforme ele prossegue. O comando inclui o parâmetro Wait . Portanto, você não pode usar o console até que o comando conclua todas as tarefas de configuração.

Exemplo 3: aplicar definições de configuração usando uma sessão CIM

$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Start-DscConfiguration -Path "C:\DSC\Configurations\" -CimSession $Session

Este exemplo aplica configurações a um computador especificado. O exemplo cria uma sessão CIM para um computador denominado 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 New-CimSession cmdlet e armazena o objeto CimSession na $Session variável . O comando solicita uma senha. Para obter mais informações, digite Get-Help NewCimSession.

O segundo comando aplica as definições de configuração de C:\DSC\Configurations aos computadores identificados pelos objetos CimSession armazenados na $Session variável . Neste exemplo, a $Session variável contém uma sessão CIM somente para o computador chamado Server01. O comando aplica a configuração. O comando cria objetos Job para cada computador configurado.

Parâmetros

-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 do computador local.

Type:CimSession[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ComputerName

Especifica uma matriz de nomes de computador. Esse parâmetro restringe os computadores que têm documentos de configuração no parâmetro Path aos especificados na matriz.

Type:String[]
Aliases:CN, ServerName
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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 Get-Credential cmdlet . Para obter mais informações, digite Get-Help Get-Credential.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Interrompe a operação de configuração atualmente em execução no computador de destino e inicia a nova operação de Start-Configuration. Se a propriedade RefreshMode da Configuration Manager Local estiver definida como Pull, especificar esse parâmetro a alterará para Push.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobName

Especifica um nome amigável para um trabalho. Se você especificar esse parâmetro, o cmdlet será executado como um trabalho e retorna um objeto Job.

Por padrão, Windows PowerShell atribui o nome JobN em que N é um inteiro.

Se você especificar o parâmetro Wait, não especifique esse parâmetro.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Especifica um caminho de arquivo de uma pasta que contém arquivos de definições de configuração. Esse cmdlet publica e aplica essas definições de configuração a computadores que têm arquivos de configurações no caminho especificado. Cada nó de destino deve ter um arquivo de configurações do seguinte formato: <NetBIOS Name>.mof.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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, Windows PowerShell calculará um limite de limitação ideal para o cmdlet com base no número de cmdlets CIM em execução no computador. O limite de aceleração aplica-se somente ao cmdlet atual, e não à sessão ou ao computador.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseExisting

Indica que esse cmdlet aplica a configuração existente. A configuração pode existir no computador de destino por meio da promulgação usando Start-DscConfiguration ou por publicação usando o cmdlet Publish-DscConfiguration.

Antes de especificar esse parâmetro para esse cmdlet, examine as informações em Novidades no Windows PowerShell 5.0.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Wait

Indica que o cmdlet bloqueia o console até concluir todas as tarefas de configuração.

Se você especificar esse parâmetro, não especifique o parâmetro JobName.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False