Remove-DscConfigurationDocument

  • Referência
Módulo:
PSDesiredStateConfiguration

Remove um documento de configuração do repositório de configuração de DSC.

Syntax

Remove-DscConfigurationDocument
      -Stage <Stage>
      [-Force]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O Remove-DscConfigurationDocument cmdlet remove um documento de configuração (.mofarquivo) do repositório de configuração de Windows PowerShell Desired State Configuration (DSC). Durante a configuração, o Start-DscConfiguration cmdlet copia um .mof arquivo para uma pasta no computador de destino. Esse cmdlet remove esse documento de configuração e faz uma limpeza adicional.

Esse cmdlet está disponível apenas como parte do pacote cumulativo de atualizações de novembro de 2014 para Windows RT 8.1, Windows 8.1 e Windows Server 2012 R2.

Exemplos

Exemplo 1: remover o documento de configuração atual

$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Remove-DscConfigurationDocument -Stage Current -CimSession $Session

O primeiro comando cria uma sessão CIM usando o New-CimSession cmdlet 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 remove o documento de configuração atual para o computador especificado no CimSession armazenado em $Session.

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 Job. Para obter os resultados do trabalho, use o Receive-Job cmdlet .

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 Windows PowerShell com a opção Executar como administrador. Para obter mais informações, consulte about_Remote_Requirements.

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 New-CimSession cmdlet ou Get-CimSession .

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-Force

Indica que esse cmdlet interrompe o trabalho de configuração em execução antes de remover o documento de configuração. Força o comando a ser executado sem solicitar a confirmação do usuário.

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

-Stage

Especifica qual documento de configuração remover. Você pode especificar vários documentos. Os valores aceitáveis para esse parâmetro são:

  • Current – Remova o documento de configuração que descreve o estado atual do sistema.
  • Pending – Remova o documento de configuração que descreve o estado pendente do sistema.
  • Previous – Remova o documento de configuração que descreve o estado anterior do sistema.
Type:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Accepted values:Current, Pending, Previous
Position:Named
Default value:None
Required:True
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

-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

Entradas

None

Saídas

None