Freigeben über

Receive-PSSession

  • Referenz
Modul:
Microsoft.PowerShell.Core

Ruft die Ergebnisse von Befehlen in getrennten Sitzungen ab.

Syntax

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>
       [-ApplicationName <String>]
       [-ConfigurationName <String>]
       -Name <String>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-Port <Int32>]
       [-UseSSL]
       [-SessionOption <PSSessionOption>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Receive-PSSession
       [-ComputerName] <String>
       [-ApplicationName <String>]
       [-ConfigurationName <String>]
       -InstanceId <Guid>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-Port <Int32>]
       [-UseSSL]
       [-SessionOption <PSSessionOption>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Receive-PSSession
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri>
       [-AllowRedirection]
       -Name <String>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-SessionOption <PSSessionOption>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Receive-PSSession
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri>
       [-AllowRedirection]
       -InstanceId <Guid>
       [-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>]

Beschreibung

Dieses Cmdlet ist nur auf der Windows-Plattform verfügbar.

Das Receive-PSSession Cmdlet ruft die Ergebnisse von Befehlen ab, die in PowerShell-Sitzungen (PSSession) ausgeführt werden, die getrennt wurden. Wenn die Sitzung derzeit verbunden ist, werden die Ergebnisse von Befehlen abgerufen, Receive-PSSession die ausgeführt wurden, wenn die Sitzung getrennt wurde. Wenn die Sitzung weiterhin getrennt ist, Receive-PSSession wird eine Verbindung mit der Sitzung hergestellt, alle angehaltenen Befehle fortgesetzt und die Ergebnisse der befehle abgerufen, die in der Sitzung ausgeführt werden.

Dieses Cmdlet wurde in PowerShell 3.0 eingeführt.

Sie können zusätzlich oder anstelle eines Befehls einen Receive-PSSession Connect-PSSession Befehl verwenden. Receive-PSSession kann eine Verbindung mit jeder getrennten oder erneuten Verbindung herstellen, die in anderen Sitzungen oder auf anderen Computern gestartet wurde.

Receive-PSSession funktioniert auf PSSessions , die absichtlich mit dem Disconnect-PSSession Cmdlet oder dem Invoke-Command InDisconnectedSession-Parameter getrennt wurden. Oder nicht versehentlich durch eine Netzwerkunterbrechung getrennt.

Wenn Sie das Receive-PSSession Cmdlet verwenden, um eine Verbindung mit einer Sitzung herzustellen, in der keine Befehle ausgeführt oder angehalten werden, Receive-PSSession stellt eine Verbindung mit der Sitzung her, gibt jedoch keine Ausgabe oder Fehler zurück.

Weitere Informationen zum Feature "Getrennte Sitzungen" finden Sie unter about_Remote_Disconnected_Sessions.

Einige Beispiele verwenden splatting, um die Zeilenlänge zu reduzieren und die Lesbarkeit zu verbessern. Weitere Informationen finden Sie unter about_Splatting.

Beispiele

Beispiel 1: Herstellen einer Verbindung mit einer PSSession

In diesem Beispiel wird eine Verbindung mit einer Sitzung auf einem Remotecomputer hergestellt und die Ergebnisse von Befehlen abgerufen, die in einer Sitzung ausgeführt werden.

Receive-PSSession -ComputerName Server01 -Name ITTask

Der Receive-PSSession Remotecomputer mit dem Parameter "ComputerName " wird angegeben. Der Name-Parameter identifiziert die ITTask-Sitzung auf dem Server01-Computer. Das Beispiel ruft die Ergebnisse von Befehlen ab, die in der ITTask-Sitzung ausgeführt wurden.

Da der Befehl nicht den OutTarget-Parameter verwendet, werden die Ergebnisse in der Befehlszeile angezeigt.

Beispiel 2: Abrufen von Ergebnissen aller Befehle bei getrennten Sitzungen

In diesem Beispiel werden die Ergebnisse aller Befehle, die in allen getrennten Sitzungen auf zwei Remotecomputern ausgeführt werden, angezeigt.

Wenn eine Sitzung nicht getrennt wurde oder keine Befehle ausgeführt wird, Receive-PSSession stellt sie keine Verbindung mit der Sitzung her und gibt keine Ausgabe oder Fehler zurück.

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

Get-PSSession verwendet den Parameter ComputerName , um die Remotecomputer anzugeben. Die Objekte werden an die Pipeline gesendet.Receive-PSSession

Beispiel 3: Abrufen der Ergebnisse eines Skripts, das in einer Sitzung ausgeführt wird

In diesem Beispiel wird das Receive-PSSession Cmdlet verwendet, um die Ergebnisse eines Skripts abzurufen, das in der Sitzung eines Remotecomputers ausgeführt wurde.

$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

Der Befehl verwendet die Parameter ComputerName und Name , um die getrennte Sitzung zu identifizieren. Er verwendet den Parameter "OutTarget " mit dem Wert "Job", um Receive-PSSession die Ergebnisse als Auftrag zurückzugeben. Der Parameter JobName gibt einen Namen für den Auftrag in der erneut verbundenen Sitzung an. Der Parameter "Credential " führt den Receive-PSSession Befehl mithilfe der Berechtigungen eines Domänenadministrators aus.

Die Ausgabe zeigt, dass Receive-PSSession die Ergebnisse als Auftrag in der aktuellen Sitzung zurückgegeben wurden. Verwenden Sie einen Receive-Job Befehl, um die Auftragsergebnisse abzurufen.

Beispiel 4: Abrufen von Ergebnissen nach einem Netzwerkausfall

In diesem Beispiel wird das Receive-PSSession Cmdlet verwendet, um die Ergebnisse eines Auftrags abzurufen, nachdem ein Netzwerkausfall eine Sitzungsverbindung unterbrochen hat. PowerShell versucht automatisch, die Sitzung einmal pro Sekunde für die nächsten vier Minuten erneut zu verbinden, und gibt den Aufwand nur dann auf, wenn alle Versuche im Vier-Minuten-Intervall fehlschlagen.

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

Das New-PSSession Cmdlet erstellt eine Sitzung auf dem Server01-Computer und speichert die Sitzung in der $s Variablen. Die $s Variable zeigt an, dass der Status geöffnet ist und die Verfügbarkeit verfügbar ist. Diese Werte geben an, dass Sie mit der Sitzung verbunden sind und Befehle in der Sitzung ausführen können.

Das Invoke-Command Cmdlet führt ein Skript in der Sitzung in der $s Variablen aus. Das Skript beginnt mit der Ausführung und Rückgabe von Daten, aber ein Netzwerkausfall tritt auf, der die Sitzung unterbricht. Der Benutzer muss die Sitzung beenden und den lokalen Computer neu starten.

Wenn der Computer neu gestartet wird, startet der Benutzer PowerShell und führt einen Get-PSSession Befehl aus, um Sitzungen auf dem Server01-Computer abzurufen. Die Ausgabe zeigt, dass die AD-Sitzung noch auf dem Server01-Computer vorhanden ist. Der Status gibt an, dass die AD-Sitzung getrennt ist. Der Verfügbarkeitswert "None" gibt an, dass die Sitzung nicht mit Clientsitzungen verbunden ist.

Das Receive-PSSession Cmdlet stellt eine erneute Verbindung mit der AD-Sitzung her und ruft die Ergebnisse des Skripts ab, das in der Sitzung ausgeführt wurde. Der Befehl verwendet den Parameter OutTarget , um die Ergebnisse in einem Auftrag namens ADJob anzufordern. Der Befehl gibt ein Auftragsobjekt zurück, und die Ausgabe gibt an, dass das Skript noch ausgeführt wird.

Das Get-PSSession Cmdlet wird verwendet, um den Auftragsstatus zu überprüfen. Die Ausgabe bestätigt, dass das Receive-PSSession Cmdlet erneut mit der AD-Sitzung verbunden ist, die jetzt geöffnet und für Befehle verfügbar ist. Und das Skript hat die Ausführung fortgesetzt und erhält die Skriptergebnisse.

Beispiel 5: Erneute Verbindung mit getrennten Sitzungen

In diesem Beispiel wird das Receive-PSSession Cmdlet verwendet, um eine erneute Verbindung mit Sitzungen herzustellen, die absichtlich getrennt wurden, und die Ergebnisse von Aufträgen abzurufen, die in den Sitzungen ausgeführt wurden.

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

Das Invoke-Command Cmdlet führt ein Skript auf drei Remotecomputern aus. Da das Skript Daten aus mehreren Datenbanken sammelt und zusammenfasst, dauert es häufig eine längere Zeit bis zum Abschluss des Skripts. Der Befehl verwendet den Parameter "InDisconnectedSession ", der die Skripts startet und dann sofort die Sitzungen trennt. Der Parameter SessionOption erweitert den IdleTimeout-Wert der getrennten Sitzung. Getrennte Sitzungen werden ab dem Moment, an dem sie getrennt sind, als im Leerlauf betrachtet. Es ist wichtig, das Leerlauftimeout für lange genug festzulegen, damit die Befehle abgeschlossen werden können, und Sie können die Verbindung zur Sitzung erneut herstellen. Sie können idleTimeout nur dann festlegen, wenn Sie die PSSession erstellen und sie nur ändern, wenn Sie die Verbindung damit trennen. Sie können den IdleTimeout-Wert nicht ändern, wenn Sie eine Verbindung mit einer PSSession herstellen oder dessen Ergebnisse erhalten. Nach dem Ausführen des Befehls beendet der Benutzer PowerShell und schließt den Computer.

Am nächsten Tag setzt der Benutzer Windows fort, startet PowerShell und ruft Get-PSSession die Sitzungen ab, in denen die Skripts ausgeführt wurden. Der Befehl identifiziert die Sitzungen anhand des Computernamens, des Sitzungsnamens und des Namens der Sitzungskonfiguration und speichert die Sitzungen in der $s Variablen. Der Wert der $s Variablen wird angezeigt und zeigt an, dass die Sitzungen getrennt sind, aber nicht ausgelastet sind.

Das Receive-PSSession Cmdlet stellt eine Verbindung mit den Sitzungen in der $s Variablen und ruft deren Ergebnisse ab. Der Befehl speichert die Ergebnisse in der $Results Variablen. Die $s Variable wird angezeigt und zeigt an, dass die Sitzungen verbunden sind und für Befehle verfügbar sind.

Das Skript führt zu der $Results Variablen, die in der PowerShell-Konsole angezeigt werden. Wenn eines der Ergebnisse unerwartet ist, kann der Benutzer Befehle in den Sitzungen ausführen, um die Ursache zu untersuchen.

Beispiel 6: Ausführen eines Auftrags in einer getrennten Sitzung

Dieses Beispiel zeigt, was mit einem Auftrag geschieht, der in einer getrennten Sitzung ausgeführt wird.

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

Das New-PSSession Cmdlet erstellt die Testsitzung auf dem Server01-Computer. Der Befehl speichert die Sitzung in der Variablen $s.

Das Invoke-Command Cmdlet führt einen Befehl in der Sitzung in der $s Variablen aus. Der Befehl verwendet den Parameter AsJob , um den Befehl als Auftrag auszuführen und das Auftragsobjekt in der aktuellen Sitzung zu erstellen. Der Befehl gibt ein Auftragsobjekt zurück, das in der $j Variablen gespeichert ist. Die $j Variable zeigt das Auftragsobjekt an.

Das Sitzungsobjekt in der $s Variablen wird an die Pipeline Disconnect-PSSession gesendet und die Sitzung wird getrennt.

Die $j Variable wird angezeigt und zeigt den Effekt der Trennung des Auftragsobjekts in der $j Variablen an. Der Auftragsstatus ist jetzt getrennt.

Der Receive-Job Vorgang wird auf dem Auftrag in der $j Variablen ausgeführt. Die Ausgabe zeigt, dass der Auftrag vor der Sitzung die Ausgabe zurückgibt und der Auftrag getrennt wurde.

Das Connect-PSSession Cmdlet wird in derselben Clientsitzung ausgeführt. Der Befehl stellt eine erneute Verbindung mit der Testsitzung auf dem Server01-Computer her und speichert die Sitzung in der $s2 Variablen.

Das Receive-PSSession Cmdlet ruft die Ergebnisse des Auftrags ab, der in der Sitzung ausgeführt wurde. Da der Befehl in derselben Sitzung ausgeführt wird, Receive-PSSession werden die Ergebnisse standardmäßig als Auftrag zurückgegeben und dasselbe Auftragsobjekt wiederverwendet. Der Befehl speichert den Auftrag in der $j2 Variablen. Das Receive-Job Cmdlet ruft die Ergebnisse des Auftrags in der $j Variablen ab.

Parameter

-AllowRedirection

Gibt an, dass dieses Cmdlet die Umleitung dieser Verbindung zu einem alternativen URI (Uniform Resource Identifier) zulässt.

Wenn Sie den Parameter ConnectionURI verwenden, kann das Remoteziel eine Anweisung zurückgeben, um zu einem anderen URI umzuleiten. Standardmäßig leitet PowerShell keine Verbindungen um, Sie können diesen Parameter jedoch verwenden, um die Verbindung umzuleiten.

Sie können auch einschränken, wie oft die Verbindung umgeleitet wird, indem Sie den Wert der Option "MaximumConnectionRedirectionCount " ändern. Verwenden Sie den Parameter MaximumRedirection des New-PSSessionOption Cmdlets, oder legen Sie die MaximumConnectionRedirectionCount-Eigenschaft der $PSSessionOption Einstellungsvariable fest. Der Standardwert ist 5.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ApplicationName

Gibt eine Anwendung an. Dieses Cmdlet verbindet sich nur mit Sitzungen, die die angegebene Anwendung verwenden.

Geben Sie das Anwendungsnamensegment des Verbindungs-URI ein. Beispielsweise ist WSMan im folgenden Verbindungs-URI der Anwendungsname: http://localhost:5985/WSMAN.

Der Anwendungsname einer Sitzung wird in der Runspace.ConnectionInfo.AppName-Eigenschaft der Sitzung gespeichert.

Der Wert des Parameters wird zum Auswählen und Filtern von Sitzungen verwendet. Die Anwendung, die von der Sitzung verwendet wird, wird nicht geändert.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Authentication

Gibt den Mechanismus an, mit dem die Benutzeranmeldeinformationen im Befehl authentifiziert werden, um die Verbindung mit einer getrennten Sitzung wiederherzustellen. Zulässige Werte für diesen Parameter:

  • Standard
  • Grundlegend
  • Credssp
  • Digest
  • Kerberos
  • Aushandeln
  • NegotiateWithImplicitCredential

Der Standardwert lautet Default.

Weitere Informationen zu den Werten dieses Parameters finden Sie unter AuthenticationMechanism Enumeration.

Achtung

Credential Security Support Provider (CredSSP)-Authentifizierung, bei der die Benutzeranmeldeinformationen an einen Remotecomputer übergeben werden, der authentifiziert werden soll, ist für Befehle konzipiert, die eine Authentifizierung für mehrere Ressourcen erfordern, z. B. den Zugriff auf eine Remotenetzwerkfreigabe. Dieser Mechanismus erhöht das Sicherheitsrisiko des Remotevorgangs. Wenn die Sicherheit des Remotecomputers gefährdet ist, können die an ihn übergebenen Anmeldeinformationen zum Steuern der Netzwerksitzung verwendet werden.

Typ:AuthenticationMechanism
Zulässige Werte:Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos
Position:Named
Standardwert:Default
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CertificateThumbprint

Gibt das digitale Zertifikat für öffentliche Schlüssel (X.509) eines Benutzerkontos mit der Berechtigung zum Herstellen einer Verbindung mit der getrennten Sitzung an. Geben Sie den Zertifikatfingerabdruck des Zertifikats ein.

Zertifikate werden bei der clientzertifikatbasierten Authentifizierung verwendet. Zertifikate können nur lokalen Benutzerkonten zugeordnet werden und funktionieren nicht mit Domänenkonten.

Um einen Zertifikatfingerabdruck zu erhalten, verwenden Sie einen oder Get-ChildItem einen Get-Item Befehl auf dem PowerShell-LaufwerkCert:.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ComputerName

Gibt den Computer an, auf dem die getrennte Sitzung gespeichert ist. Sitzungen werden auf dem Computer gespeichert, der sich auf der Serverseite befindet oder das Ende einer Verbindung empfängt. Die Standardeinstellung ist der lokale Computer.

Geben Sie den NetBIOS-Namen, eine IP-Adresse oder einen vollqualifizierten Domänennamen (FQDN) eines Computers ein. Wildcardzeichen sind nicht zulässig. Um den lokalen Computer anzugeben, geben Sie den Computernamen, einen Punkt (.), $env:COMPUTERNAMEoder localhost ein.

Typ:String
Aliase:Cn
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ConfigurationName

Gibt den Namen einer Sitzungskonfiguration an. Dieses Cmdlet verbindet sich nur mit Sitzungen, die die angegebene Sitzungskonfiguration verwenden.

Geben Sie einen Konfigurationsnamen oder den vollqualifizierten Ressourcen-URI für eine Sitzungskonfiguration ein. Wenn Sie nur den Konfigurationsnamen angeben, wird der folgende Schema-URI vorangestellt:

http://schemas.microsoft.com/powershell.

Der Konfigurationsname einer Sitzung wird in der ConfigurationName-Eigenschaft der Sitzung gespeichert.

Der Wert des Parameters wird zum Auswählen und Filtern von Sitzungen verwendet. Die sitzungskonfiguration, die von der Sitzung verwendet wird, wird nicht geändert.

Weitere Informationen zu Sitzungskonfigurationen finden Sie unter about_Session_Configurations.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ConnectionUri

Gibt einen URI an, der den Verbindungsendpunkt definiert, der zum erneuten Herstellen einer Verbindung mit der getrennten Sitzung verwendet wird.

Der URI muss vollqualifiziert sein. Das Format der Zeichenfolge lautet wie folgt:

<Transport>://<ComputerName>:<Port>/<ApplicationName>

Der Standardwert lautet:

http://localhost:5985/WSMAN

Wenn Sie keinen Verbindungs-URI angeben, können Sie die Parameter UseSSL, ComputerName, Port und ApplicationName verwenden, um die Verbindungs-URI-Werte anzugeben.

Gültige Werte für das Transportsegment des URI sind HTTP und HTTPS. Wenn Sie einen Verbindungs-URI mit einem Transportsegment angeben, aber keinen Port angeben, wird die Sitzung mit Standardports erstellt: 80 für HTTP und 443 für HTTPS. Um die Standardports für PowerShell-Remoting zu verwenden, geben Sie Port 5985 für HTTP oder 5986 für HTTPS an.

Wenn der Zielcomputer die Verbindung zu einem anderen URI umleitet, verhindert PowerShell die Umleitung, es sei denn, Sie verwenden den Parameter AllowRedirection im Befehl.

Typ:Uri
Aliase:URI, CU
Position:0
Standardwert:http://localhost:5985/WSMAN
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Credential

Gibt ein Benutzerkonto mit der Berechtigung zum Herstellen einer Verbindung mit der getrennten Sitzung an. Der Standardwert ist der aktuelle Benutzer.

Geben Sie einen Benutzernamen ein, z. B. "User01" oder "Domain01\User01", oder geben Sie ein vom Cmdlet generiertes Get-Credential PSCredential-Objekt ein. Wenn Sie einen Benutzernamen eingeben, werden Sie aufgefordert, das Kennwort einzugeben.

Anmeldeinformationen werden in einem PSCredential-Objekt gespeichert, und das Kennwort wird als SecureString gespeichert.

Hinweis

Weitere Informationen zum Schutz von SecureString finden Sie unter "Wie sicher ist SecureString?".

Typ:PSCredential
Position:Named
Standardwert:Current user
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Id

Gibt die ID einer getrennten Sitzung an. Der Id-Parameter funktioniert nur, wenn die getrennte Sitzung zuvor mit der aktuellen Sitzung verbunden war.

Dieser Parameter ist gültig, aber nicht effektiv, wenn die Sitzung auf dem lokalen Computer gespeichert wird, aber nicht mit der aktuellen Sitzung verbunden war.

Typ:Int32
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-InstanceId

Gibt die Instanz-ID der getrennten Sitzung an. Die Instanz-ID ist eine GUID, die eine PSSession auf einem lokalen oder Remotecomputer eindeutig identifiziert. Die Instanz-ID wird in der InstanceID-Eigenschaft der PSSession gespeichert.

Typ:Guid
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-JobName

Gibt einen Anzeigenamen für den Auftrag an, Receive-PSSession der zurückgegeben wird.

Receive-PSSession gibt einen Auftrag zurück, wenn der Wert des OutTarget-Parameters Job ist oder der Auftrag, der in der getrennten Sitzung ausgeführt wird, in der aktuellen Sitzung gestartet wurde.

Wenn der Auftrag, der in der getrennten Sitzung ausgeführt wird, in der aktuellen Sitzung gestartet wurde, verwendet PowerShell das ursprüngliche Auftragsobjekt in der Sitzung wieder und ignoriert den Wert des JobName-Parameters .

Wenn der Auftrag, der in der getrennten Sitzung ausgeführt wird, in einer anderen Sitzung gestartet wurde, erstellt PowerShell ein neues Auftragsobjekt. Es wird ein Standardname verwendet, aber Sie können diesen Parameter verwenden, um den Namen zu ändern.

Wenn der Standardwert oder der explizite Wert des OutTarget-Parameters nicht Job ist, ist der Befehl erfolgreich, aber der JobName-Parameter hat keine Auswirkung.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Name

Gibt den Anzeigenamen der getrennten Sitzung an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-OutTarget

Bestimmt, wie die Sitzungsergebnisse zurückgegeben werden. Zulässige Werte für diesen Parameter:

  • Auftrag. Gibt die Ergebnisse asynchron in ein Auftragsobjekt zurück. Sie können den JobName-Parameter verwenden, um einen Namen oder neuen Namen für den Auftrag anzugeben.
  • Host. Gibt die Ergebnisse (synchron) an die Befehlszeile zurück. Wenn der Befehl fortgesetzt wird oder die Ergebnisse aus einer großen Anzahl von Objekten bestehen, kann die Antwort verzögert werden.

Der Standardwert des OutTarget-Parameters ist Host. Wenn der Befehl, der in einer getrennten Sitzung empfangen wird, in der aktuellen Sitzung gestartet wurde, ist der Standardwert des OutTarget-Parameters das Formular, in dem der Befehl gestartet wurde. Wenn der Befehl standardmäßig als Auftrag gestartet wurde, wird er als Auftrag zurückgegeben. Andernfalls wird sie standardmäßig an das Hostprogramm zurückgegeben.

In der Regel zeigt das Hostprogramm die zurückgegebenen Objekte ohne Verzögerung in der Befehlszeile an, dieses Verhalten kann jedoch variieren.

Typ:OutTarget
Zulässige Werte:Default, Host, Job
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Port

Gibt den Netzwerkport des Remotecomputers an, der zum erneuten Herstellen einer Verbindung mit der Sitzung verwendet wird. Um eine Verbindung mit einem Remotecomputer herzustellen, muss sie auf dem von der Verbindung genutzten Port lauschen. Die Standardports sind 5985, der WinRM-Port für HTTP und 5986, der WinRM-Port für HTTPS.

Bevor Sie einen alternativen Port verwenden, müssen Sie den WinRM-Listener auf dem Remotecomputer so konfigurieren, dass er auf diesen Port lauscht. Geben Sie zum Konfigurieren des Listeners die folgenden beiden Befehle an der PowerShell-Eingabeaufforderung ein:

Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse

New-Item -Path WSMan:\Localhost\listener -Transport http -Address * -Port \<port-number\>

Verwenden Sie den Port-Parameter nur, wenn er erforderlich ist. Der im Befehl festgelegte Port gilt für alle Computer oder Sitzungen, auf denen der Befehl ausgeführt wird. Eine alternative Porteinstellung kann verhindern, dass der Befehl auf allen Computern ausgeführt wird.

Typ:Int32
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Session

Gibt die getrennte Sitzung an. Geben Sie eine Variable ein, die die PSSession oder einen Befehl enthält, der die PSSession erstellt oder abruft, z. B. einen Get-PSSession Befehl.

Typ:PSSession
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-SessionOption

Gibt erweiterte Optionen für die Sitzung an. Geben Sie ein SessionOption-Objekt ein, z. B. ein Objekt, das Sie mithilfe des New-PSSessionOption Cmdlets erstellen, oder eine Hashtabelle, in der es sich bei den Schlüsseln um Sitzungsoptionsnamen und die Werte um Sitzungsoptionswerte handelt.

Die Standardwerte für die Optionen werden durch den Wert der $PSSessionOption Einstellungsvariablen bestimmt, wenn sie festgelegt ist. Andernfalls werden die Standardwerte durch Optionen festgelegt, die in der Sitzungskonfiguration festgelegt sind.

Die Sitzungsoptionswerte haben Vorrang vor Standardwerten für Sitzungen, die in der $PSSessionOption Einstellungsvariable und in der Sitzungskonfiguration festgelegt sind. Sie haben jedoch keine Vorrang vor maximal festgelegten Werten, Kontingenten oder Grenzwerten in der Sitzungskonfiguration.

Eine Beschreibung der Sitzungsoptionen, die die Standardwerte enthalten, finden Sie unter New-PSSessionOption. Informationen zur $PSSessionOption Einstellungsvariablen finden Sie unter about_Preference_Variables. Weitere Informationen zu Sitzungskonfigurationen finden Sie unter about_Session_Configurations.

Typ:PSSessionOption
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-UseSSL

Gibt an, dass dieses Cmdlet das SSL-Protokoll (Secure Sockets Layer) verwendet, um eine Verbindung mit der getrennten Sitzung herzustellen. Standardmäßig wird SSL nicht verwendet.

WS-Management verschlüsselt alle über das Netzwerk übertragenen PowerShell-Inhalte. UseSSL ist ein zusätzlicher Schutz, der die Daten über eine HTTPS-Verbindung statt über eine HTTP-Verbindung sendet.

Wenn Sie diesen Parameter verwenden und SSL für den Für den Befehl verwendeten Port nicht verfügbar ist, schlägt der Befehl fehl.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

PSSession

Sie können Sitzungsobjekte an dieses Cmdlet weiterleiten, z. B. objekte, die Get-PSSession vom Cmdlet zurückgegeben werden.

Int32

Sie können Sitzungs-IDs an dieses Cmdlet weiterleiten.

Guid

Sie können die Instanz-IDs von Sitzungen dieses Cmdlets weiterleiten.

String

Sie können Sitzungsnamen an dieses Cmdlet weiterleiten.

Ausgaben

Job

Wenn der Wert oder Standardwert des OutTarget-Parameters lautet, Receive-PSSession wird Jobein Auftragsobjekt zurückgegeben.

PSObject

Dieses Cmdlet gibt die Ergebnisse von Befehlen zurück, die in der getrennten Sitzung ausgeführt wurden, falls vorhanden.

Hinweise

PowerShell enthält die folgenden Aliase für Receive-PSSession:

  • Alle Plattformen:
    • rcsn

Dieses Cmdlet ist nur auf Windows-Plattformen verfügbar.

Receive-PSSession ruft nur Ergebnisse von Sitzungen ab, die getrennt wurden. Nur Sitzungen, die mit PowerShell 3.0- oder höher-Versionen verbunden oder beendet werden, können getrennt und erneut verbunden werden.

Wenn die Befehle, die in der getrennten Sitzung ausgeführt wurden, keine Ergebnisse generiert oder die Ergebnisse bereits an eine andere Sitzung zurückgegeben wurden, Receive-PSSession generiert keine Ausgabe.

Der Ausgabepuffermodus einer Sitzung bestimmt, wie Befehle in der Sitzung die Ausgabe verwalten, wenn die Sitzung getrennt wird. Wenn der Wert der OutputBufferingMode-Option der Sitzung drop ist und der Ausgabepuffer voll ist, beginnt der Befehl mit dem Löschen der Ausgabe. Receive-PSSession diese Ausgabe kann nicht wiederhergestellt werden. Weitere Informationen zur Ausgabepuffermodusoption finden Sie in den Hilfeartikeln zu den Cmdlets New-PSSessionOption und New-PSTransportOption .

Sie können den Leerlauftimeoutwert einer PSSession nicht ändern, wenn Sie eine Verbindung mit der PSSession herstellen oder Ergebnisse erhalten. Der Parameter "SessionOption " von Receive-PSSession "SessionOption" verwendet ein SessionOption-Objekt , das einen IdleTimeout-Wert aufweist. Der IdleTimeout-Wert des SessionOption-Objekts und der IdleTimeout-Wert der $PSSessionOption Variablen werden jedoch ignoriert, wenn eine Verbindung mit einer PSSession hergestellt wird oder Ergebnisse empfangen werden.

  • Sie können das Leerlauftimeout einer PSSession festlegen und ändern, wenn Sie die PSSession erstellen, indem Sie die New-PSSession PSSession verwenden oder Invoke-Command Cmdlets verwenden und die Verbindung mit der PSSession trennen.
  • Die IdleTimeout-Eigenschaft einer PSSession ist wichtig für getrennte Sitzungen, da sie bestimmt, wie lange eine getrennte Sitzung auf dem Remotecomputer verwaltet wird. Getrennte Sitzungen gelten vom Moment ihrer Trennung an als im Leerlauf, selbst wenn Befehle in der getrennten Sitzung ausgeführt werden.

Wenn Sie einen Auftrag in einer Remotesitzung mithilfe des AsJob-Parameters des Invoke-Command Cmdlets starten, wird das Auftragsobjekt in der aktuellen Sitzung erstellt, obwohl der Auftrag in der Remotesitzung ausgeführt wird. Wenn Sie die Remotesitzung trennen, wird das Auftragsobjekt in der aktuellen Sitzung vom Auftrag getrennt. Das Auftragsobjekt enthält alle Ergebnisse, die an ihn zurückgegeben wurden, aber keine neuen Ergebnisse vom Auftrag in der getrennten Sitzung erhalten.

Wenn ein anderer Client eine Verbindung mit der Sitzung herstellt, die den ausgeführten Auftrag enthält, sind die Ergebnisse, die an das ursprüngliche Auftragsobjekt in der ursprünglichen Sitzung übermittelt wurden, in der neu verbundenen Sitzung nicht verfügbar. Nur Ergebnisse, die nicht an das ursprüngliche Auftragsobjekt übermittelt wurden, sind in der neu verbundenen Sitzung verfügbar.

Wenn Sie ein Skript in einer Sitzung starten und dann die Verbindung mit der Sitzung trennen, stehen alle Ergebnisse, die das Skript an die Sitzung übermittelt, bevor die Verbindung nicht für einen anderen Client verfügbar ist, der eine Verbindung mit der Sitzung herstellt.

Verwenden Sie den InDisconnectedSession-Parameter des Cmdlets, um Datenverluste in Sitzungen zu verhindern, die Invoke-Command Sie trennen möchten. Da dieser Parameter verhindert, dass Ergebnisse an die aktuelle Sitzung zurückgegeben werden, sind alle Ergebnisse verfügbar, wenn die Verbindung mit der Sitzung wiederhergestellt wird.

Sie können Datenverluste auch verhindern, indem Sie das Invoke-Command Cmdlet verwenden, um einen Start-Job Befehl in der Remotesitzung auszuführen. In diesem Fall wird das Auftragsobjekt in der Remotesitzung erstellt. Sie können das Receive-PSSession Cmdlet nicht verwenden, um die Auftragsergebnisse abzurufen. Verwenden Sie stattdessen das Connect-PSSession Cmdlet, um eine Verbindung mit der Sitzung herzustellen, und verwenden Sie dann das Invoke-Command Cmdlet, um einen Receive-Job Befehl in der Sitzung auszuführen.

Wenn eine Sitzung, die einen ausgeführten Auftrag enthält, getrennt und dann erneut verbunden wird, wird das ursprüngliche Auftragsobjekt nur wiederverwendet, wenn der Auftrag getrennt und erneut mit derselben Sitzung verbunden ist, und der Befehl zum erneuten Verbinden keinen neuen Auftragsnamen angibt. Wenn die Sitzung erneut mit einer anderen Clientsitzung verbunden ist oder ein neuer Auftragsname angegeben wird, erstellt PowerShell ein neues Auftragsobjekt für die neue Sitzung.

Wenn Sie eine PSSession trennen, wird der Sitzungszustand getrennt, und die Verfügbarkeit ist None.

  • Der Wert der State-Eigenschaft ist relativ zur aktuellen Sitzung. Ein Wert von "Disconnected" bedeutet, dass die PSSession nicht mit der aktuellen Sitzung verbunden ist. Es bedeutet jedoch nicht, dass die PSSession von allen Sitzungen getrennt ist. Sie kann mit einer anderen Sitzung verbunden sein. Um festzustellen, ob Sie eine Verbindung mit der Sitzung herstellen oder erneut herstellen können, verwenden Sie die Availability-Eigenschaft .
  • Ein Verfügbarkeitswert von None gibt an, dass Sie eine Verbindung mit der Sitzung herstellen können. Ein Wert von Beschäftigt gibt an, dass Sie keine Verbindung mit der PSSession herstellen können, da sie mit einer anderen Sitzung verbunden ist.
  • Weitere Informationen zu den Werten der State-Eigenschaft von Sitzungen finden Sie unter RunspaceState.
  • Weitere Informationen zu den Werten der Verfügbarkeitseigenschaft von Sitzungen finden Sie unter RunspaceAvailability.