Compartir a través de

Remove-DscConfigurationDocument

  • Referencia
Módulo:
PSDesiredStateConfiguration

Quita un documento de configuración del almacén de configuración de DSC.

Sintaxis

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

Description

El cmdlet Remove-DscConfigurationDocument quita un documento de configuración (.mof archivo) del almacén de configuración de Desired State Configuration (DSC) de Windows PowerShell. Durante la configuración, el cmdlet Start-DscConfiguration copia un archivo .mof en una carpeta del equipo de destino. Este cmdlet quita ese documento de configuración y realiza una limpieza adicional.

Este cmdlet solo está disponible como parte del paquete acumulativo de actualizaciones de noviembre de 2014 de para Windows RT 8.1, Windows 8.1 y Windows Server 2012 R2.

Ejemplos

Ejemplo 1: Quitar el documento de configuración actual

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

El primer comando crea una sesión CIM mediante el cmdlet New-CimSession y, a continuación, almacena el objeto CimSession en la variable $Session. El comando le pide una contraseña. Para obtener más información, escriba Get-Help New-CimSession.

El segundo comando quita el documento de configuración actual del equipo especificado en el cimSession almacenado en $Session.

Parámetros

-AsJob

Indica que este cmdlet ejecuta el comando como un trabajo en segundo plano.

Si especifica el parámetro AsJob, el comando devuelve un objeto que representa el trabajo y, a continuación, muestra el símbolo del sistema. Puede continuar trabajando en la sesión hasta que finalice el trabajo. El trabajo se crea en el equipo local y los resultados de los equipos remotos se devuelven automáticamente al equipo local. Para administrar el trabajo, use los cmdlets job. Para obtener los resultados del trabajo, use el cmdlet Receive-Job.

Para usar este parámetro, los equipos locales y remotos deben configurarse para la comunicación remota y, en Windows Vista y versiones posteriores del sistema operativo Windows, debe abrir Windows PowerShell con la opción Ejecutar como administrador. Para obtener más información, vea about_Remote_Requirements.

Para obtener más información sobre los trabajos en segundo plano de Windows PowerShell, consulte about_Jobs y about_Remote_Jobs.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-CimSession

Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet de New-CimSession o Get-CimSession.

Tipo:CimSession[]
Alias:Session
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Alias:cf
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Force

Indica que este cmdlet detiene el trabajo de configuración en ejecución antes de quitar el documento de configuración. Obliga a que el comando se ejecute sin pedir confirmación del usuario.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Stage

Especifica el documento de configuración que se va a quitar. Puede especificar varios documentos. Los valores aceptables para este parámetro son:

  • Current: quite el documento de configuración que describe el estado actual del sistema.
  • Pending: quite el documento de configuración que describe el estado pendiente del sistema.
  • Previous: quite el documento de configuración que describe el estado anterior del sistema.
Tipo:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Valores aceptados:Current, Pending, Previous
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ThrottleLimit

Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o se especifica un valor de 0, Windows PowerShell calcula un límite óptimo para el cmdlet en función del número de cmdlets CIM que se ejecutan en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión o al equipo.

Tipo:Int32
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-WhatIf

Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

None

Salidas

None