Remove-DscConfigurationDocument
Remove um documento de configuração do repositório de configuração DSC.
Sintaxe
Default (Predefinição)
Remove-DscConfigurationDocument
-Stage <Stage>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Remove-DscConfigurationDocument remove um documento de configuração (arquivo.mof) do repositório de configuração DSC (Configuração de Estado Desejado) do Windows PowerShell. Durante a configuração, o cmdlet Start-DscConfiguration copia um arquivo .mof para uma pasta no computador de destino. Este cmdlet remove esse documento de configuração e faz limpeza adicional.
Este cmdlet está disponível apenas como parte do pacote cumulativo de atualizações de novembro de 2014 do 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 cmdlet New-CimSession e, em seguida, 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 do computador especificado no CimSession armazenado no $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 termine.
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 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 em 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.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
Propriedades dos parâmetros
| Tipo: | |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Sessão |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Cf. |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 pedir a confirmação do usuário.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Stage
Especifica qual documento de configuração remover. Você 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.
Propriedades dos parâmetros
| Tipo: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage |
| Default value: | None |
| Valores aceites: | Current, Pending, Previous |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 de aceleraçã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 apenas ao cmdlet atual, não à sessão ou ao computador.
Propriedades dos parâmetros
| Tipo: | Int32 |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Wi |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
