Remove-DscConfigurationDocument
Odebere dokument konfigurace z úložiště konfigurace DSC.
Syntaxe
Default (Výchozí)
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. Pro více informací zadejte 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.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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.
Vlastnosti parametru
| Typ: | |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | Sezení |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Confirm
Před spuštěním cmdletu vás vyzve k potvrzení.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | viz |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Force
Označuje, že tato rutina zastaví spuštěnou úlohu konfigurace před odebráním konfiguračního dokumentu. Přinutí příkaz ke spuštění bez výzvy k potvrzení uživatele.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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.
Vlastnosti parametru
| Typ: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage |
| Default value: | None |
| Přípustné hodnoty: | Current, Pending, Previous |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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č.
Vlastnosti parametru
| Typ: | Int32 |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-WhatIf
Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | Wi |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.