Get-PSSession

Синтаксис

Get-PSSession
   [-Name <String[]>]
   [<CommonParameters>]

Get-PSSession
   [-ComputerName] <String[]>
   [-ApplicationName <String>]
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-Port <Int32>]
   [-UseSSL]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ComputerName] <String[]>
   [-ApplicationName <String>]
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-Port <Int32>]
   [-UseSSL]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConnectionUri] <Uri[]>
   [-ConfigurationName <String>]
   [-AllowRedirection]
   [-Name <String[]>]
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConnectionUri] <Uri[]>
   [-ConfigurationName <String>]
   [-AllowRedirection]
   -InstanceId <Guid[]>
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -VMName <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -ContainerId <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -ContainerId <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -VMId <Guid[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -VMId <Guid[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -VMName <String[]>
   [<CommonParameters>]

Get-PSSession
   [-InstanceId <Guid[]>]
   [<CommonParameters>]

Get-PSSession
   [-Id] <Int32[]>
   [<CommonParameters>]

Описание

Командлет Get-PSSession получает сеансы PowerShell, управляемые пользователем (PSSessions) на локальных и удаленных компьютерах.

Начиная с Windows PowerShell 3.0 сеансы хранятся на компьютерах в удаленном конце каждого подключения. Параметры ComputerName или ConnectionUri Get-PSSession можно использовать для получения сеансов, которые подключаются к локальному компьютеру или удаленным компьютерам, даже если они не были созданы в текущем сеансе.

Без параметров Get-PSSession получает все сеансы, созданные в текущем сеансе.

Используйте параметры фильтрации, включая name, ID, InstanceID, State, ApplicationName и ConfigurationName, чтобы выбрать один из возвращающих Get-PSSession сеансов.

Используйте оставшиеся параметры для настройки временного подключения, в котором Get-PSSession выполняется команда при использовании параметров ComputerName или ConnectionUri .

Дополнительные сведения о сеансах PowerShell см. в about_PSSessions.

Примеры

Пример 1. Получение сеансов, созданных в текущем сеансе

Get-PSSession

Эта команда получает все psSessions , созданные в текущем сеансе. Он не получает psSessions , созданные в других сеансах или на других компьютерах, даже если они подключаются к этому компьютеру.

Пример 2. Получение сеансов, подключенных к локальному компьютеру

Get-PSSession -ComputerName "localhost"

Эта команда получает psSessions , подключенные к локальному компьютеру. Чтобы указать локальный компьютер, введите имя компьютера, localhost или точку (.)

Эта команда возвращает все сеансы на локальном компьютере, даже если они были созданы в других сеансах или на других компьютерах.

Пример 3. Получение сеансов, подключенных к компьютеру

Get-PSSession -ComputerName "Server02"

Id Name            ComputerName    State         ConfigurationName     Availability
 -- ----            ------------    -----         -----------------     ------------
  2 Session3        Server02       Disconnected  ITTasks                       Busy
  1 ScheduledJobs   Server02       Opened        Microsoft.PowerShell     Available
  3 Test            Server02       Disconnected  Microsoft.PowerShell          Busy

Эта команда получает psSessions , подключенные к компьютеру Server02.

Эта команда возвращает все сеансы на компьютере Server02, даже если они были созданы в других сеансах или на других компьютерах.

Выходные данные показывают, что два сеанса имеют Disconnected состояние и Busy доступность. Они были созданы в различных сеансах и в настоящее время используются. Сеанс ScheduledJobs , который является Opened и Availableбыл создан в текущем сеансе.

Пример 4. Сохранение результатов этой команды

New-PSSession -ComputerName Server01, Server02, Server03
$s1, $s2, $s3 = Get-PSSession

В этом примере показано, как сохранить результаты Get-PSSession команды в нескольких переменных.

Первая команда использует New-PSSession командлет для создания PSSessions на трех удаленных компьютерах.

Вторая команда использует Get-PSSession командлет для получения трех PSSessions. Затем он сохраняет каждую из PSSessions в отдельной переменной.

Когда PowerShell назначает массив объектов массиву переменных, он назначает первый объект первой переменной, второй объект второй переменной второй переменной и т. д. Если объектов больше, чем переменных, все оставшиеся объекты назначаются последней переменной в массиве. Если переменных больше, чем объектов, дополнительные переменные не используются.

Пример 5. Удаление сеанса с помощью идентификатора экземпляра

Get-PSSession | Format-Table -Property ComputerName, InstanceID
$s = Get-PSSession -InstanceID a786be29-a6bb-40da-80fb-782c67f7db0f
Remove-PSSession -Session $s

В этом примере показано, как получить PSSession с помощью его идентификатора экземпляра, а затем удалить PSSession.

Первая команда получает все psSessions , созданные в текущем сеансе. Он отправляет psSessions в командлет, который отображает свойства ComputerName и InstanceID каждого PSSession.Format-Table

Вторая команда использует Get-PSSession командлет для получения определенного psSession и сохранения его в переменной $s . Команда использует параметр InstanceID для идентификации PSSession.

Третья команда использует командлет Remove-PSSession для удаления PSSession в переменной $s .

Пример 6. Получение сеанса с определенным именем

Команды в этом примере находят сеанс, имя которого имеет определенный формат, использует конфигурацию сеанса и затем подключается к сеансу. С помощью подобной команды можно найти сеанс, в котором коллега запустил задачу, и подключиться к нему для завершения задачи.

Get-PSSession -ComputerName Server02, Server12 -Name BackupJob* -ConfigurationName ITTasks -SessionOption @{OperationTimeout=240000}

Id Name            ComputerName    State         ConfigurationName     Availability
 -- ----            ------------    -----         -----------------     ------------
  3 BackupJob04     Server02        Disconnected        ITTasks                  None

$s = Get-PSSession -ComputerName Server02 -Name BackupJob04 -ConfigurationName ITTasks | Connect-PSSession
$s

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 5 BackupJob04     Server02        Opened        ITTasks                  Available

Первая команда получает сеансы на удаленных компьютерах Server02 и Server12 с именами, начинающимися с BackupJob конфигурации сеанса ITTasks . Команда использует параметр Name для указания шаблона имени и параметра ConfigurationName для указания конфигурации сеанса. Значение параметра SessionOption — это хэш-таблица, которая задает значение OperationTimeout в 240000 миллисекундах (4 минуты). Этот параметр дает команде больше времени для завершения. Параметры ConfigurationName и SessionOption используются для настройки временных сеансов, в которых Get-PSSession командлет выполняется на каждом компьютере. Выходные данные показывают, что команда возвращает BackupJob04 сеанс. Сеанс отключен, а доступность None— это означает, что он не используется.

Вторая команда использует Get-PSSession командлет для получения BackupJob04 сеанса и Connect-PSSession командлета для подключения к сеансу. Сеанс сохраняется в переменную $s.

Третья команда получает сеанс в переменной $s . В выходных данных показано, что команда выполнена Connect-PSSession успешно. Сеанс находится в открытом состоянии и доступен для использования.

Пример 7. Получение сеанса с помощью его идентификатора

Get-PSSession -Id 2

Эта команда получает PSSession с идентификатором2. Так как значение свойства ID уникально только в текущем сеансе, параметр Id действителен только для локальных команд.

Параметры

-AllowRedirection

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConfigurationName

-ConnectionUri

-ContainerId

-Credential

-Id

-InstanceId

-Name

-Port

-SessionOption

-State

-ThrottleLimit

-UseSSL

-VMId

-VMName

Входные данные

None

Невозможно передать объекты в этот командлет.

Выходные данные

PSSession

Примечания

PowerShell включает следующие псевдонимы для Get-PSSession:

• Для всех платформ.

  • gsn

• Этот командлет получает управляемые пользователем объекты PSSession, такие как созданные с помощью New-PSSessionEnter-PSSessionкомандлетов и Invoke-Command командлетов. При запуске PowerShell он не получает сеанс, управляемый системой.

• Начиная с Windows PowerShell 3.0 объекты PSSession хранятся на компьютере, который находится на стороне сервера или в конце подключения. Чтобы получить сеансы, хранящиеся на локальном компьютере или удаленном компьютере, PowerShell устанавливает временный сеанс на указанный компьютер и выполняет команды запросов в сеансе.

• Чтобы получить сеансы, которые подключаются к удаленному компьютеру, используйте параметры ComputerName или ConnectionUri , чтобы указать удаленный компьютер. Чтобы отфильтровать сеансы, Get-PSSession используйте параметры Name, ID, InstanceID и State. Используйте оставшиеся параметры для настройки временного сеанса, который Get-PSSession используется.

• При использовании параметров Get-PSSession ComputerName или ConnectionUri получает только сеансы с компьютеров под управлением Windows PowerShell 3.0 и более поздних версий PowerShell.

• Значение свойства State psSession относительно текущего сеанса. Таким образом, значение "Отключено " означает, что PSSession не подключен к текущему сеансу. Однако это не означает, что PSSession отключен от всех сеансов. Он может быть подключен к другому сеансу. Чтобы определить, можно ли подключить или повторно подключиться к PSSession из текущего сеанса, используйте свойство Availability .

Значение доступности None указывает, что вы можете подключиться к сеансу. Значение "Занято " указывает, что вы не можете подключиться к PSSession , так как он подключен к другому сеансу.

Дополнительные сведения о значениях свойства State сеансов см. в разделе "Перечисление RunspaceState".

Дополнительные сведения о значениях свойства доступности сеансов см. в разделе "Перечисление RunspaceAvailability".

Связанные ссылки

• Connect-PSSession
• Disconnect-PSSession
• Receive-PSSession
• Enter-PSSession
• Exit-PSSession;
• Invoke-Command
• New-PSSession
• Remove-PSSession
• about_PSSessions
• about_Remote