Remove-DscConfigurationDocument

  • Referenz
Modul:
PSDesiredStateConfiguration

Entfernt ein Konfigurationsdokument aus dem DSC-Konfigurationsspeicher.

Syntax

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

Beschreibung

Das Remove-DscConfigurationDocument Cmdlet entfernt ein Konfigurationsdokument (.mof-Datei) aus dem Windows PowerShell Desired State Configuration(DSC)-Konfigurationsspeicher. Während der Konfiguration kopiert das Start-DscConfiguration Cmdlet eine .mof Datei in einen Ordner auf dem Zielcomputer. Dieses Cmdlet entfernt dieses Konfigurationsdokument und führt zusätzliche Bereinigungen durch.

Dieses Cmdlet ist nur im Rahmen des Updaterollups vom November 2014 für Windows RT 8.1, Windows 8.1 und Windows Server 2012 R2 verfügbar.

Beispiele

Beispiel 1: Entfernen des aktuellen Konfigurationsdokuments

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

Der erste Befehl erstellt mithilfe des New-CimSession Cmdlets eine CIM-Sitzung und speichert dann das CimSession-Objekt in der variablen $Session. Der Befehl fordert Sie zur Eingabe eines Kennworts auf. Geben Sie Folgendes ein, um weitere Informationen zu erhalten: Get-Help New-CimSession.

Der zweite Befehl entfernt das aktuelle Konfigurationsdokument für den Computer, der in der in $Session gespeicherten CimSession angegeben ist.

Parameter

-AsJob

Gibt an, dass dieses Cmdlet den Befehl als Hintergrundauftrag ausführt.

Wenn Sie den AsJob-Parameter angeben, gibt der Befehl ein Objekt zurück, das den Auftrag darstellt, und zeigt dann die Eingabeaufforderung an. Sie können in der Sitzung weiterarbeiten, bis der Auftrag abgeschlossen ist. Der Auftrag wird auf dem lokalen Computer erstellt, und die Ergebnisse von Remotecomputern werden automatisch an den lokalen Computer zurückgegeben. Um den Auftrag zu verwalten, verwenden Sie die Job-Cmdlets. Um die Auftragsergebnisse abzurufen, verwenden Sie das Cmdlet Receive-Job.

Um diesen Parameter verwenden zu können, müssen die lokalen Und Remotecomputer für Remoting konfiguriert sein. Unter Windows Vista und höheren Versionen des Windows-Betriebssystems müssen Sie Windows PowerShell mit der Option Als Administrator ausführen öffnen. Weitere Informationen finden Sie unter about_Remote_Requirements.

Weitere Informationen zu Windows PowerShell Hintergrundaufträgen finden Sie unter about_Jobs und about_Remote_Jobs.

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

-CimSession

Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines New-CimSession - oder Get-CimSession -Cmdlets.

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

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-Force

Gibt an, dass dieses Cmdlet den ausgeführten Konfigurationsauftrag beendet, bevor das Konfigurationsdokument entfernt wird. Erzwingt die Ausführung des Befehls ohne Aufforderung zur Bestätigung durch den Benutzer.

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

-Stage

Gibt an, welches Konfigurationsdokument entfernt werden soll. Sie können mehrere Dokumente angeben. Zulässige Werte für diesen Parameter:

  • Current – Entfernen Sie das Konfigurationsdokument, das den aktuellen Zustand des Systems beschreibt.
  • Pending – Entfernen Sie das Konfigurationsdokument, das den ausstehenden Zustand des Systems beschreibt.
  • Previous – Entfernen Sie das Konfigurationsdokument, das den vorherigen Zustand des Systems beschreibt.
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

Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen des Cmdlets erstellt werden können. Wenn dieser Parameter ausgelassen oder der Wert eingegeben 0 wird, berechnet Windows PowerShell basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden, eine optimale Drosselungsgrenze für das Cmdlet. Dieser Drosselungsgrenzwert gilt nur für das aktuelle Cmdlet, nicht für die Sitzung oder den PC.

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

None

Ausgaben

None