Udostępnij za pośrednictwem

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 cmdlet Remove-DscConfigurationDocument usuwa dokument konfiguracji (plik.mof) z magazynu konfiguracji Konfiguracji żądanego stanu (DSC) programu Windows PowerShell. Podczas konfiguracji polecenie cmdlet Start-DscConfiguration kopiuje plik .mof 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 systemu 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ę modelu CIM przy użyciu polecenia cmdlet New-CimSession, a następnie przechowuje obiekt CimSession w zmiennej $Session. Polecenie wyświetla monit o podanie hasła. Aby uzyskać więcej informacji, wpisz Get-Help New-CimSession.

Drugie polecenie usuwa bieżący dokument konfiguracji dla komputera określonego w CimSession przechowywany 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 polecenia cmdlet Receive-Job.

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

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

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-CimSession

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

Typ:CimSession[]
Aliasy:Session
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Stage

Określa dokument konfiguracji do usunięcia. Można określić wiele dokumentów. Dopuszczalne wartości 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.
Typ:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Dopuszczalne wartości:Current, Pending, Previous
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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, program 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.

Typ:Int32
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie jest uruchamiane.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

None

Dane wyjściowe

None