Remove-DscConfigurationDocument

  • Referencia
Módulo:
PSDesiredStateConfiguration

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

Syntax

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

Description

El Remove-DscConfigurationDocument cmdlet quita un documento de configuración (.mof archivo) del almacén de configuración de Windows PowerShell Desired State Configuration (DSC). Durante la configuración, el Start-DscConfiguration cmdlet copia un .mof archivo 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 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 New-CimSession cmdlet 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 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 seguir trabajando en la sesión hasta que finalice el trabajo. Se crea el trabajo en el equipo local y, automáticamente, se devuelven los resultados de los equipos remotos al equipo local. Para administrar el trabajo, use los cmdlets Job. Para obtener los resultados del trabajo, use el Receive-Job cmdlet .

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, consulte about_Remote_Requirements.

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

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

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

-Confirm

Le solicita su confirmación antes de ejecutar el 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 detiene el trabajo de configuración en ejecución antes de quitar el documento de configuración. Obliga al comando a ejecutarse sin solicitar la confirmación del usuario.

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

-Stage

Especifica qué documento de configuración quiere quitar. Puede especificar varios documentos. Los valores permitidos para este parámetro son los siguientes:

  • 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.
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 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 , Windows PowerShell calcula un límite óptimo para el cmdlet en función del número de 0 cmdlets CIM que se ejecutan en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.

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

-WhatIf

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

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

Entradas

None

Salidas

None