Remove-DscConfigurationDocument

  • Reference
Modul:
PSDesiredStateConfiguration

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

Syntax

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

Description

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

Tato rutina je dostupná jenom jako součást kumulativní aktualizace z listopadu 2014 pro Windows RT 8.1, Windows 8.1 a Windows Server 2012 R2.

Příklady

Příklad 1: Odebrání dokumentu aktuální 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 pak uloží objekt CimSession do $Session proměnné. Příkaz vás vyzve k zadání hesla. Další informace zobrazíte zadáním Get-Help New-CimSession.

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

Parametry

-AsJob

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

Pokud zadáte parametr AsJob , příkaz vrátí objekt, který představuje úlohu, a poté zobrazí příkazový řádek. V práci v relaci můžete pokračovat, 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 komunikace a v systému Windows Vista a novějších verzích operačního systému Windows je nutné otevřít Windows PowerShell pomocí možnosti Spustit jako správce. Další informace najdete v tématu about_Remote_Requirements.

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

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

-CimSession

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

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

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

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

-Force

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

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

-Stage

Určuje, který dokument konfigurace se má odebrat. Můžete zadat více dokumentů. Tento parametr přijímá tyto hodnoty:

  • Current – Odeberte konfigurační dokument, který popisuje aktuální stav systému.
  • Pending – Odeberte konfigurační dokument, který popisuje čekající stav systému.
  • Previous – Odeberte konfigurační dokument, který popisuje předchozí stav systému.
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

Určuje maximální počet souběžných operací, které je možné vytvořit pro spuštění rutiny. Pokud je tento parametr vynechán nebo je zadána hodnota 0 , vypočítá Windows PowerShell 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, nikoli na relaci nebo na počítač.

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

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

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

Vstupy

None

Výstupy

None