Delen via

Remove-DscConfigurationDocument

  • Referentie
Module:
PSDesiredStateConfiguration

Hiermee verwijdert u een configuratiedocument uit het DSC-configuratiearchief.

Syntaxis

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

Description

Met de cmdlet Remove-DscConfigurationDocument wordt een configuratiedocument (.mof bestand) verwijderd uit het dsc-configuratiearchief (Windows PowerShell Desired State Configuration). Tijdens de configuratie kopieert de Start-DscConfiguration cmdlet een .mof bestand naar een map op de doelcomputer. Deze cmdlet verwijdert dat configuratiedocument en voert extra opschoning uit.

Deze cmdlet is alleen beschikbaar als onderdeel van het updatepakket van november 2014 voor Windows RT 8.1, Windows 8.1 en Windows Server 2012 R2.

Voorbeelden

Voorbeeld 1: Het huidige configuratiedocument verwijderen

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

Met de eerste opdracht maakt u een CIM-sessie met behulp van de cmdlet New-CimSession en slaat u vervolgens het CimSession--object op in de variabele $Session. De opdracht vraagt u om een wachtwoord. Typ Get-Help New-CimSessionvoor meer informatie.

Met de tweede opdracht verwijdert u het huidige configuratiedocument voor de computer die is opgegeven in de CimSession opgeslagen in $Session.

Parameters

-AsJob

Geeft aan dat met deze cmdlet de opdracht wordt uitgevoerd als achtergrondtaak.

Als u de parameter AsJob opgeeft, retourneert de opdracht een object dat de taak vertegenwoordigt en wordt vervolgens de opdrachtprompt weergegeven. U kunt in de sessie blijven werken totdat de taak is voltooid. De taak wordt gemaakt op de lokale computer en de resultaten van externe computers worden automatisch geretourneerd naar de lokale computer. Gebruik de taak-cmdlets om de taak te beheren. Gebruik de cmdlet Receive-Job om de taakresultaten op te halen.

Als u deze parameter wilt gebruiken, moeten de lokale en externe computers worden geconfigureerd voor externe communicatie, en op Windows Vista en latere versies van het Windows-besturingssysteem moet u Windows PowerShell openen met de optie Als administrator uitvoeren. Zie about_Remote_Requirementsvoor meer informatie.

Zie about_Jobs en about_Remote_Jobsvoor meer informatie over Windows PowerShell-achtergrondtaken.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-CimSession

De cmdlet wordt uitgevoerd in een externe sessie of op een externe computer. Voer een computernaam of een sessieobject in, zoals de uitvoer van een New-CimSession of Get-CimSession cmdlet.

Type:CimSession[]
Aliassen:Session
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Confirm

U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Force

Geeft aan dat deze cmdlet de actieve configuratietaak stopt voordat het configuratiedocument wordt verwijderd. Hiermee dwingt u de opdracht uit te voeren zonder dat u om bevestiging van de gebruiker wordt gevraagd.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Stage

Hiermee geeft u op welk configuratiedocument moet worden verwijderd. U kunt meerdere documenten opgeven. De acceptabele waarden voor deze parameter zijn:

  • Current: verwijder het configuratiedocument dat de huidige status van het systeem beschrijft.
  • Pending: verwijder het configuratiedocument dat de status In behandeling van het systeem beschrijft.
  • Previous: verwijder het configuratiedocument dat de vorige status van het systeem beschrijft.
Type:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Geaccepteerde waarden:Current, Pending, Previous
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ThrottleLimit

Hiermee geeft u het maximum aantal gelijktijdige bewerkingen op dat kan worden ingesteld om de cmdlet uit te voeren. Als deze parameter wordt weggelaten of als er een waarde van 0 wordt ingevoerd, berekent Windows PowerShell een optimale beperkingslimiet voor de cmdlet op basis van het aantal CIM-cmdlets dat op de computer wordt uitgevoerd. De beperkingslimiet is alleen van toepassing op de huidige cmdlet, niet op de sessie of op de computer.

Type:Int32
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-WhatIf

Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

None

Uitvoerwaarden

None