Remove-DscConfigurationDocument

  • Referentie
Module:
PSDesiredStateConfiguration

Hiermee verwijdert u een configuratiedocument uit het DSC-configuratiearchief.

Syntax

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

Description

De Remove-DscConfigurationDocument cmdlet verwijdert een configuratiedocument (.mofbestand) uit het configuratiearchief Windows PowerShell Desired State Configuration (DSC). 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 New-CimSession cmdlet en slaat u vervolgens het CimSession-object op in de variabele $Session. De opdracht vraagt u om een wachtwoord. Typ Get-Help New-CimSession voor meer informatie.

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

Parameters

-AsJob

Geeft aan dat deze cmdlet de opdracht als een achtergrondtaak uitvoert.

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 Receive-Job de cmdlet om de taakresultaten op te halen.

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

Zie about_Jobs en about_Remote_Jobs voor meer informatie over Windows PowerShell achtergrondtaken.

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

-CimSession

Voert de cmdlet uit 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[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-Force

Geeft aan dat deze cmdlet de actieve configuratietaak stopt voordat het configuratiedocument wordt verwijderd. Hiermee wordt de opdracht uitgevoerd zonder dat om bevestiging van de gebruiker wordt gevraagd.

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

-Stage

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

  • Current - Verwijder het configuratiedocument waarin de huidige status van het systeem wordt beschreven.
  • Pending - Verwijder het configuratiedocument waarin de status in behandeling van het systeem wordt beschreven.
  • Previous - Verwijder het configuratiedocument waarin de vorige status van het systeem wordt beschreven.
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

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 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

None

Uitvoerwaarden

None