Remove-DscConfigurationDocument

  • Odwołanie
Moduł:
PSDesiredStateConfiguration

Usuwa dokument konfiguracji z magazynu konfiguracji DSC.

Składnia

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

Opis

Polecenie Remove-DscConfigurationDocument cmdlet usuwa dokument konfiguracji (.mofplik) z magazynu konfiguracji Windows PowerShell Desired State Configuration (DSC). Podczas konfiguracji Start-DscConfiguration polecenie cmdlet kopiuje .mof plik do folderu na komputerze docelowym. To polecenie cmdlet usuwa ten dokument konfiguracji i wykonuje dodatkowe oczyszczanie.

To polecenie cmdlet jest dostępne tylko w ramach pakietu zbiorczego aktualizacji z listopada 2014 r. dla Windows RT 8.1, Windows 8.1 i Windows Server 2012 R2.

Przykłady

Przykład 1. Usuwanie bieżącego dokumentu konfiguracji

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

Pierwsze polecenie tworzy sesję CIM przy użyciu New-CimSession polecenia cmdlet , a następnie przechowuje obiekt CimSession w zmiennej $Session. Polecenie wyświetla monit o podanie hasła. Aby uzyskać więcej informacji, wpisz polecenie Get-Help New-CimSession.

Drugie polecenie usuwa bieżący dokument konfiguracji dla komputera określonego w cimSession przechowywanym w $Session.

Parametry

-AsJob

Wskazuje, że to polecenie cmdlet uruchamia polecenie jako zadanie w tle.

Jeśli określisz parametr AsJob , polecenie zwróci obiekt reprezentujący zadanie, a następnie wyświetli wiersz polecenia. Możesz kontynuować pracę w sesji do momentu zakończenia zadania. Zadanie jest tworzone na komputerze lokalnym, a wyniki z komputerów zdalnych są automatycznie zwracane do komputera lokalnego. Aby zarządzać zadaniem, użyj poleceń cmdlet zadania. Aby uzyskać wyniki zadania, użyj Receive-Job polecenia cmdlet .

Aby użyć tego parametru, lokalne i zdalne komputery muszą być skonfigurowane do komunikacji zdalnej, a w systemie Windows Vista i nowszych wersjach systemu operacyjnego Windows, należy otworzyć Windows PowerShell z opcją Uruchom jako administrator. Aby uzyskać więcej informacji, zobacz about_Remote_Requirements.

Aby uzyskać więcej informacji na temat zadań Windows PowerShell w tle, zobacz about_Jobs i about_Remote_Jobs.

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

-CimSession

Uruchamia polecenie cmdlet w sesji zdalnej lub na komputerze zdalnym. Wprowadź nazwę komputera lub obiekt sesji, taki jak dane wyjściowe New-CimSession polecenia cmdlet lub Get-CimSession .

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

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

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

-Force

Wskazuje, że to polecenie cmdlet zatrzymuje uruchomione zadanie konfiguracji przed usunięciem dokumentu konfiguracji. Wymusza uruchomienie polecenia bez monitowania o potwierdzenie użytkownika.

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

-Stage

Określa, który dokument konfiguracji ma zostać usunięty. Można określić wiele dokumentów. Dopuszczalne wartości dla tego parametru to:

  • Current — Usuń dokument konfiguracji, który opisuje bieżący stan systemu.
  • Pending — Usuń dokument konfiguracji, który opisuje stan oczekiwania systemu.
  • Previous — Usuń dokument konfiguracji, który opisuje poprzedni stan systemu.
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

Określa maksymalną liczbę współbieżnych operacji, które można ustanowić w celu uruchomienia polecenia cmdlet. Jeśli ten parametr zostanie pominięty lub zostanie wprowadzona wartość0, Windows PowerShell oblicza optymalny limit ograniczania dla polecenia cmdlet na podstawie liczby poleceń cmdlet ciM uruchomionych na komputerze. Limit ograniczania dotyczy tylko bieżącego polecenia cmdlet, a nie sesji lub komputera.

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

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

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

Dane wejściowe

None

Dane wyjściowe

None