Partilhar via

Remove-DscConfigurationDocument

  • Referência
Módulo:
PSDesiredStateConfiguration

Remove um documento de configuração do arquivo de configuração do 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 (.mofficheiro) do arquivo de configuração Windows PowerShell Desired State Configuration (DSC). Durante a configuração, o Start-DscConfiguration cmdlet copia um .mof ficheiro para uma pasta no computador de destino. Este cmdlet remove esse documento de configuração e faz uma limpeza adicional.

Este cmdlet só está disponível como parte do rollup de atualização 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 com o New-CimSession cmdlet e, em seguida, armazena o objeto CimSession na variável $Session. O comando pede-lhe uma palavra-passe. Para mais informações, insira Get-Help New-CimSession.

O segundo comando remove o documento de configuração atual do computador especificado na CimSession armazenada no $Session.

Parâmetros

-AsJob

Indica que este cmdlet executa o comando como uma tarefa em segundo plano.

Se especificar o parâmetro AsJob , o comando devolve um objeto que representa a tarefa e, em seguida, apresenta a linha de comandos. Pode continuar a trabalhar na sessão até que a tarefa seja concluída. A tarefa é criada no computador local e os resultados de computadores remotos são devolvidos automaticamente ao computador local. Para gerir a tarefa, utilize os cmdlets da tarefa. Para obter os resultados da tarefa, utilize o Receive-Job cmdlet.

Para utilizar este parâmetro, os computadores locais e remotos têm de ser configurados para comunicação remota e, no Windows Vista e versões posteriores do sistema operativo Windows, tem de abrir Windows PowerShell com a opção Executar como administrador. Para obter mais informações, veja about_Remote_Requirements.

Para obter mais informações sobre Windows PowerShell trabalhos em segundo plano, veja 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 numa sessão remota ou num computador remoto. Introduza um nome de computador ou um objeto de sessão, como a saída de um New-CimSession ou Get-CimSession cmdlet.

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

-Confirm

Solicita a 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 este cmdlet interrompe a tarefa de configuração em execução antes de remover o documento de configuração. Força o comando a ser executado sem pedir a confirmação do utilizador.

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

-Stage

Especifica o documento de configuração a remover. Pode especificar vários documentos. Os valores aceitáveis para este 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 este parâmetro for omitido ou for introduzido um valor de0, Windows PowerShell calcula um limite de limitação ideal para o cmdlet com base no número de cmdlets CIM que estão em execução no computador. O limite de limitação aplica-se apenas ao cmdlet atual, 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

Apresenta o que aconteceria mediante a execução do cmdlet. 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