Invoke-Command

Модуль:

Microsoft.PowerShell.Core

Выполняет команды на локальных и удаленных компьютерах.

Синтаксис

Invoke-Command
      [-ScriptBlock] <ScriptBlock>
      [-NoNewScope]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [[-Session] <PSSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <String>]
      [-FilePath] <String>
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [[-Session] <PSSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <String>]
      [-ScriptBlock] <ScriptBlock>
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [[-ComputerName] <String[]>]
      [-Credential <PSCredential>]
      [-Port <Int32>]
      [-UseSSL]
      [-ConfigurationName <String>]
      [-ApplicationName <String>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-InDisconnectedSession]
      [-SessionName <String[]>]
      [-HideComputerName]
      [-JobName <String>]
      [-ScriptBlock] <ScriptBlock>
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [-CertificateThumbprint <String>]
      [<CommonParameters>]

Invoke-Command
      [[-ComputerName] <String[]>]
      [-Credential <PSCredential>]
      [-Port <Int32>]
      [-UseSSL]
      [-ConfigurationName <String>]
      [-ApplicationName <String>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-InDisconnectedSession]
      [-SessionName <String[]>]
      [-HideComputerName]
      [-JobName <String>]
      [-FilePath] <String>
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-Credential <PSCredential>]
      [-ConfigurationName <String>]
      [-ThrottleLimit <Int32>]
      [[-ConnectionUri] <Uri[]>]
      [-AsJob]
      [-InDisconnectedSession]
      [-HideComputerName]
      [-JobName <String>]
      [-ScriptBlock] <ScriptBlock>
      [-AllowRedirection]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [-CertificateThumbprint <String>]
      [<CommonParameters>]

Invoke-Command
      [-Credential <PSCredential>]
      [-ConfigurationName <String>]
      [-ThrottleLimit <Int32>]
      [[-ConnectionUri] <Uri[]>]
      [-AsJob]
      [-InDisconnectedSession]
      [-HideComputerName]
      [-JobName <String>]
      [-FilePath] <String>
      [-AllowRedirection]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      -Credential <PSCredential>
      [-ConfigurationName <String>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-HideComputerName]
      [-ScriptBlock] <ScriptBlock>
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [-VMId] <Guid[]>
      [<CommonParameters>]

Invoke-Command
      -Credential <PSCredential>
      [-ConfigurationName <String>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-HideComputerName]
      [-ScriptBlock] <ScriptBlock>
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      -VMName <String[]>
      [<CommonParameters>]

Invoke-Command
      -Credential <PSCredential>
      [-ConfigurationName <String>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-HideComputerName]
      [-FilePath] <String>
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [-VMId] <Guid[]>
      [<CommonParameters>]

Invoke-Command
      -Credential <PSCredential>
      [-ConfigurationName <String>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-HideComputerName]
      [-FilePath] <String>
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      -VMName <String[]>
      [<CommonParameters>]

Invoke-Command
      [-Port <Int32>]
      [-AsJob]
      [-HideComputerName]
      -ScriptBlock <ScriptBlock>
      -HostName <String[]>
      [-UserName <String>]
      [-KeyFilePath <String>]
      [-SSHTransport]
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [-Subsystem <String>]
      [<CommonParameters>]

Invoke-Command
      [-ConfigurationName <String>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <String>]
      [-ScriptBlock] <ScriptBlock>
      [-RunAsAdministrator]
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      -ContainerId <String[]>
      [<CommonParameters>]

Invoke-Command
      [-ConfigurationName <String>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <String>]
      [-FilePath] <String>
      [-RunAsAdministrator]
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      -ContainerId <String[]>
      [<CommonParameters>]

