Receive-PSSession

Receive-PSSession
    [-Session] <PSSession>
    [-OutTarget <OutTarget>]
    [-JobName <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Receive-PSSession
    [-Id] <Int32>
    [-OutTarget <OutTarget>]
    [-JobName <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Receive-PSSession
    [-ComputerName] <String>
    -Name <String>
    [-ApplicationName <String>]
    [-ConfigurationName <String>]
    [-OutTarget <OutTarget>]
    [-JobName <String>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-Port <Int32>]
    [-UseSSL]
    [-SessionOption <PSSessionOption>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Receive-PSSession
    [-ComputerName] <String>
    -InstanceId <Guid>
    [-ApplicationName <String>]
    [-ConfigurationName <String>]
    [-OutTarget <OutTarget>]
    [-JobName <String>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-Port <Int32>]
    [-UseSSL]
    [-SessionOption <PSSessionOption>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Receive-PSSession
    [-ConnectionUri] <Uri>
    -Name <String>
    [-ConfigurationName <String>]
    [-AllowRedirection]
    [-OutTarget <OutTarget>]
    [-JobName <String>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-SessionOption <PSSessionOption>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Receive-PSSession
    [-ConnectionUri] <Uri>
    -InstanceId <Guid>
    [-ConfigurationName <String>]
    [-AllowRedirection]
    [-OutTarget <OutTarget>]
    [-JobName <String>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-SessionOption <PSSessionOption>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Receive-PSSession
    -InstanceId <Guid>
    [-OutTarget <OutTarget>]
    [-JobName <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Receive-PSSession
    -Name <String>
    [-OutTarget <OutTarget>]
    [-JobName <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Ten cmdlet jest dostępny tylko na platformie Windows.

Polecenie cmdlet Receive-PSSession pobiera wyniki poleceń uruchomionych w sesjach PowerShell (PSSession), które zostały rozłączone. Jeśli sesja jest obecnie połączona, Receive-PSSession pobiera wyniki poleceń, które były uruchomione po rozłączeniu sesji. Jeśli sesja jest nadal rozłączona, Receive-PSSession nawiązuje połączenie z sesją, wznawia wszystkie wstrzymane polecenia i pobiera wyniki poleceń uruchomionych w sesji.

Ten cmdlet został wprowadzony w programie PowerShell 3.0.

Można użyć Receive-PSSession oprócz polecenia Connect-PSSession lub zamiast niego. Receive-PSSession może nawiązać połączenie z dowolną rozłączną lub ponownie połączoną sesją, która została uruchomiona w innych sesjach lub na innych komputerach.

Receive-PSSession działa na psSessions, które zostały rozłączone celowo przy użyciu polecenia cmdlet Disconnect-PSSession lub Invoke-CommandInDisconnectedSession parametru. Lub rozłączone przypadkowo przez przerwę w sieci.

Jeśli używasz polecenia cmdlet Receive-PSSession do nawiązania połączenia z sesją, w której żadne polecenia nie są uruchomione lub wstrzymane, Receive-PSSession nawiązuje połączenie z sesją, ale nie zwraca żadnych danych wyjściowych ani błędów.

Aby uzyskać więcej informacji na temat funkcji rozłączonych sesji, zobacz about_Remote_Disconnected_Sessions.

Niektóre przykłady używają techniki splatting, aby zmniejszyć długość wiersza i poprawić czytelność. Aby uzyskać więcej informacji, zobacz about_Splatting.

Ten przykład nawiązuje połączenie z sesją na komputerze zdalnym i pobiera wyniki poleceń uruchomionych w sesji.

Receive-PSSession -ComputerName Server01 -Name ITTask

Receive-PSSession określa komputer zdalny z parametrem ComputerName. Parametr Nazwa identyfikuje sesję ITTask na komputerze Server01. Przykład pobiera wyniki poleceń uruchomionych w sesji ITTask.

Ponieważ polecenie nie używa parametru OutTarget, wyniki są wyświetlane w wierszu polecenia.

Ten przykład pobiera wyniki wszystkich poleceń uruchomionych we wszystkich rozłączonych sesjach na dwóch komputerach zdalnych.

Jeśli jakakolwiek sesja nie została rozłączona lub nie wykonuje poleceń, Receive-PSSession nie łączy się z sesją i nie zwraca żadnych wyników ani błędów.

Get-PSSession -ComputerName Server01, Server02 | Receive-PSSession

Get-PSSession używa parametru ComputerName w celu określenia komputerów zdalnych. Obiekty są wysyłane w dół rurki do Receive-PSSession.

W tym przykładzie użyto polecenia cmdlet Receive-PSSession, aby uzyskać wyniki skryptu uruchomionego w sesji komputera zdalnego.

$parms = @{
  ComputerName = "Server01"
  Name = "ITTask"
  OutTarget = "Job"
  JobName = "ITTaskJob01"
  Credential = "Domain01\Admin01"
}
Receive-PSSession @parms

Id     Name            State         HasMoreData     Location
--     ----            -----         -----------     --------
16     ITTaskJob01     Running       True            Server01

Polecenie używa parametrów ComputerName i Name w celu zidentyfikowania rozłączonej sesji. Używa parametru OutTarget z wartością Job, aby skierować Receive-PSSession do zwrócenia wyników jako zadanie. Parametr JobName określa nazwę zadania w ponownie połączonej sesji. Parametr Credential uruchamia polecenie Receive-PSSession przy użyciu uprawnień administratora domeny.

Dane wyjściowe pokazują, że Receive-PSSession zwrócił wyniki jako zadanie w bieżącej sesji. Aby uzyskać wyniki zadania, użyj polecenia Receive-Job

W tym przykładzie użyto polecenia cmdlet Receive-PSSession, aby uzyskać wyniki zadania po zakłóceniu sesji wskutek przerwy w sieci. Program PowerShell automatycznie próbuje ponownie połączyć sesję raz na sekundę przez następne cztery minuty i porzuci nakład pracy tylko wtedy, gdy wszystkie próby w interwale czterech minut nie powiedzie się.

PS> $s = New-PSSession -ComputerName Server01 -Name AD -ConfigurationName ADEndpoint
PS> $s

Id  Name   ComputerName    State        ConfigurationName     Availability
--  ----   ------------    -----        -----------------     ------------
8   AD      Server01       Opened       ADEndpoint               Available


PS> Invoke-Command -Session $s -FilePath \\Server12\Scripts\SharedScripts\New-ADResolve.ps1

Running "New-ADResolve.ps1"

# Network outage
# Restart local computer
# Network access is not re-established within 4 minutes


PS> Get-PSSession -ComputerName Server01

Id  Name   ComputerName    State          ConfigurationName      Availability
--  ----   ------------    -----          -----------------      ------------
1  Backup  Server01        Disconnected   Microsoft.PowerShell           None
8  AD      Server01        Disconnected   ADEndpoint                     None


PS> Receive-PSSession -ComputerName Server01 -Name AD -OutTarget Job -JobName AD

Job Id   Name      State         HasMoreData     Location
--       ----      -----         -----------     --------
16       ADJob     Running       True            Server01


PS> Get-PSSession -ComputerName Server01

Id  Name    ComputerName    State         ConfigurationName     Availability
--  ----    ------------    -----         -----------------     ------------
1  Backup   Server01        Disconnected  Microsoft.PowerShell          Busy
8  AD       Server01        Opened        ADEndpoint               Available

Polecenie cmdlet New-PSSession tworzy sesję na komputerze Server01 i zapisuje sesję w zmiennej $s. Zmienna $s wyświetla, że stan jest otwarty, a dostępność jest dostępna. Te wartości wskazują, że masz połączenie z sesją i możesz uruchamiać polecenia w sesji.

Polecenie cmdlet Invoke-Command uruchamia skrypt w sesji zmiennej $s. Skrypt rozpoczyna uruchamianie i zwracanie danych, ale występuje awaria sieci, która przerywa sesję. Użytkownik musi zakończyć sesję i ponownie uruchomić komputer lokalny.

Po ponownym uruchomieniu komputera użytkownik uruchamia program PowerShell i uruchamia polecenie Get-PSSession, aby pobrać sesje na komputerze Server01. Dane wyjściowe pokazują, że sesja ad nadal istnieje na komputerze Server01. stan wskazuje, że sesja AD jest rozłączona. Wartość Availability None wskazuje, że sesja nie jest połączona z żadną sesją klienta.

Polecenie cmdlet Receive-PSSession ponownie nawiązuje połączenie z sesją AD i pobiera wyniki skryptu, który został uruchomiony w tej sesji. Polecenie używa parametru OutTarget, aby zażądać wyników zadania o nazwie ADJob. Polecenie zwraca obiekt zadania, a dane wyjściowe wskazują, że skrypt jest nadal uruchomiony.

Polecenie cmdlet Get-PSSession służy do sprawdzania stanu zadania. Dane wyjściowe potwierdzają, że polecenie cmdlet Receive-PSSession ponownie nawiązało połączenie z sesją usługi AD, która jest teraz otwarta i dostępna dla poleceń. Skrypt wznowił wykonywanie i otrzymuje wyniki skryptu.

W tym przykładzie użyto polecenia cmdlet Receive-PSSession, aby ponownie nawiązać połączenie z sesjami, które zostały celowo rozłączone i uzyskać wyniki zadań uruchomionych w sesjach.

PS> $parms = @{
      InDisconnectedSession = $true
      ComputerName = "Server01", "Server02", "Server30"
      FilePath = "\\Server12\Scripts\SharedScripts\Get-BugStatus.ps1"
      Name = "BugStatus"
      SessionOption = @{IdleTimeout = 86400000}
      ConfigurationName = "ITTasks"
    }
PS> Invoke-Command @parms
PS> exit


PS> $s = Get-PSSession -ComputerName Server01, Server02, Server30 -Name BugStatus
PS> $s

Id  Name   ComputerName    State         ConfigurationName     Availability
--  ----   ------------    -----         -----------------     ------------
1  ITTask  Server01        Disconnected  ITTasks                       None
8  ITTask  Server02        Disconnected  ITTasks                       None
2  ITTask  Server30        Disconnected  ITTasks                       None


PS> $Results = Receive-PSSession -Session $s
PS> $s

Id  Name   ComputerName    State         ConfigurationName     Availability
--  ----   ------------    -----         -----------------     ------------
1  ITTask  Server01        Opened        ITTasks                  Available
8  ITTask  Server02        Opened        ITTasks                  Available
2  ITTask  Server30        Opened        ITTasks                  Available


PS> $Results

Bug Report - Domain 01
----------------------
ComputerName          BugCount          LastUpdated
--------------        ---------         ------------
Server01              121               Friday, December 30, 2011 5:03:34 PM

Polecenie cmdlet Invoke-Command uruchamia skrypt na trzech komputerach zdalnych. Ponieważ skrypt zbiera i podsumowyuje dane z wielu baz danych, wykonanie skryptu często trwa dłuższy czas. Polecenie używa parametru InDisconnectedSession, który uruchamia skrypty, a następnie natychmiast rozłącza sesje. Parametr SessionOption rozszerza wartość IdleTimeout rozłączonej sesji. Odłączone sesje są uznawane za bezczynne od momentu ich rozłączenia. Ważne jest, aby ustawić limit czasu bezczynności na tyle długo, aby polecenia mogły być ukończone i można ponownie nawiązać połączenie z sesją. Można ustawić IdleTimeout tylko wtedy, gdy utworzysz PSSession i zmienić go tylko wtedy, gdy się od niego odłączysz. Nie można zmienić wartości IdleTimeout, gdy połączysz się z PSSession lub podczas odbierania jego wyników. Po uruchomieniu polecenia użytkownik zamyka program PowerShell i zamyka komputer.

Następnego dnia użytkownik wznawia działanie systemu Windows, uruchamia program PowerShell i używa Get-PSSession, aby pobrać sesje, w których uruchomiono skrypty. Polecenie identyfikuje sesje według nazwy komputera, nazwy sesji i nazwy konfiguracji sesji i zapisuje sesje w zmiennej $s. Wartość zmiennej $s jest wyświetlana i pokazuje, że sesje są rozłączone, ale nie są zajęte.

Polecenie cmdlet Receive-PSSession łączy się z sesjami zapisanymi w zmiennej $s i pobiera ich wyniki. Polecenie zapisuje wyniki w zmiennej $Results. Zostanie wyświetlona zmienna $s, która pokazuje, że sesje są połączone i dostępne dla poleceń.

Wyniki skryptu w zmiennej $Results zostają wyświetlone w konsoli programu PowerShell. Jeśli którykolwiek z wyników jest nieoczekiwany, użytkownik może uruchamiać polecenia w sesjach, aby zbadać główną przyczynę.

W tym przykładzie pokazano, co się stanie z zadaniem uruchomionym w rozłączonej sesji.

PS> $s = New-PSSession -ComputerName Server01 -Name Test
PS> $j = Invoke-Command -Session $s { 1..1500 | ForEach-Object {"Return $_"; sleep 30}} -AsJob
PS> $j

Id     Name           State         HasMoreData     Location
--     ----           -----         -----------     --------
16     Job1           Running       True            Server01


PS> $s | Disconnect-PSSession

Id Name   ComputerName    State         ConfigurationName     Availability
-- ----   ------------    -----         -----------------     ------------
1  Test   Server01        Disconnected  Microsoft.PowerShell          None


PS> $j

Id     Name           State         HasMoreData     Location
--     ----           -----         -----------     --------
16     Job1           Disconnected  True            Server01


PS> Receive-Job $j -Keep

Return 1
Return 2


PS> $s2 = Connect-PSSession -ComputerName Server01 -Name Test
PS> $j2 = Receive-PSSession -ComputerName Server01 -Name Test
PS> Receive-Job $j

Return 3
Return 4

Polecenie cmdlet New-PSSession tworzy sesję testowa na komputerze Server01. Polecenie zapisuje sesję w zmiennej $s.

Polecenie cmdlet Invoke-Command uruchamia polecenie w sesji w zmiennej $s. Polecenie używa parametru AsJob do uruchomienia polecenia jako zadania i tworzy obiekt zadania w bieżącej sesji. Polecenie zwraca obiekt zadania zapisany w zmiennej $j. Zmienna $j wyświetla obiekt zadania.

Obiekt sesji w zmiennej $s jest przesyłany przez potok do Disconnect-PSSession, po czym sesja jest rozłączana.

Wyświetlana jest zmienna $j i pokazuje efekt rozłączenia obiektu zadania w zmiennej $j. Stan zadania jest teraz rozłączony.

Receive-Job jest uruchamiany w ramach zadania związanego z zmienną $j. Dane wyjściowe pokazują, że zadanie zaczęło zwracać dane wyjściowe zanim sesja i zadanie zostały rozłączone.

Polecenie cmdlet Connect-PSSession jest uruchamiane w tej samej sesji klienta. Polecenie ponownie łączy się z sesją testową na komputerze Server01 i zapisuje sesję w zmiennej $s2.

Polecenie cmdlet Receive-PSSession pobiera wyniki zadania, które było uruchomione w sesji. Ponieważ polecenie jest uruchamiane w tej samej sesji, Receive-PSSession zwraca wyniki jako zadanie domyślnie i ponownie używa tego samego obiektu zadania. Polecenie zapisuje zadanie w zmiennej $j2. Polecenie cmdlet Receive-Job uzyskuje wyniki zadania i zapisuje je w zmiennej $j.

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Do tego polecenia cmdlet można przekazywać obiekty sesji, takie jak obiekty zwracane przez polecenie cmdlet Get-PSSession.

Identyfikatory sesji można przekazywać do tego polecenia cmdlet.

Można przekazać identyfikatory wystąpień sesji do potoku za pomocą tego polecenia cmdlet.

Nazwy sesji można przekazywać do tego polecenia cmdlet.

Jeśli wartość lub wartość domyślna parametru OutTarget jest Job, Receive-PSSession zwraca obiekt zadania.

Ten cmdlet zwraca wyniki poleceń uruchomionych w rozłączonej sesji, jeśli takie są.

Program PowerShell zawiera następujące aliasy dla Receive-PSSession:

• Wszystkie platformy:
  • rcsn

Ten cmdlet jest dostępny tylko na platformach Windows.

Receive-PSSession pobiera wyniki tylko z sesji, które zostały rozłączone. Tylko sesje połączone lub zakończone na komputerach z programem PowerShell 3.0 lub nowszym można odłączyć i ponownie nawiązać połączenie.

Jeśli polecenia uruchomione w rozłączonej sesji nie wygenerowały wyników lub jeśli wyniki zostały już zwrócone do innej sesji, Receive-PSSession nie generuje żadnych danych wyjściowych.

Tryb buforowania danych wyjściowych sesji określa, jak polecenia w sesji zarządzają danymi wyjściowymi po rozłączeniu sesji. Gdy wartość OutputBufferingMode opcji sesji to Drop, a bufor wyjściowy jest pełny, polecenie rozpoczyna usuwanie danych wyjściowych. Receive-PSSession nie może odzyskać tego wyniku. Aby uzyskać więcej informacji na temat opcji trybu buforowania danych wyjściowych, zobacz artykuły pomocy dotyczące poleceń cmdlet New-PSSessionOption i New-PSTransportOption.

Nie można zmienić wartości limitu czasu bezczynności PSSession podczas nawiązywania połączenia z PSSession lub odbierania wyników. Parametr SessionOptionReceive-PSSession przyjmuje obiekt SessionOption, który ma wartość IdleTimeout. Jednak wartość IdleTimeout obiektu SessionOption oraz wartość IdleTimeout zmiennej $PSSessionOption są ignorowane podczas nawiązywania połączenia z PSSession lub odbierania wyników.

• Możesz ustawić i zmienić limit czasu bezczynności PSSession podczas tworzenia PSSession, przy użyciu poleceń cmdlet New-PSSession lub Invoke-Command, oraz podczas rozłączania się z PSSession.
• Właściwość IdleTimeout pssession ma kluczowe znaczenie dla rozłączonych sesji, ponieważ określa, jak długo sesja rozłączona jest utrzymywana na komputerze zdalnym. Odłączone sesje są uważane za bezczynne od momentu ich rozłączenia, nawet jeśli polecenia są uruchomione w sesji rozłączonej.

Jeśli uruchomisz zadanie w sesji zdalnej przy użyciu parametru AsJob polecenia cmdlet Invoke-Command, obiekt zadania zostanie utworzony w bieżącej sesji, chociaż zadanie jest uruchamiane w sesji zdalnej. Jeśli rozłączysz sesję zdalną, obiekt zadania w bieżącej sesji zostanie odłączony od zadania. Obiekt zadania zawiera wszelkie wyniki, które zostały do niego zwrócone, ale nie otrzymuje nowych wyników z zadania w sesji rozłączonej.

Jeśli inny klient łączy się z sesją zawierającą uruchomione zadanie, wyniki dostarczone do oryginalnego obiektu zadania w oryginalnej sesji nie są dostępne w nowo połączonej sesji. Tylko wyniki, które nie zostały dostarczone do oryginalnego obiektu zadania, są dostępne w ponownie połączonej sesji.

Podobnie, jeśli uruchomisz skrypt w sesji, a następnie odłączysz się od sesji, wszystkie wyniki, które skrypt dostarcza do sesji przed odłączeniem, nie są dostępne dla innego klienta, który nawiązuje połączenie z sesją.

Aby zapobiec utracie danych w sesjach, które mają być rozłączone, użyj parametru InDisconnectedSession polecenia cmdlet Invoke-Command. Ponieważ ten parametr uniemożliwia zwracanie wyników do bieżącej sesji, wszystkie wyniki są dostępne po ponownym połączeniu sesji.

Możesz również zapobiec utracie danych, używając polecenia cmdlet Invoke-Command do uruchomienia polecenia Start-Job w sesji zdalnej. W takim przypadku obiekt zadania jest tworzony w sesji zdalnej. Nie można użyć polecenia cmdlet Receive-PSSession, aby uzyskać wyniki zadania. Zamiast tego użyj polecenia cmdlet Connect-PSSession, aby połączyć się z sesją, a następnie użyć polecenia cmdlet Invoke-Command, aby uruchomić polecenie Receive-Job w sesji.

Gdy sesja zawierająca uruchomione zadanie zostanie rozłączona, a następnie ponownie nawiązana połączenie, oryginalny obiekt zadania zostanie ponownie użyty tylko wtedy, gdy zadanie zostanie rozłączone i ponownie nawiązane połączenie z tą samą sesją, a polecenie do ponownego nawiązania połączenia nie określa nowej nazwy zadania. Jeśli sesja zostanie ponownie połączona z inną sesją klienta lub zostanie określona nowa nazwa zadania, program PowerShell utworzy nowy obiekt zadania dla nowej sesji.

Po rozłączeniu PSSession stan sesji jest rozłączony, a dostępność jest ustawiona na Brak.

• Wartość właściwości State jest relatywna względem aktualnej sesji. Wartość Rozłączone oznacza, że PSSession nie jest połączona z bieżącą sesją. Nie oznacza to jednak, że PSSession jest odłączony od wszystkich sesji. Może być połączony z inną sesją. Aby określić, czy można nawiązać połączenie z sesją, czy ponownie nawiązać połączenie, użyj właściwości Availability.
• Wartość Dostępności Brak wskazuje, że można nawiązać połączenie z sesją. Wartość Zajęta wskazuje, że nie można nawiązać połączenia z PSSession, ponieważ jest połączona z inną sesją.
• Aby uzyskać więcej informacji na temat wartości właściwości sesji State, zobacz RunspaceState.
• Aby uzyskać więcej informacji na temat wartości właściwości sesji Availability, odwiedź sekcję RunspaceAvailability.