Remove-DscConfigurationDocument

  • Referens
Modul:
PSDesiredStateConfiguration

Tar bort ett konfigurationsdokument från DSC-konfigurationsarkivet.

Syntax

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

Description

Cmdleten Remove-DscConfigurationDocument tar bort ett konfigurationsdokument (.moffil) från konfigurationsarkivet för Windows PowerShell Desired State Configuration (DSC). Under konfigurationen kopierar cmdleten Start-DscConfiguration en .mof fil till en mapp på måldatorn. Den här cmdleten tar bort konfigurationsdokumentet och gör ytterligare rensning.

Den här cmdleten är endast tillgänglig som en del av den samlade uppdateringen från november 2014 för Windows RT 8.1, Windows 8.1 och Windows Server 2012 R2.

Exempel

Exempel 1: Ta bort det aktuella konfigurationsdokumentet

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

Det första kommandot skapar en CIM-session med hjälp av cmdleten New-CimSession och lagrar sedan CimSession-objektet i variabeln $Session. Kommandot uppmanar dig att ange ett lösenord. För mer information ange Get-Help New-CimSession.

Det andra kommandot tar bort det aktuella konfigurationsdokumentet för den dator som anges i CimSession som lagras i $Session.

Parametrar

-AsJob

Anger att denna cmdlet kör kommandot som ett bakgrundsjobb.

Om du anger parametern AsJob returnerar kommandot ett objekt som representerar jobbet och visar sedan kommandotolken. Du kan fortsätta att arbeta i sessionen tills jobbet har slutförts. Jobbet skapas på den lokala datorn och resultatet från fjärrdatorerna returneras automatiskt till den lokala datorn. Om du vill hantera jobbet använder du jobb-cmdletar. Använd cmdleten för att hämta jobbresultatet Receive-Job .

Om du vill använda den här parametern måste lokala datorer och fjärrdatorer konfigureras för fjärrkommunikation, och i Windows Vista och senare versioner av Windows-operativsystemet måste du öppna Windows PowerShell med alternativet Kör som administratör. Mer information finns i about_Remote_Requirements.

Mer information om Windows PowerShell bakgrundsjobb finns i about_Jobs och about_Remote_Jobs.

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

-CimSession

Kör cmdleten i en fjärrsession eller på en fjärrdator. Ange ett datornamn eller ett sessionsobjekt, till exempel utdata från en New-CimSession eller Get-CimSession cmdlet.

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

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

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

-Force

Anger att den här cmdleten stoppar konfigurationsjobbet som körs innan konfigurationsdokumentet tas bort. Tvingar kommandot att köras utan att be om användarbekräftelse.

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

-Stage

Anger vilket konfigurationsdokument som ska tas bort. Du kan ange flera dokument. De acceptabla värdena för den här parametern är:

  • Current – Ta bort konfigurationsdokumentet som beskriver systemets aktuella tillstånd.
  • Pending – Ta bort konfigurationsdokumentet som beskriver systemets väntande tillstånd.
  • Previous – Ta bort konfigurationsdokumentet som beskriver systemets tidigare tillstånd.
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

Anger det maximala antalet samtidiga åtgärder som kan upprättas för att köra cmdleten. Om den här parametern utelämnas eller ett värde för 0 anges beräknar Windows PowerShell en optimal begränsningsgräns för cmdleten baserat på antalet CIM-cmdletar som körs på datorn. Begränsningsgränsen gäller endast för den aktuella cmdleten, inte för sessionen eller datorn.

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

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

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

Indata

None

Utdata

None