Invoke-Command
      [-AsJob]
      [-HideComputerName]
      -ScriptBlock <ScriptBlock>
      -SSHConnection <Hashtable[]>
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-AsJob]
      [-HideComputerName]
      -FilePath <String>
      -HostName <String[]>
      [-UserName <String>]
      [-KeyFilePath <String>]
      [-SSHTransport]
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-AsJob]
      [-HideComputerName]
      -FilePath <String>
      -SSHConnection <Hashtable[]>
      [-RemoteDebug]
      [-InputObject <PSObject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Описание

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

Чтобы выполнить одну команду на удаленном компьютере, используйте параметр ComputerName. Чтобы выполнить ряд связанных команд, которые совместно используют данные, используйте командлет New-PSSession для создания PSSession (постоянное подключение) на удаленном компьютере, а затем используйте параметр сеансаInvoke-Command для выполнения команды в PSSession. Чтобы выполнить команду в отключенном сеансе, используйте параметр InDisconnectedSession. Чтобы выполнить команду в фоновом задании, используйте параметр AsJob.

Вы также можете использовать Invoke-Command на локальном компьютере для блока скриптов в качестве команды. PowerShell запускает блок скрипта сразу же в дочерней области текущей области.

Прежде чем использовать Invoke-Command для выполнения команд на удаленном компьютере, прочитайте about_Remote.

Начиная с PowerShell 6.0, вы можете использовать Secure Shell (SSH) для установления подключения и вызова команд на удаленных компьютерах. SSH необходимо установить на локальном компьютере, а удаленный компьютер должен быть настроен с конечной точкой PowerShell SSH. Преимущество удаленного сеанса PowerShell на основе SSH заключается в том, что он работает на нескольких платформах (Windows, Linux, macOS). Для сеанса на основе SSH используются параметры HostName или SSHConnection для указания удаленного компьютера и соответствующих сведений о подключении. Дополнительные сведения о настройке удаленного взаимодействия PowerShell SSH см. в статье Удаленное взаимодействие PowerShell по протоколу SSH.

Некоторые примеры кода используют сложение для уменьшения длины строки. Дополнительные сведения см. в about_Splatting.

Примеры

Пример 1. Запуск скрипта на сервере

В этом примере выполняется скрипт Test.ps1 на компьютере Server01.

Invoke-Command -FilePath c:\scripts\test.ps1 -ComputerName Server01

Параметр FilePath указывает скрипт, расположенный на локальном компьютере. Скрипт выполняется на удаленном компьютере и результаты возвращаются на локальный компьютер.

Пример 2. Выполнение команды на удаленном сервере

В этом примере выполняется команда Get-Culture на удаленном компьютере Server01.

Invoke-Command -ComputerName Server01 -Credential Domain01\User01 -ScriptBlock { Get-Culture }

Параметр ComputerName указывает имя удаленного компьютера. Параметр Credential используется для выполнения команды в контексте безопасности Domain01\User01, пользователя, имеющего разрешение на выполнение команд. Параметр scriptBlock указывает команду, выполняемую на удаленном компьютере.

В ответ PowerShell запрашивает пароль и метод проверки подлинности для учетной записи User01. Затем она запускает команду на компьютере Server01 и возвращает результат.

Пример 3. Выполнение команды в постоянном подключении

В этом примере выполняется та же команда Get-Culture в сеансе с использованием постоянного подключения на удаленном компьютере с именем Server02.

$s = New-PSSession -ComputerName Server02 -Credential Domain01\User01
Invoke-Command -Session $s -ScriptBlock {Get-Culture}

Командлет New-PSSession создает сеанс на удаленном компьютере Server02 и сохраняет его в переменной $s. Как правило, сеанс создается только при выполнении ряда команд на удаленном компьютере.

Командлет Invoke-Command выполняет команду Get-Culture на Server02. Параметр сеанса указывает сеанс, сохраненный в переменной .

В ответ PowerShell запускает команду в сеансе на компьютере Server02.

Пример 4. Использование сеанса для выполнения ряда команд, совместно использующих данные

В этом примере сравниваются эффекты использования computerName и сеанса параметров . В нем показано, как использовать сеанс для выполнения ряда команд, которые используют одни и те же данные.

Invoke-Command -ComputerName Server02 -ScriptBlock {$p = Get-Process PowerShell}
Invoke-Command -ComputerName Server02 -ScriptBlock {$p.VirtualMemorySize}
$s = New-PSSession -ComputerName Server02
Invoke-Command -Session $s -ScriptBlock {$p = Get-Process PowerShell}
Invoke-Command -Session $s -ScriptBlock {$p.VirtualMemorySize}

17930240

Первые две команды используют параметр computerName ComputerName для выполнения команд на удаленном компьютере Server02. Первая команда использует командлет Get-Process для получения процесса PowerShell на удаленном компьютере и сохранения его в переменной $p. Вторая команда получает значение свойства VirtualMemorySize процесса PowerShell.

При использовании параметра ComputerName PowerShell создает новый сеанс для выполнения команды. Сеанс закрывается после завершения команды. Переменная $p была создана в одном соединении, но она не существует в соединении, созданном для второй команды.

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

Командлет New-PSSession создает постоянный сеанс на компьютере Server02 и сохраняет сеанс в переменной $s. Строки Invoke-Command, следующие за сеансом, используют параметр сеанса для выполнения обеих команд в одном сеансе. Так как обе команды выполняются в одном сеансе, значение $p остается активным.

Пример 5. Введите команду, хранящуюся в локальной переменной

В этом примере показано, как создать команду, которая хранится в виде блока скрипта в локальной переменной. Если блок скрипта сохраняется в локальной переменной, можно указать переменную в качестве значения параметра ScriptBlock.

$command = { Get-WinEvent -LogName PowerShellCore/Operational |
  Where-Object {$_.Message -like "*certificate*"} }
Invoke-Command -ComputerName S1, S2 -ScriptBlock $command

Переменная $command сохраняет команду Get-WinEvent, отформатированную как блок скрипта. Invoke-Command выполняет команду, хранящуюся в $command на удаленных компьютерах S1 и S2.

Пример 6. Выполнение одной команды на нескольких компьютерах

В этом примере показано, как использовать Invoke-Command для выполнения одной команды на нескольких компьютерах.

$parameters = @{
  ComputerName = "Server01", "Server02", "TST-0143", "localhost"
  ConfigurationName = 'MySession.PowerShell'
  ScriptBlock = { Get-WinEvent -LogName PowerShellCore/Operational }
}
Invoke-Command @parameters

Параметр computerName указывает разделенный запятыми список имен компьютеров. Список компьютеров включает значение localhost, представляющее локальный компьютер. Параметр ConfigurationName указывает альтернативную конфигурацию сеанса. Параметр ScriptBlock запускает Get-WinEvent для получения журналов событий PowerShellCore или Operations с каждого компьютера.

Пример 7. Получение версии хост-программы на нескольких компьютерах

В этом примере получается версия хост-программы PowerShell, работающей на удаленных компьютерах 200.

$version = Invoke-Command -ComputerName (Get-Content Machines.txt) -ScriptBlock {(Get-Host).Version}

Так как выполняется только одна команда, вам не нужно создавать постоянные подключения к каждому из компьютеров. Вместо этого команда использует параметр ComputerName для указания компьютеров. Чтобы указать компьютеры, он использует командлет Get-Content для получения содержимого файла Machine.txt, файла имен компьютеров.

Командлет Invoke-Command выполняет команду Get-Host на удаленных компьютерах. Он использует нотацию точек для получения свойства версии узла PowerShell.

Эти команды выполняются по одному за раз. По завершении команд выходные данные команд со всех компьютеров сохраняются в переменной $version. Выходные данные включают имя компьютера, из которого были получены данные.

Пример 8. Запуск фонового задания на нескольких удаленных компьютерах

В этом примере выполняется команда на двух удаленных компьютерах. Команда Invoke-Command использует параметр AsJob, чтобы команда выполнялось в качестве фонового задания. Команды выполняются на удаленных компьютерах, но задание существует на локальном компьютере. Результаты передаются на локальный компьютер.

$s = New-PSSession -ComputerName Server01, Server02
Invoke-Command -Session $s -ScriptBlock {Get-EventLog system} -AsJob

Id   Name    State      HasMoreData   Location           Command
---  ----    -----      -----         -----------        ---------------
1    Job1    Running    True          Server01,Server02  Get-EventLog system

$j = Get-Job
$j | Format-List -Property *

HasMoreData   : True
StatusMessage :
Location      : Server01,Server02
Command       : Get-EventLog system
JobStateInfo  : Running
Finished      : System.Threading.ManualResetEvent
InstanceId    : e124bb59-8cb2-498b-a0d2-2e07d4e030ca
Id            : 1
Name          : Job1
ChildJobs     : {Job2, Job3}
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
StateChanged  :

$results = $j | Receive-Job

Командлет New-PSSession создает сеансы на удаленных компьютерах Server01 и Server02. Командлет Invoke-Command запускает фоновое задание в каждом сеансе. Команда использует параметр AsJob для выполнения команды в качестве фонового задания. Эта команда возвращает объект задания, содержащий два дочерних объекта задания, по одному для каждого задания, выполняемого на двух удаленных компьютерах.

Команда Get-Job сохраняет объект задания в переменной $j. Затем переменная $j будет передана командлету Format-List для отображения всех свойств объекта задания в списке. Последняя команда получает результаты заданий. Он передает объект задания в $j командлету Receive-Job и сохраняет результаты в переменной $results.

Пример 9. Включение локальных переменных в команду, выполняемой на удаленном компьютере

В этом примере показано, как включить значения локальных переменных в команду, выполняемую на удаленном компьютере. Команда использует модификатор области Using для идентификации локальной переменной в удаленной команде. По умолчанию предполагается, что все переменные определяются в удаленном сеансе. Модификатор Using области появился в PowerShell 3.0. Дополнительные сведения об модификаторе области Using см. в about_Remote_Variables и about_Scopes.

$Log = "PowerShellCore/Operational"
Invoke-Command -ComputerName Server01 -ScriptBlock {Get-WinEvent -LogName $Using:Log -MaxEvents 10}

Переменная $Log сохраняет имя журнала событий PowerShellCore или Operational. Командлет Invoke-Command запускается Get-WinEvent на Сервере Server01, чтобы получить десять последних событий из журнала событий. Значение параметра logName — это переменная , префиксированная модификатором области , чтобы указать, что он был создан в локальном сеансе, а не в удаленном сеансе.

Пример 10. Скрытие имени компьютера

В этом примере показан эффект использования параметра HideComputerNameInvoke-Command. HideComputerName не изменяет объект, возвращаемый этим командлетом. Он изменяет только дисплей. Командлеты формата по-прежнему можно использовать для отображения свойства PsComputerName любого из затронутых объектов.

Invoke-Command -ComputerName S1, S2 -ScriptBlock {Get-Process PowerShell}

PSComputerName    Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id   ProcessName
--------------    -------  ------    -----      ----- -----   ------     --   -----------
S1                575      15        45100      40988   200     4.68     1392 PowerShell
S2                777      14        35100      30988   150     3.68     67   PowerShell

Invoke-Command -ComputerName S1, S2 -ScriptBlock {Get-Process PowerShell} -HideComputerName

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id   ProcessName
-------  ------    -----      ----- -----   ------     --   -----------
575      15        45100      40988   200     4.68     1392 PowerShell
777      14        35100      30988   150     3.68     67   PowerShell

Первые две команды используют Invoke-Command для выполнения команды Get-Process для процесса PowerShell. Выходные данные первой команды включают свойство PsComputerName, содержащее имя компьютера, на котором выполнялась команда. Выходные данные второй команды, которая использует HideComputerName, не включает столбец psComputerName PsComputerName.

Пример 11. Использование ключевого слова Param в блоке скрипта

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

Дополнительные сведения о ключевом слове Param см. в about_Language_Keywords.

$parameters = @{
    ComputerName = "Server01"
    ScriptBlock = { Param ($param1,$param2) Get-ChildItem -Name $param1 -Include $param2 }
    ArgumentList = "a*", "*.pdf"
}
Invoke-Command @parameters

aa.pdf
ab.pdf
ac.pdf
az.pdf

Invoke-Command использует параметр ScriptBlock, определяющий две переменные, $param1 и $param2. Get-ChildItem использует именованные параметры, Name и Include с именами переменных. ArgumentList передает значения переменным.

Пример 12. Использование автоматической переменной $args в блоке скрипта

Автоматическая переменная $args и параметр ArgumentList используются для передачи значений массива в позиции параметров в блоке скрипта. В этом примере отображается содержимое каталога сервера .txt файлов. Параметр Path имеет позицию 0, а параметр фильтра имеет позицию 1.

Дополнительные сведения об переменной $args см. в about_Automatic_Variables

$parameters = @{
    ComputerName = "Server01"
    ScriptBlock = { Get-ChildItem $args[0] $args[1] }
    ArgumentList = "C:\Test", "*.txt*"
}
Invoke-Command @parameters

Directory: C:\Test

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           6/12/2019    15:15            128 alog.txt
-a---           7/27/2019    15:16            256 blog.txt
-a---           9/28/2019    17:10             64 zlog.txt

использует параметр ScriptBlock , а задает значения массивов и . ArgumentList передает значения массива в позиции параметров для пути и фильтра.

Пример 13. Запуск скрипта на всех компьютерах, перечисленных в текстовом файле

В этом примере используется командлет Invoke-Command для запуска скрипта Sample.ps1 на всех компьютерах, перечисленных в файле Servers.txt. Команда использует параметр FilePath для указания файла скрипта. Эта команда позволяет запускать скрипт на удаленных компьютерах, даже если файл скрипта недоступен для удаленных компьютеров.

Invoke-Command -ComputerName (Get-Content Servers.txt) -FilePath C:\Scripts\Sample.ps1 -ArgumentList Process, Service

При отправке команды содержимое файла Sample.ps1 копируется в блок скрипта и блок скрипта выполняется на каждом из удаленных компьютеров. Эта процедура эквивалентна использованию параметра ScriptBlock для отправки содержимого скрипта.

Пример 14. Выполнение команды на удаленном компьютере с помощью URI

В этом примере показано, как выполнить команду на удаленном компьютере, определяемом универсальным идентификатором ресурса (URI). В этом примере выполняется команда Set-Mailbox на удаленном сервере Exchange.

$LiveCred = Get-Credential
$parameters = @{
  ConfigurationName = 'Microsoft.Exchange'
  ConnectionUri = 'https://ps.exchangelabs.com/PowerShell'
  Credential = $LiveCred
  Authentication = 'Basic'
  ScriptBlock = {Set-Mailbox Dan -DisplayName "Dan Park"}
}
Invoke-Command @parameters

Первая строка использует командлет Get-Credential для хранения учетных данных Windows Live ID в переменной $LiveCred. PowerShell предложит пользователю ввести учетные данные Windows Live ID.

Переменная $parameters — это хэш-таблица, содержащая параметры, передаваемые командлету Invoke-Command. Командлет запускает команду с помощью конфигурации сеанса Microsoft.Exchange. Параметр connectionURI указывает URL-адрес конечной точки сервера Exchange. Параметр учетных данных указывает учетные данные, хранящиеся в переменной . Параметр AuthenticationMechanism указывает использование базовой проверки подлинности. Параметр scriptBlock указывает блок скрипта, содержащий команду.

Пример 15. Использование параметра сеанса

В этом примере показано, как создать и использовать параметр sessionOption .

$so = New-PSSessionOption -SkipCACheck -SkipCNCheck -SkipRevocationCheck
Invoke-Command -ComputerName server01 -UseSSL -ScriptBlock { Get-HotFix } -SessionOption $so -Credential server01\user01

Командлет New-PSSessionOption создает объект параметра сеанса, который приводит к тому, что удаленный конец не проверяет центр сертификации, каноническое имя и списки отзыва при оценке входящего подключения HTTPS. Объект SessionOption сохраняется в переменной $so.

Заметка

Отключение этих проверок удобно для устранения неполадок, но, очевидно, не безопасно.

Командлет Invoke-Command выполняет команду Get-HotFix удаленно. Параметр SessionOption присваивается переменной $so.

Пример 16. Управление перенаправлением URI в удаленной команде

В этом примере показано, как использовать AllowRedirection и sessionOption параметры для управления перенаправлением URI в удаленной команде.

$max = New-PSSessionOption -MaximumRedirection 1
$parameters = @{
  ConnectionUri = "https://ps.exchangelabs.com/PowerShell"
  ScriptBlock = { Get-Mailbox dan }
  AllowRedirection = $true
  SessionOption = $max
}
Invoke-Command @parameters

Командлет New-PSSessionOption создает объект PSSessionOption, сохраненный в переменной $max. Команда использует параметр MaximumRedirection, чтобы задать для свойства MaximumConnectionRedirectionCount объекта PSSessionOp tion значение 1.

Командлет Invoke-Command выполняет команду Get-Mailbox на удаленном сервере Microsoft Exchange Server. Параметр AllowRedirection предоставляет явное разрешение на перенаправление подключения к альтернативной конечной точке. Параметр SessionOption использует объект сеанса, хранящийся в переменной $max.

В результате, если удаленный компьютер, указанный ConnectionURI возвращает сообщение перенаправления, PowerShell перенаправляет подключение, но если новое назначение возвращает другое сообщение перенаправления, значение счетчика перенаправления 1 превышается, и Invoke-Command возвращает ошибку без конца.

Пример 17. Доступ к сетевому ресурсу в удаленном сеансе

В этом примере показано, как получить доступ к сетевой папке из удаленного сеанса. Три компьютера используются для демонстрации примера. Server01 — это локальный компьютер, Server02 — это удаленный компьютер, а Net03 — это сетевой ресурс. Server01 подключается к Server02, а затем Server02 выполняет второй прыжк в Net03 для доступа к сетевой папке. Дополнительные сведения о том, как удаленное взаимодействие PowerShell поддерживает прыжки между компьютерами, см. в статье Создание второго прыжка вудаленного взаимодействия PowerShell.

Необходимое делегирование поставщика поддержки безопасности учетных данных (CredSSP) включено в параметрах клиента на локальном компьютере и в параметрах службы на удаленном компьютере. Чтобы выполнить команды в этом примере, необходимо быть членом группы администраторов на локальном компьютере и удаленном компьютере.

Enable-WSManCredSSP -Role Client -DelegateComputer Server02
$s = New-PSSession Server02
Invoke-Command -Session $s -ScriptBlock {Enable-WSManCredSSP -Role Server -Force}
$parameters = @{
  Session = $s
  ScriptBlock = { Get-Item \\Net03\Scripts\LogFiles.ps1 }
  Authentication = "CredSSP"
  Credential = "Domain01\Admin01"
}
Invoke-Command @parameters

Командлет Enable-WSManCredSSP включает делегирование CredSSP с локального компьютера Server01 на удаленный компьютер Server02. Параметр роли указывает клиентский для настройки параметра клиента CredSSP на локальном компьютере.

создает объект PSSession для Server02 и сохраняет объект в переменной .

Командлет Invoke-Command использует переменную $s для подключения к удаленному компьютеру Server02. Параметр ScriptBlock запускает Enable-WSManCredSSP на удаленном компьютере. Параметр роли указывает Server для настройки параметра сервера CredSSP на удаленном компьютере.

Переменная $parameters содержит значения параметров для подключения к сетевой общей папке. Командлет Invoke-Command выполняет команду Get-Item в сеансе в $s. Эта команда получает скрипт из общей папки \\Net03\Scripts сети. Команда использует параметр проверки подлинности со значением CredSSP и параметром Credential со значением Domain01\Admin01\Admin01.

Пример 18. Запуск скриптов на многих удаленных компьютерах

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

$parameters = @{
  ComputerName = (Get-Content -Path C:\Test\Servers.txt)
  InDisconnectedSession = $true
  FilePath = "\\Scripts\Public\ConfigInventory.ps1"
  SessionOption = @{OutputBufferingMode="Drop";IdleTimeout=43200000}
}
Invoke-Command @parameters

Команда использует Invoke-Command для запуска скрипта. Значение параметра ComputerName — это команда Get-Content, которая получает имена удаленных компьютеров из текстового файла. Параметр InDisconnectedSession отключает сеансы сразу после запуска команды. Значение параметра FilePath — это скрипт, который Invoke-Command выполняется на каждом компьютере.

Значение SessionOption — это хэш-таблица. Значение OutputBufferingMode имеет значение Drop, а для значения IdleTimeout задано значение 432000000 миллисекунд (12 часов).

Чтобы получить результаты команд и скриптов, выполняемых в отключенных сеансах, используйте командлет Receive-PSSession.

Пример 19. Выполнение команды на удаленном компьютере с помощью SSH

В этом примере показано, как выполнить команду на удаленном компьютере с помощью Secure Shell (SSH). Если SSH настроен на удаленном компьютере для запроса паролей, появится запрос на пароль. В противном случае необходимо использовать проверку подлинности пользователя на основе ключа SSH.

Invoke-Command -HostName UserA@LinuxServer01 -ScriptBlock { Get-MailBox * }

Пример 20. Выполните команду на удаленном компьютере с помощью SSH и укажите ключ проверки подлинности пользователя

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

Invoke-Command -HostName UserA@LinuxServer01 -ScriptBlock { Get-MailBox * } -KeyFilePath /UserA/UserAKey_rsa

Пример 21. Запуск файла скрипта на нескольких удаленных компьютерах с помощью SSH в качестве задания

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

$sshConnections =
@{ HostName="WinServer1"; UserName="Domain\UserA"; KeyFilePath="C:\Users\UserA\id_rsa" },
@{ HostName="UserB@LinuxServer5"; KeyFilePath="/Users/UserB/id_rsa" }
$results = Invoke-Command -FilePath c:\Scripts\CollectEvents.ps1 -SSHConnection $sshConnections

Параметры

-AllowRedirection

Разрешает перенаправление этого подключения к альтернативному универсальному идентификатору ресурса (URI).

При использовании параметра ConnectionURI удаленный целевой объект может вернуть инструкцию для перенаправления в другой универсальный код ресурса (URI). По умолчанию PowerShell не перенаправляет подключения, но этот параметр можно использовать для перенаправления подключения.

Можно также ограничить количество перенаправлений подключения, изменив значение параметра сеанса MaximumConnectionRedirectionCount сеанса. Используйте параметр MaximumRedirection командлета New-PSSessionOption или задайте свойство MaximumConnectionRedirectionCount переменной предпочтения $PSSessionOption. Значение по умолчанию — 5.

Тип:	SwitchParameter
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ApplicationName

Указывает сегмент имени приложения URI подключения. Используйте этот параметр, чтобы указать имя приложения, если в команде не используется параметр ConnectionURI.

Значение по умолчанию — это значение переменной $PSSessionApplicationName предпочтения на локальном компьютере. Если эта переменная предпочтения не определена, значение по умолчанию — WSMAN. Это значение подходит для большинства использования. Дополнительные сведения см. в about_Preference_Variables.

Служба WinRM использует имя приложения для выбора прослушивателя для обслуживания запроса на подключение. Значение этого параметра должно совпадать со значением свойства URLPrefix прослушивателя на удаленном компьютере.

Тип:	String
Position:	Named
Default value:	$PSSessionApplicationName if set on the local computer, otherwise WSMAN
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ArgumentList

Предоставляет значения локальных переменных в команде. Переменные команды заменяются этими значениями перед выполнением команды на удаленном компьютере. Введите значения в разделенном запятыми списке. Значения связаны с переменными в порядке их перечисления. Псевдоним для ArgumentList — Args.

Значения в параметре ArgumentList могут быть фактическими значениями, такими как 1024, или ссылаться на локальные переменные, например $max.

Чтобы использовать локальные переменные в команде, используйте следующий формат команды:

{param($<name1>[, $<name2>]...) <command-with-local-variables>} -ArgumentList <value> -или- <local-variable>

Ключевое слово param содержит локальные переменные, используемые в команде. ArgumentList предоставляет значения переменных в порядке их перечисления. Дополнительные сведения о поведении ArgumentList см. в about_Splatting.

Тип:	Object[]
Aliases:	Args
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-AsJob

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

При использовании параметра AsJob команда возвращает объект, представляющий задание, а затем отображает командную строку. Вы можете продолжать работать в сеансе, пока задание завершится. Чтобы управлять заданием, используйте командлеты *-Job. Чтобы получить результаты задания, используйте командлет Receive-Job.

Параметр AsJob похож на использование командлета Invoke-Command для удаленного выполнения командлета Start-Job. Однако при использовании AsJobзадание создается на локальном компьютере, даже если задание выполняется на удаленном компьютере. Результаты удаленного задания автоматически возвращаются на локальный компьютер.

Дополнительные сведения о фоновых заданиях PowerShell см. в about_Jobs и about_Remote_Jobs.

Тип:	SwitchParameter
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Authentication

Указывает механизм, используемый для проверки подлинности учетных данных пользователя. Проверка подлинности CredSSP доступна только в Windows Vista, Windows Server 2008 и более поздних версиях операционной системы Windows.

Допустимые значения для этого параметра приведены следующим образом:

• По умолчанию
• Основной
• Credssp
• Переваривать
• Kerberos
• Вести переговоры
• NegotiateWithImplicitCredential

Значение по умолчанию — Default.

Дополнительные сведения о значениях этого параметра см. вперечисления AuthenticationMechanism.

Осторожность

Проверка подлинности поставщика поддержки безопасности учетных данных (CredSSP), при которой учетные данные пользователя передаются на удаленный компьютер, который будет проходить проверку подлинности, предназначен для команд, требующих проверки подлинности на нескольких ресурсах, таких как доступ к удаленному сетевому ресурсу. Этот механизм повышает риск безопасности удаленной операции. Если удаленный компьютер скомпрометирован, учетные данные, передаваемые ему, можно использовать для управления сетевым сеансом. Дополнительные сведения см. в разделе поставщик поддержки безопасности учетных данных.

Тип:	AuthenticationMechanism
Допустимые значения:	Basic, Default, Credssp, Digest, Kerberos, Negotiate, NegotiateWithImplicitCredential
Position:	Named
Default value:	Default
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-CertificateThumbprint

Указывает сертификат цифрового открытого ключа (X509) учетной записи пользователя, которая имеет разрешение на подключение к отключенном сеансу. Введите отпечаток сертификата.

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

Чтобы получить отпечаток сертификата, используйте команду Get-Item или Get-ChildItem на диске PowerShell Cert.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ComputerName

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

При использовании параметра ComputerName PowerShell создает временное соединение, которое используется только для выполнения указанной команды и затем закрывается. Если требуется постоянное подключение, используйте параметр сеанса.

Введите имя NETBIOS, IP-адрес или полное доменное имя одного или нескольких компьютеров в списке, разделенном запятыми. Чтобы указать локальный компьютер, введите имя компьютера, localhost или точку (.).

Чтобы использовать IP-адрес в значении ComputerName, команда должна включать параметр учетных данных . Компьютер должен быть настроен для транспорта HTTPS или IP-адреса удаленного компьютера должен быть включен в список TrustedHost s локального компьютера. Инструкции по добавлению имени компьютера в список TrustedHosts см. в разделе Добавление компьютера в список доверенных узлов.

В Windows Vista и более поздних версиях операционной системы Windows для включения локального компьютера в значение ComputerNameнеобходимо запустить PowerShell с помощью параметра запуска от имени администратора.

Тип:	String[]
Aliases:	Cn
Position:	0
Default value:	Local computer
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ConfigurationName

Указывает конфигурацию сеанса, используемую для нового PSSession.

Введите имя конфигурации или полный URI ресурса для конфигурации сеанса. Если указать только имя конфигурации, предопределен следующий URI схемы: https://schemas.microsoft.com/PowerShell.

При использовании с SSH этот параметр указывает подсистему, используемую в целевом объекте, как определено в sshd_config. Значение по умолчанию для SSH — это подсистема powershell.

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

Значение по умолчанию — это значение переменной $PSSessionConfigurationName предпочтения на локальном компьютере. Если эта переменная предпочтения не задана, по умолчанию используется Microsoft.PowerShell. Дополнительные сведения см. в about_Preference_Variables.

Тип:	String
Position:	Named
Default value:	$PSSessionConfigurationName if set on the local computer, otherwise Microsoft.PowerShell
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ConnectionUri

Указывает универсальный идентификатор ресурса (URI), определяющий конечную точку подключения сеанса. Универсальный код ресурса (URI) должен быть полным.

Формат этой строки выглядит следующим образом:

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

Значение по умолчанию выглядит следующим образом:

https://localhost:5985/WSMAN

Если URI подключения не указан, можно использовать UseSSL и параметры порта порт, чтобы указать значения URI подключения.

Допустимые значения для сегмента транспорта URI: HTTP и HTTPS. Если указать URI подключения с сегментом транспорта, но не указать порт, сеанс создается с портами стандартов: 80 для HTTP и 443 для HTTPS. Чтобы использовать порты по умолчанию для удаленного взаимодействия PowerShell, укажите порт 5985 для HTTP или 5986 для HTTPS.

Если целевой компьютер перенаправляет подключение к другому URI, PowerShell запрещает перенаправление, если в команде не используется параметр AllowRedirection.

Тип:	Uri[]
Aliases:	URI, CU
Position:	0
Default value:	https://localhost:5985/WSMAN
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ContainerId

Задает массив идентификаторов контейнеров.

Тип:	String[]
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Credential

Указывает учетную запись пользователя, которая имеет разрешение на выполнение этого действия. По умолчанию используется текущий пользователь.

Введите имя пользователя, например User01 или Get-Credential Если ввести имя пользователя, вам будет предложено ввести пароль.

Учетные данные хранятся в объекте PSCredential , а пароль хранится как SecureString.

Заметка

Дополнительные сведения о защите данных SecureString см. в разделе "Как безопасна Защита SecureString?".

Тип:	PSCredential
Position:	Named
Default value:	Current user
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-EnableNetworkAccess

Указывает, что этот командлет добавляет интерактивный маркер безопасности в сеансы обратного цикла. Интерактивный маркер позволяет выполнять команды в сеансе обратного цикла, который получает данные с других компьютеров. Например, можно выполнить команду в сеансе, который копирует XML-файлы с удаленного компьютера на локальный компьютер.

Сеанс обратного цикла — это PSSession, которая возникает и заканчивается на том же компьютере. Чтобы создать сеанс обратного цикла, опустите параметр ComputerName или задайте для параметра dot (.), localhost или имя локального компьютера.

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

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

Вы можете разрешить удаленный доступ в сеансе обратного цикла с помощью CredSSP значение параметра проверки подлинности , который делегирует учетные данные сеанса другим компьютерам.

Чтобы защитить компьютер от вредоносного доступа, отключенные сеансы цикла с интерактивными маркерами, которые создаются с помощью EnableNetworkAccess, можно повторно подключиться только с компьютера, на котором был создан сеанс. Отключенные сеансы, использующие проверку подлинности CredSSP, можно повторно подключить с других компьютеров. Дополнительные сведения см. в разделе Disconnect-PSSession.

Этот параметр появился в PowerShell 3.0.

Тип:	SwitchParameter
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-FilePath

Указывает локальный скрипт, который этот командлет выполняется на одном или нескольких удаленных компьютерах. Введите путь и имя файла скрипта или отправьте путь к Invoke-Command. Скрипт должен существовать на локальном компьютере или в каталоге, к которому может получить доступ локальный компьютер. Используйте ArgumentList, чтобы указать значения параметров в скрипте.

При использовании этого параметра PowerShell преобразует содержимое указанного файла скрипта в блок скрипта, передает блок скрипта на удаленный компьютер и запускает его на удаленном компьютере.

Тип:	String
Aliases:	PSPath
Position:	1
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-HideComputerName

Указывает, что этот командлет пропускает имя компьютера каждого объекта из вывода. По умолчанию имя компьютера, создающего объект, отображается на экране.

Этот параметр влияет только на отображение выходных данных. Он не изменяет объект.

Тип:	SwitchParameter
Aliases:	HCN
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-HostName

Задает массив имен компьютеров для подключения на основе Secure Shell (SSH). Это похоже на параметр ComputerName, за исключением того, что подключение к удаленному компьютеру выполняется с помощью SSH, а не Windows WinRM.

Этот параметр появился в PowerShell 6.0.

Тип:	String[]
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-InDisconnectedSession

Указывает, что этот командлет выполняет команду или скрипт в отключенном сеансе.

При использовании параметра inDisconnectedSession создает постоянный сеанс на каждом удаленном компьютере, запускает команду, указанную параметром scriptBlock или FilePath, а затем отключается от сеанса. Команды продолжают выполняться в отключенных сеансах. InDisconnectedSession позволяет выполнять команды без поддержания подключения к удаленным сеансам. И, так как сеанс отключен до возврата любых результатов, InDisconnectedSession гарантирует, что все результаты команды возвращаются в повторно подключенном сеансе, а не разделены между сеансами.

Нельзя использовать InDisconnectedSession с параметром сеанса или параметром AsJob.

Команды, использующие InDisconnectedSession возвращают объект PSSession, представляющий отключенный сеанс. Они не возвращают выходные данные команды. Чтобы подключиться к отключенным сеансам, используйте командлеты Connect-PSSession или Receive-PSSession. Чтобы получить результаты команд, запущенных в сеансе, используйте командлет Receive-PSSession. Чтобы выполнить команды, которые создают выходные данные в отключенном сеансе, задайте для параметра сеанса OutputBufferingMod e значение Drop. Если вы планируете подключиться к отключенным сеансам, задайте время ожидания простоя в сеансе, чтобы обеспечить достаточное время для подключения перед удалением сеанса.

Вы можете задать режим буферизации выходных данных и время ожидания простоя в параметре SessionOption или в переменной предпочтения $PSSessionOption. Дополнительные сведения о параметрах сеанса см. в New-PSSessionOption и about_Preference_Variables.

Дополнительные сведения о функции отключенных сеансов см. в about_Remote_Disconnected_Sessions.

Этот параметр появился в PowerShell 3.0.

Тип:	SwitchParameter
Aliases:	Disconnected
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-InputObject

Задает входные данные для команды. Введите переменную, содержащую объекты или введите команду или выражение, которое получает объекты.

При использовании параметра inputObject используйте автоматическую переменную в значении параметра ScriptBlock для представления входных объектов.

Тип:	PSObject
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-JobName

Указывает понятное имя фонового задания. По умолчанию задания называются Job<n>порядковый <n> номер.

Если в команде используется параметр jobName , команда выполняется в качестве задания, а возвращает объект задания, даже если в команде нет AsJob.

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

Тип:	String
Position:	Named
Default value:	Job<n>
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-KeyFilePath

Указывает путь к файлу ключа, используемый Secure Shell (SSH) для проверки подлинности пользователя на удаленном компьютере.

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

Этот параметр появился в PowerShell 6.0.

Тип:	String
Aliases:	IdentityFilePath
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-NoNewScope

Указывает, что этот командлет выполняет указанную команду в текущей области. По умолчанию Invoke-Command выполняет команды в собственной области.

Этот параметр действителен только в командах, выполняемых в текущем сеансе, то есть команды, которые опустят параметры ComputerName и сеанса.

Этот параметр появился в PowerShell 3.0.

Тип:	SwitchParameter
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	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\>

Не используйте параметр порта , если вы не должны. Порт, заданный в команде, применяется ко всем компьютерам или сеансам, на которых выполняется команда. Альтернативный параметр порта может предотвратить выполнение команды на всех компьютерах.

Тип:	Int32
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-RemoteDebug

Используется для выполнения вызываемой команды в режиме отладки в удаленном сеансе PowerShell.

Тип:	SwitchParameter
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-RunAsAdministrator

Указывает, что этот командлет вызывает команду в качестве администратора.

Тип:	SwitchParameter
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ScriptBlock

Указывает команды для выполнения. Заключите команды в фигурные скобки { } для создания блока скрипта. Этот параметр является обязательным.

По умолчанию все переменные в команде вычисляются на удаленном компьютере. Чтобы включить локальные переменные в команду, используйте ArgumentList.

Тип:	ScriptBlock
Aliases:	Command
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Session

Задает массив сеансов, в которых этот командлет выполняет команду. Введите переменную, содержащую объекты PSSession или команду, которая создает или получает объекты PSSession, например команду или .

При создании PSSessionPowerShell устанавливает постоянное подключение к удаленному компьютеру. Используйте PSSession для выполнения ряда связанных команд, совместно использующих данные. Чтобы выполнить одну команду или серию несвязанных команд, используйте параметр ComputerName. Дополнительные сведения см. в about_PSSessions.

Тип:	PSSession[]
Position:	0
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SessionName

Указывает понятное имя для отключенного сеанса. Имя можно использовать для ссылки на сеанс в последующих командах, таких как команда Get-PSSession. Этот параметр действителен только с параметром InDisconnectedSession.

Этот параметр появился в PowerShell 3.0.

Тип:	String[]
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SessionOption

Задает дополнительные параметры сеанса. Введите объект SessionOption, например объект, создаваемый с помощью командлета New-PSSessionOption, или хэш-таблицу, в которой ключи являются именами вариантов сеанса, а значения — значениями параметров сеанса.

Значения по умолчанию для параметров определяются значением переменной предпочтения $PSSessionOption, если она задана. В противном случае значения по умолчанию устанавливаются параметрами, заданными в конфигурации сеанса.

Значения параметра сеанса имеют приоритет над значениями по умолчанию для сеансов, заданных в переменной предпочтения $PSSessionOption и в конфигурации сеанса. Однако они не имеют приоритета над максимальными значениями, квотами или ограничениями, заданными в конфигурации сеанса.

Описание параметров сеанса, включающих значения по умолчанию, см. New-PSSessionOption. Сведения о переменной $PSSessionOption предпочтения см. в about_Preference_Variables. Дополнительные сведения о конфигурациях сеансов см. в разделе about_Session_Configurations.

Тип:	PSSessionOption
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SSHConnection

Этот параметр принимает массив хэш-таблиц, где каждая хэш-таблица содержит один или несколько параметров подключения, необходимых для установления подключения Secure Shell (SSH). Параметр SSHConnection полезен для создания нескольких сеансов, в которых для каждого сеанса требуются разные сведения о подключении.

Хэш-файл содержит следующие элементы:

• ComputerName (или HostName)
• порт.
• UserName
• KeyFilePath (или IdentityFilePath)

ComputerName (или HostName) является единственной необходимой парой "ключ-значение".

Этот параметр появился в PowerShell 6.0.

Тип:	Hashtable[]
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SSHTransport

Указывает, что удаленное подключение установлено с помощью Secure Shell (SSH).

По умолчанию PowerShell использует Windows WinRM для подключения к удаленному компьютеру. Этот коммутатор заставляет PowerShell использовать параметр HostName для установки удаленного подключения на основе SSH.

Этот параметр появился в PowerShell 6.0.

Тип:	SwitchParameter
Допустимые значения:	true
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Subsystem

Указывает подсистему SSH, используемую для нового PSSession.

Это указывает подсистему, используемую в целевом объекте, как определено в sshd_config. Подсистема запускает определенную версию PowerShell с предопределенными параметрами. Если указанная подсистема не существует на удаленном компьютере, команда завершается ошибкой.

Если этот параметр не используется, по умолчанию используется подсистема PowerShell.

Тип:	String
Position:	Named
Default value:	powershell
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ThrottleLimit

Указывает максимальное количество одновременных подключений, которые можно установить для выполнения этой команды. Если этот параметр не указан или введите значение 0, используется значение по умолчанию 32.

Ограничение регулирования применяется только к текущей команде, а не к сеансу или к компьютеру.

Тип:	Int32
Position:	Named
Default value:	32
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-UserName

Указывает имя пользователя для учетной записи, используемой для выполнения команды на удаленном компьютере. Метод проверки подлинности пользователя зависит от настройки Secure Shell (SSH) на удаленном компьютере.

Если SSH настроен для базовой проверки подлинности паролей, вам будет предложено ввести пароль пользователя.

Если SSH настроен для проверки подлинности пользователей на основе ключей, то путь к файлу ключа можно предоставить с помощью параметра KeyFilePath, и запрос на пароль не возникает. Если файл ключа пользователя клиента расположен в известном расположении SSH, параметр KeyFilePath не требуется для проверки подлинности на основе ключей, а проверка подлинности пользователя выполняется автоматически на основе имени пользователя. Дополнительные сведения см. в документации по SSH платформы о проверке подлинности пользователей на основе ключей.

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

Этот параметр появился в PowerShell 6.0.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-UseSSL

Указывает, что этот командлет использует протокол SSL для установления подключения к удаленному компьютеру. По умолчанию SSL не используется.

WS-Management шифрует все содержимое PowerShell, передаваемое по сети. Параметр UseSSL — это дополнительная защита, которая отправляет данные по протоколу HTTPS вместо HTTPS.

Если вы используете этот параметр, но SSL недоступен на порту, который используется для команды, команда завершается ошибкой.

Тип:	SwitchParameter
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-VMId

Задает массив идентификаторов виртуальных машин.

Тип:	Guid[]
Aliases:	VMGuid
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-VMName

Задает массив имен виртуальных машин.

Тип:	String[]
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

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

ScriptBlock

Вы можете передать команду в блоке скрипта в Invoke-Command. Используйте $Input автоматическую переменную для представления входных объектов в команде.

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

System.Management.Automation.PSRemotingJob, System.Management.Automation.Runspaces.PSSession, or the output of the invoked command

Этот командлет возвращает объект задания, если используется параметр AsJob. Если указать параметр InDisconnectedSession, возвращает объект PSSession. В противном случае возвращает выходные данные вызываемой команды, которая является значением параметра ScriptBlock.

Примечания

В Windows Vista и более поздних версиях операционной системы Windows, чтобы использовать параметр computerName ComputerName для выполнения команды на локальном компьютере, необходимо запустить PowerShell с помощью параметра запуска от имени администратора.

При выполнении команд на нескольких компьютерах PowerShell подключается к компьютерам в том порядке, в котором они отображаются в списке. Однако выходные данные команды отображаются в том порядке, в котором он получил от удаленных компьютеров, которые могут отличаться.

Ошибки, которые возникают из команды, которая Invoke-Command выполняется, включаются в результаты команды. Ошибки, которые будут завершающимися ошибками в локальной команде, рассматриваются как неисключающие ошибки в удаленной команде. Эта стратегия гарантирует, что завершающие ошибки на одном компьютере не закрывают команду на всех компьютерах, на которых она выполняется. Эта практика используется даже при выполнении удаленной команды на одном компьютере.

Если удаленный компьютер не находится в домене, которому доверяет локальный компьютер, компьютер может не пройти проверку подлинности учетных данных пользователя. Чтобы добавить удаленный компьютер в список доверенных узлов в WS-Management, используйте следующую команду в поставщике WSMAN, где <Remote-Computer-Name> имя удаленного компьютера:

Set-Item -Path WSMan:\Localhost\Client\TrustedHosts -Value \<Remote-Computer-Name\>

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

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

Параметры HostName и SSHConnection были включены начиная с PowerShell 6.0. Они были добавлены для предоставления удаленного взаимодействия PowerShell на основе Secure Shell (SSH). PowerShell и SSH поддерживаются на нескольких платформах (Windows, Linux, macOS) и удаленном взаимодействии PowerShell на этих платформах, где установлены и настроены SSH PowerShell. Это отдельно от предыдущего удаленного взаимодействия Windows, основанного на WinRM, и многие из конкретных функций и ограничений WinRM не применяются. Например, квоты на основе WinRM, параметры сеанса, конфигурация пользовательской конечной точки и функции отключения и повторного подключения в настоящее время не поддерживаются. Дополнительные сведения о настройке удаленного взаимодействия PowerShell SSH см. в статье Удаленное взаимодействие PowerShell по протоколу SSH.

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

• about_PSSessions
• about_Remote
• about_Remote_Disconnected_Sessions
• about_Remote_Troubleshooting
• about_Remote_Variables
• about_Scopes
• Enter-PSSession
• Exit-PSSession;
• Get-PSSession
• Invoke-Item
• New-PSSession
• Remove-PSSession
• Поставщик WSMan