Freigeben über

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 Cmdlet Remove-DscConfigurationDocument entfernt ein Konfigurationsdokument (.mof Datei) aus dem Windows PowerShell Desired State Configuration (DSC)-Konfigurationsspeicher. Während der Konfiguration kopiert das cmdlet Start-DscConfiguration 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 November 2014-Updaterollups für Windows RT 8.1, Windows 8.1 und Windows Server 2012 R2verfü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 eine CIM-Sitzung mithilfe des cmdlets New-CimSession und speichert dann das CimSession-Objekt in der $Session Variablen. Der Befehl fordert Sie zur Eingabe eines Kennworts auf. Geben Sie Get-Help New-CimSessionein, um weitere Informationen zu erfahren.

Mit dem zweiten Befehl wird das aktuelle Konfigurationsdokument für den Computer entfernt, der in der CimSession in $Session gespeichert 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. Verwenden Sie zum Verwalten des Auftrags die Cmdlets "Auftrag". Verwenden Sie das Cmdlet Receive-Job, um die Auftragsergebnisse abzurufen.

Um diesen Parameter zu verwenden, müssen die lokalen und Remotecomputer für Remoting konfiguriert sein, und 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.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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.

Typ:CimSession[]
Aliase:Session
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Confirm

Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

Gibt an, dass dieses Cmdlet den ausgeführten Konfigurationsauftrag beendet, bevor das Konfigurationsdokument entfernt wird. Erzwingt die Ausführung des Befehls, ohne eine Benutzerbestätigung zu verlangen.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Stage

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

  • 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.
Typ:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Zulässige Werte:Current, Pending, Previous
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ThrottleLimit

Gibt die maximale Anzahl gleichzeitiger Vorgänge an, die zum Ausführen des Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen wird oder ein Wert von 0 eingegeben wird, berechnet Windows PowerShell ein optimales Drosselungslimit für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Der Drosselungsgrenzwert gilt nur für das aktuelle Cmdlet, nicht für die Sitzung oder für den Computer.

Typ:Int32
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WhatIf

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

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Ausgaben

None