Sdílet prostřednictvím

Remove-DscConfigurationDocument

  • Reference
Modul:
PSDesiredStateConfiguration

Odebere dokument konfigurace z úložiště konfigurace DSC.

Syntaxe

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

Description

Rutina Remove-DscConfigurationDocument odebere konfigurační dokument (soubor.mof) z úložiště konfigurace DSC (Windows PowerShell Desired State Configuration). Během konfigurace Start-DscConfiguration rutina zkopíruje soubor .mof do složky v cílovém počítači. Tato rutina odebere tento dokument konfigurace a provede další vyčištění.

Tato rutina je dostupná pouze v rámci kumulativní aktualizace listopad 2014 pro Windows RT 8.1, Windows 8.1 a Windows Server 2012 R2.

Příklady

Příklad 1: Odebrání aktuálního dokumentu konfigurace

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

První příkaz vytvoří relaci CIM pomocí rutiny New-CimSession a potom uloží objekt CimSession do proměnné $Session. Příkaz vás vyzve k zadání hesla. Další informace potřebujete zadáním Get-Help New-CimSession.

Druhý příkaz odebere aktuální konfigurační dokument pro počítač zadaný v CimSession uložené v $Session.

Parametry

-AsJob

Označuje, že tato rutina spouští příkaz jako úlohu na pozadí.

Pokud zadáte parametr AsJob, vrátí příkaz objekt, který představuje úlohu, a pak zobrazí příkazový řádek. V relaci můžete pokračovat v práci, dokud se úloha nedokončí. Úloha se vytvoří v místním počítači a výsledky ze vzdálených počítačů se automaticky vrátí do místního počítače. Ke správě úlohy použijte rutiny Úlohy. K získání výsledků úlohy použijte rutinu Receive-Job.

Chcete-li použít tento parametr, musí být místní a vzdálené počítače nakonfigurovány pro vzdálenou vzdálenou správu a v systému Windows Vista a novějších verzích operačního systému Windows, musíte otevřít Prostředí Windows PowerShell s možností Spustit jako správce. Další informace naleznete v tématu about_Remote_Requirements.

Další informace o úlohách prostředí Windows PowerShell na pozadí najdete v tématu about_Jobs a about_Remote_Jobs.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-CimSession

Spustí rutinu ve vzdálené relaci nebo ve vzdáleném počítači. Zadejte název počítače nebo objekt relace, například výstup New-CimSession nebo rutiny Get-CimSession.

Typ:CimSession[]
Aliasy:Session
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Confirm

Před spuštěním rutiny vás vyzve k potvrzení.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Force

Označuje, že tato rutina zastaví spuštěnou úlohu konfigurace před odebráním konfiguračního dokumentu. Vynutí spuštění příkazu bez výzvy k potvrzení uživatele.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Stage

Určuje, který konfigurační dokument se má odebrat. Můžete zadat více dokumentů. Přijatelné hodnoty pro tento parametr jsou:

  • Current – Odeberte konfigurační dokument, který popisuje aktuální stav systému.
  • Pending – Odeberte konfigurační dokument, který popisuje stav čekání na vyřízení systému.
  • Previous – Odeberte konfigurační dokument, který popisuje předchozí stav systému.
Typ:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Přípustné hodnoty:Current, Pending, Previous
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ThrottleLimit

Určuje maximální počet souběžných operací, které lze navázat pro spuštění rutiny. Pokud tento parametr vynecháte nebo zadáte hodnotu 0, windows PowerShell vypočítá optimální limit omezení pro rutinu na základě počtu rutin CIM spuštěných v počítači. Omezení se vztahuje pouze na aktuální rutinu, ne na relaci nebo na počítač.

Typ:Int32
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Výstupy

None