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>
[-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>]
Описание
Этот командлет доступен только на платформе Windows.
Командлет Receive-PSSession
получает результаты команд, выполняемых в сеансах PowerShell (PSSession), которые были отключены. Если сеанс подключен в данный момент, Receive-PSSession
получает результаты команд, которые выполнялись при отключении сеанса. Если сеанс по-прежнему отключен, Receive-PSSession
подключается к сеансу, возобновляет все приостановленные команды и получает результаты команд, выполняемых в сеансе.
Этот командлет появился в PowerShell 3.0.
Можно использовать Receive-PSSession
в дополнение к команде или вместо нее Connect-PSSession
.
Receive-PSSession
может подключаться к любому отключенном или повторно подключенном сеансу, который был запущен в других сеансах или на других компьютерах.
Receive-PSSession
работает с PSSessions, которые были отключены намеренно с помощью командлета Disconnect-PSSession
или Invoke-Command
параметра InDisconnectedSession. Или отключается непреднамеренно путем прерывания сети.
Если вы используете Receive-PSSession
командлет для подключения к сеансу, в котором команды не выполняются или приостановлены, подключается к сеансу, Receive-PSSession
но не возвращает выходные данные или ошибки.
Дополнительные сведения о функции отключенных сеансов см. в разделе about_Remote_Disconnected_Sessions.
В некоторых примерах используется сплатирование для уменьшения длины строки и повышения удобочитаемости. Дополнительные сведения см. в about_Splatting.
Примеры
Пример 1. Подключение к PSSession
Этот пример подключается к сеансу на удаленном компьютере и получает результаты команд, выполняемых в сеансе.
Receive-PSSession -ComputerName Server01 -Name ITTask
Указывает Receive-PSSession
удаленный компьютер с параметром ComputerName . Параметр Name определяет сеанс ITTask на компьютере Server01. В этом примере возвращаются результаты команд, которые выполнялись в сеансе ITTask.
Так как команда не использует параметр OutTarget , результаты отображаются в командной строке.
Пример 2. Получение результатов всех команд в отключенных сеансах
В этом примере возвращаются результаты всех команд, выполняемых во всех отключенных сеансах на двух удаленных компьютерах.
Если какой-либо сеанс не был отключен или не выполняет команды, Receive-PSSession
не подключается к сеансу и не возвращает никаких выходных данных или ошибок.
Get-PSSession -ComputerName Server01, Server02 | Receive-PSSession
Get-PSSession
использует параметр ComputerName для указания удаленных компьютеров. Объекты отправляются вниз по конвейеру Receive-PSSession
.
Пример 3. Получение результатов скрипта, выполняемого в сеансе
В этом примере используется Receive-PSSession
командлет для получения результатов сценария, выполняющегося в сеансе удаленного компьютера.
$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
Команда использует параметры ComputerName и Name для идентификации отключенного сеанса.
Он использует параметр OutTarget со значением Job, чтобы Receive-PSSession
вернуть результаты в качестве задания. Параметр JobName указывает имя задания в повторно подключенном сеансе.
Параметр Credential запускает Receive-PSSession
команду с помощью разрешений администратора домена.
Выходные данные показывают, что Receive-PSSession
результаты возвращаются в качестве задания в текущем сеансе. Чтобы получить результаты задания, используйте Receive-Job
команду
Пример 4. Получение результатов после сбоя сети
В этом примере используется Receive-PSSession
командлет для получения результатов задания после сбоя сети, нарушающего подключение к сеансу. PowerShell автоматически пытается повторно подключить сеанс один раз в секунду в течение следующих четырех минут и отказывается от усилий, только если все попытки в четырехминутном интервале завершаются сбоем.
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
Командлет New-PSSession
создает сеанс на компьютере Server01 и сохраняет сеанс в переменной $s
. Переменная $s
показывает, что состояние открыто и доступность доступна. Эти значения указывают, что вы подключены к сеансу и можете выполнять команды в сеансе.
Командлет Invoke-Command
запускает скрипт в сеансе в переменной $s
. Скрипт начинает выполняться и возвращает данные, но из-за сбоя сети сеанс прерывается. Пользователю необходимо завершить сеанс и перезагрузить локальный компьютер.
После перезагрузки компьютера пользователь запускает PowerShell и выполняет Get-PSSession
команду для получения сеансов на компьютере Server01. В выходных данных показано, что сеанс AD по-прежнему существует на компьютере Server01. Состояние указывает, что сеанс AD отключен. Значение доступности None указывает, что сеанс не подключен к каким-либо клиентским сеансам.
Командлет Receive-PSSession
повторно подключается к сеансу AD и получает результаты сценария, запущенного в сеансе. Команда использует параметр OutTarget для запроса результатов задания с именем ADJob. Команда возвращает объект задания, а выходные данные указывают на то, что скрипт по-прежнему выполняется.
Командлет Get-PSSession
используется для проверки состояния задания. Выходные данные подтверждают повторное Receive-PSSession
подключение командлета к сеансу AD , который теперь открыт и доступен для команд. И скрипт возобновил выполнение и получает результаты скрипта.
Пример 5. Повторное подключение к отключенным сеансам
В этом примере используется Receive-PSSession
командлет для повторного подключения к сеансам, которые были намеренно отключены и получения результатов заданий, выполняемых в сеансах.
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
Командлет Invoke-Command
запускает сценарий на трех удаленных компьютерах. Так как скрипт собирает и суммирует данные из нескольких баз данных, для завершения скрипта часто требуется длительное время. Команда использует параметр InDisconnectedSession , который запускает скрипты, а затем немедленно отключает сеансы. Параметр SessionOption расширяет значение IdleTimeout отключенного сеанса. Отключенные сеансы считаются неактивными с момента отключения. Важно задать время ожидания простоя достаточно долго, чтобы команды могли завершиться, и вы можете повторно подключиться к сеансу. Параметр IdleTimeout можно задать только при создании PSSession и его изменении только при отключении от него. Невозможно изменить значение IdleTimeout при подключении к PSSession или получении его результатов. После выполнения команды пользователь выходит из PowerShell и закрывает компьютер.
На следующий день пользователь возобновляет Работу Windows, запускает PowerShell и использует для Get-PSSession
получения сеансов, в которых выполнялись скрипты. Команда определяет сеансы по имени компьютера, имени сеанса и имени конфигурации сеанса и сохраняет сеансы в переменной $s
. Отображается значение переменной $s
и показывает, что сеансы отключены, но не заняты.
Командлет Receive-PSSession
подключается к сеансам в переменной $s
и получает результаты.
Команда сохраняет результаты в переменной $Results
. Эта $s
переменная отображается и показывает, что сеансы подключены и доступны для команд.
Сценарий приводит к отображению переменной $Results
в консоли PowerShell. Если какой-либо из результатов непредвиден, пользователь может выполнить команды в сеансах для изучения первопричины.
Пример 6. Выполнение задания в отключенном сеансе
В этом примере показано, что происходит с заданием, выполняющимся в отключенном сеансе.
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
Командлет New-PSSession
создает тестовый сеанс на компьютере Server01. Сеанс сохраняется в переменную $s
.
Командлет Invoke-Command
выполняет команду в сеансе в переменной $s
. Команда использует параметр AsJob для выполнения команды в качестве задания и создает объект задания в текущем сеансе.
Команда возвращает объект задания, сохраненный в переменной $j
. Переменная $j
отображает объект задания.
Объект сеанса в переменной $s
отправляется по конвейеру Disconnect-PSSession
и сеанс отключается.
Эта $j
переменная отображается и показывает эффект отключения объекта задания в переменной $j
. Состояние задания меняется на "Отключено".
Выполняется Receive-Job
в задании в переменной $j
. В выходных данных показано, что задание начало возвращать выходные данные до сеанса и задание было отключено.
Командлет Connect-PSSession
выполняется в том же сеансе клиента. Команда повторно подключается к сеансу тестирования на компьютере Server01 и сохраняет сеанс в переменной $s2
.
Командлет Receive-PSSession
получает результаты задания, выполняемого в сеансе. Так как команда выполняется в том же сеансе, Receive-PSSession
возвращает результаты в качестве задания по умолчанию и повторно использует тот же объект задания. Команда сохраняет задание в переменной $j2
. Командлет Receive-Job
получает результаты задания в переменной $j
.
Параметры
-AllowRedirection
Указывает, что этот командлет разрешает перенаправление этого подключения на альтернативный универсальный код ресурса (URI).
При использовании параметра ConnectionURI удаленный компьютер может вернуть инструкцию для перенаправления на другой URI. По умолчанию PowerShell не перенаправляет подключения, но этот параметр можно использовать для перенаправления подключения.
Можно также ограничить количество перенаправлений соединение, изменив значение параметра сеанса MaximumConnectionRedirectionCount. Используйте параметр MaximumRedirection командлета New-PSSessionOption
или задайте свойство MaximumConnectionRedirectionCount переменной $PSSessionOption
предпочтения. Значение по умолчанию — 5.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ApplicationName
Указывает приложение. Этот командлет подключается только к сеансам, используюющим указанное приложение.
Введите сегмент имени приложения URI подключения. Например, в следующем URI подключения WSMan — это имя приложения: http://localhost:5985/WSMAN
Имя приложения сеанса хранится в свойстве сеанса Runspace.ConnectionInfo.AppName.
Значение параметра используется для выбора и фильтрации сеансов. Оно не изменяет приложение, которое использует сеанс.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Authentication
Указывает механизм, используемый для проверки подлинности учетных данных пользователя в команде для повторного подключения к отключенном сеансу. Допустимые значения для этого параметра:
- Значение по умолчанию
- Basic
- Credssp
- Digest (дайджест)
- Kerberos
- Согласование
- NegotiateWithImplicitCredential
Значение по умолчанию — Default.
Дополнительные сведения о значениях этого параметра см. в описании перечисления AuthenticationMechanism.
Внимание!
Проверка подлинности поставщика поддержки безопасности учетных данных (CredSSP), при которой учетные данные пользователя передаются на удаленный компьютер для проверки подлинности, предназначены для команд, требующих проверки подлинности в нескольких ресурсах, таких как доступ к удаленному сетевому ресурсу. Этот механизм повышает риск безопасности удаленной операции. Если удаленный компьютер скомпрометирован, учетные данные, передаваемые ему, могут использоваться для управления сетевым сеансом.
Type: | AuthenticationMechanism |
Accepted values: | Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos |
Position: | Named |
Default value: | Default |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CertificateThumbprint
Задает цифровой сертификат с открытым ключом (X509) учетной записи пользователя, который располагает разрешением для подключения к отсоединенному сеансу. Введите отпечаток сертификата.
Сертификаты используются при проверке подлинности на основе сертификата клиента. Сертификаты можно сопоставить только с локальными учетными записями пользователей и не работать с учетными записями домена.
Чтобы получить отпечаток сертификата, используйте Get-Item
команду или Get-ChildItem
команду на диске PowerShell Cert:
.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ComputerName
Указывает компьютер, на котором хранится отключенный сеанс. Сеансы хранятся на компьютере, который находится на стороне сервера или в конце соединения. По умолчанию это локальный компьютер.
Введите имя NetBIOS, IP-адрес или полное доменное имя (FQDN) одного компьютера.
Подстановочные знаки не допускаются. Чтобы указать локальный компьютер, введите имя компьютера, точку (.
), $env:COMPUTERNAME
или localhost.
Type: | String |
Aliases: | Cn |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ConfigurationName
Указывает имя конфигурации сеанса. Этот командлет подключается только к сеансам, используюющим указанную конфигурацию сеанса.
Введите имя конфигурации или полное имя ресурса (URI) для конфигурации сеанса. Если указать только имя конфигурации, добавляется следующая схема URI:
http://schemas.microsoft.com/powershell
.
Имя конфигурации сеанса хранится в свойстве сеанса ConfigurationName.
Значение параметра используется для выбора и фильтрации сеансов. Он не изменяет конфигурацию сеанса, которую использует сеанс.
Дополнительные сведения о конфигурациях сеансов см. в разделе about_Session_Configurations.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Запрос подтверждения перед выполнением командлета.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionUri
Указывает универсальный код ресурса (URI), определяющий конечную точку подключения, которая используется для повторного подключения к отключенном сеансу.
Значение URI должно быть указано полностью. Формат строки выглядит следующим образом:
<Transport>://<ComputerName>:<Port>/<ApplicationName>
Значение по умолчанию определяется следующим образом.
http://localhost:5985/WSMAN
Если не указать универсальный код ресурса (URI) подключения, можно использовать параметры UseSSL, ComputerName, Port и ApplicationName , чтобы указать значения URI подключения.
Допустимые значения для сегмента Transport идентификатора URI: HTTP и HTTPS. Если указать URI подключения с сегментом транспорта, но не указать порт, сеанс создается со стандартными портами: 80 для HTTP и 443 для HTTPS. Чтобы использовать порты по умолчанию для удаленного взаимодействия PowerShell, укажите порт 5985 для HTTP или 5986 для HTTPS.
Если конечный компьютер перенаправляет подключение к другому URI, PowerShell запрещает перенаправление, если в команде не используется параметр AllowRedirection .
Type: | Uri |
Aliases: | URI, CU |
Position: | 0 |
Default value: | http://localhost:5985/WSMAN |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Credential
Указывает учетную запись пользователя с разрешением на подключение к отсоединенному сеансу. По умолчанию используется текущий пользователь.
Введите имя пользователя, например User01 или Domain01\User01, или введите объект PSCredential , созданный командлетом Get-Credential
. Если ввести имя пользователя, вам будет предложено ввести пароль.
Учетные данные хранятся в объекте PSCredential , а пароль хранится как SecureString.
Примечание
Дополнительные сведения о защите данных SecureString см. в разделе "Защита SecureString"?.
Type: | PSCredential |
Position: | Named |
Default value: | Current user |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
Указывает идентификатор отключенного сеанса. Параметр Id работает только в том случае, если ранее отключенный сеанс был подключен к текущему сеансу.
Этот параметр действителен, но не действует, если сеанс хранится на локальном компьютере, но не был подключен к текущему сеансу.
Type: | Int32 |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InstanceId
Указывает идентификатор экземпляра отключенного сеанса. Идентификатор экземпляра — это GUID, который однозначно идентифицирует PSSession на локальном или удаленном компьютере. Идентификатор экземпляра хранится в свойстве InstanceIDPSSession.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JobName
Задает понятное имя для возвращаемого Receive-PSSession
задания.
Receive-PSSession
возвращает задание, если параметр OutTarget имеет значение Job или задание, которое выполняется в отключенном сеансе, было запущено в текущем сеансе.
Если задание, выполняемое в отключенном сеансе, было запущено в текущем сеансе, PowerShell повторно использует исходный объект задания в сеансе и игнорирует значение параметра JobName .
Если задание, которое выполняется в отключенном сеансе, было запущено в другом сеансе, PowerShell создает новый объект задания. При этом используется имя по умолчанию, но его можно изменить с помощью этого параметра.
Если значение по умолчанию или явное значение параметра OutTarget не является job, команда завершается успешно, но параметр JobName не действует.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Указывает понятное имя отключенного сеанса.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OutTarget
Определяет, как возвращаются результаты сеанса. Допустимые значения для этого параметра:
- Задание. асинхронно возвращает результаты в объекте задания. С помощью параметра JobName можно указать имя задания (имя по умолчанию или новое).
- Узел. возвращает результаты из командной строки (синхронно). Если команда возобновляется или результаты состоят из большого числа объектов, ответ может быть отложен.
Значение по умолчанию параметра OutTarget — Host. Если команда, полученная в отключенном сеансе, была запущена в текущем сеансе, значение по умолчанию параметра OutTarget является формой, в которой была запущена команда. Если команда была запущена как задание, по умолчанию она возвращается как задание. В противном случае он возвращается в ведущее приложение по умолчанию.
Как правило, основная программа отображает возвращаемые объекты в командной строке без задержки, но это не всегда так.
Type: | OutTarget |
Accepted values: | Default, Host, Job |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Port
Указывает сетевой порт удаленного компьютера, используемый для повторного подключения к сеансу. Чтобы подключиться к удаленному компьютеру, он должен прослушивать порт, используемый подключением. По умолчанию используется порт 5985, который является портом WinRM для HTTP и 5986, который является портом WinRM для HTTPS.
Перед использованием альтернативного порта необходимо настроить прослушиватель WinRM на удаленном компьютере для прослушивания этого порта. Чтобы настроить прослушиватель, введите следующие две команды в командной строке PowerShell:
Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse
New-Item -Path WSMan:\Localhost\listener -Transport http -Address * -Port \<port-number\>
Не используйте параметр Port , если это не требуется. Порт, заданный в команде, применяется ко всем компьютерам или сеансам, на которых выполняется команда. Альтернативный порт может помешать выполнению команды на всех компьютерах.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Session
Указывает отключенный сеанс. Введите переменную, содержащую PSSession или команду, которая создает или получает PSSession, например Get-PSSession
команду.
Type: | PSSession |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SessionOption
Задает дополнительные параметры для сеанса. Введите объект SessionOption , например объект, создаваемый с помощью командлета New-PSSessionOption
, или хэш-таблицу, в которой ключи являются именами параметров сеанса, а значения — значениями параметров сеанса.
Значения по умолчанию для параметров определяются значением переменной $PSSessionOption
предпочтения, если она задана. В противном случае значения по умолчанию задаются параметрами, указанными в конфигурации сеанса.
Значения параметров сеанса имеют приоритет над значениями по умолчанию для сеансов, заданных в переменной $PSSessionOption
предпочтения и в конфигурации сеанса. Однако они не имеют приоритета над максимальными значениями, квотами или ограничениями, установленными в конфигурации сеанса.
Описание параметров сеанса, включающих значения по умолчанию, см. в разделе New-PSSessionOption
. Сведения о переменной предпочтения $PSSessionOption см. в разделе about_Preference_Variables. Дополнительные сведения о конфигурациях сеансов см. в разделе about_Session_Configurations.
Type: | PSSessionOption |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UseSSL
Указывает, что этот командлет использует протокол SSL для подключения к отключенным сеансам. По умолчанию SSL не используется.
WS-Management шифрует все содержимое PowerShell, передаваемое по сети. UseSSL обеспечивает дополнительную защиту за счет передачи данных по защищенному HTTPS-подключению вместо HTTP-подключения.
Если вы используете этот параметр и SSL недоступен на порте, используемом для команды, команда завершается ошибкой.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
Объекты сеанса можно передать в этот командлет, например объекты, возвращаемые командлетом Get-PSSession
.
Идентификаторы сеансов можно передать в этот командлет.
Вы можете передать идентификаторы экземпляров сеансов этого командлета.
Имена сеансов можно передать в этот командлет.
Выходные данные
System.Management.Automation.Job or PSObject
Этот командлет возвращает результаты команд, которые выполнялись в отключенном сеансе, если таковые есть. Если значение или значение по умолчанию параметра OutTarget — Job, Receive-PSSession
возвращает объект задания. В противном случае возвращаются объекты, представляющие результаты выполнения этой команды.
Примечания
Этот командлет доступен только на платформах Windows.
Receive-PSSession
возвращает результаты только из сеансов, которые были отключены. Можно отключить и повторно подключить только сеансы, подключенные или завершающиеся на компьютерах под управлением PowerShell 3.0 или более поздних версий.
Если команды, которые выполнялись в отключенном сеансе, не создавали результаты или если результаты уже были возвращены в другой сеанс, Receive-PSSession
не создает никаких выходных данных.
Режим буферизации выходных данных сеанса определяет, как команды в сеансе управляют выходными данными при отключении сеанса. Если значение параметра OutputBufferingMode сеанса — Drop и выходной буфер заполнен, команда начинает удалять выходные данные. Receive-PSSession
Не удается восстановить эти выходные данные. Дополнительные сведения о параметре режима буферизации выходных данных см. в статьях справки по командлетам New-PSSessionOption и New-PSTransportOption .
Невозможно изменить значение времени ожидания простоя PSSession при подключении к PSSession или получении результатов. Параметр Receive-PSSession
SessionOption принимает объект SessionOption, имеющий значение IdleTimeout. Однако значение IdleTimeout объекта SessionOption и значение IdleTimeout переменной $PSSessionOption
игнорируются при подключении к PSSession или получению результатов.
- Вы можете задать и изменить время ожидания простоя PSSession при создании PSSession с помощью
New-PSSession
командлетов илиInvoke-Command
командлетов, а также при отключении от PSSession. - Свойство IdleTimeoutpsSession имеет решающее значение для отключенных сеансов, так как оно определяет, как долго на удаленном компьютере поддерживается отключенный сеанс. Отключенные сеансы считаются находящимися в режиме простоя с момента их отключения, даже если в них выполняются команды.
При запуске задания в удаленном сеансе с помощью параметра AsJob командлета Invoke-Command
объект задания создается в текущем сеансе, даже если задание выполняется в удаленном сеансе. При отключении удаленного сеанса объект задания в текущем сеансе отключается от задания. Объект задания содержит все результаты, которые были возвращены ему, но не получают новые результаты из задания в отключенном сеансе.
Если другой клиент подключается к сеансу, содержаному выполняемое задание, результаты, доставленные в исходный объект задания в исходном сеансе, недоступны в только что подключенном сеансе. После повторного подключения сеанса доступны только те результаты, которые не были доставлены в исходный объект задания.
Аналогичным образом, если вы запускаете сценарий в сеансе, а затем отключаетесь от сеанса, все результаты, которые скрипт доставляет в сеанс до отключения, недоступны другому клиенту, который подключается к сеансу.
Чтобы предотвратить потерю данных в сеансах, которые планируется отключить, используйте параметр InDisconnectedSession командлета Invoke-Command
. Поскольку этот параметр запрещает возвращать результаты текущему сеансу, после повторного подключения сеанса доступны все результаты.
Вы также можете предотвратить потерю данных с помощью командлета Invoke-Command
для выполнения Start-Job
команды в удаленном сеансе. В этом случае объект задания создается в удаленном сеансе. Вы не можете использовать Receive-PSSession
командлет для получения результатов задания. Вместо этого используйте Connect-PSSession
командлет для подключения к сеансу, а затем используйте Invoke-Command
командлет для выполнения Receive-Job
команды в сеансе.
Если сеанс, содержащий запущенное задание, отключается, а затем повторно подключается, исходный объект задания повторно используется только в том случае, если задание отключено и повторно подключено к тому же сеансу, а команда для повторного подключения не указывает новое имя задания. Если сеанс повторно подключается к другому сеансу клиента или указано новое имя задания, PowerShell создает новый объект задания для нового сеанса.
При отключении PSSession состояние сеанса отключено, а доступность — Нет.
- Значение свойства State определяется текущим сеансом. Значение "Отключено" означает, что PSSession не подключен к текущему сеансу. Однако это не означает, что PSSession отключен от всех сеансов. Он может быть подключен к другому сеансу. Определить возможность подключения или повторного подключения к сеансу позволяет свойство Availability.
- Если свойство Availability имеет значение None, подключиться к сеансу можно. Значение "Занято" указывает, что вы не можете подключиться к PSSession , так как он подключен к другому сеансу.
- Дополнительные сведения о значениях свойства State сеансов см. в разделе RunspaceState.
- Дополнительные сведения о значениях свойства availability сеансов см. в разделе RunspaceAvailability.