Invoke-Command

Модуль:

Microsoft.PowerShell.Core

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

Синтаксис

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

Invoke-Command
      [[-Session] <PSSession[]>]
      [-ScriptBlock] <scriptblock>
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [[-Session] <PSSession[]>]
      [-FilePath] <string>
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [[-ComputerName] <string[]>]
      [-ScriptBlock] <scriptblock>
      [-Credential <pscredential>]
      [-Port <int>]
      [-UseSSL]
      [-ConfigurationName <string>]
      [-ApplicationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-InDisconnectedSession]
      [-SessionName <string[]>]
      [-HideComputerName]
      [-JobName <string>]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [-CertificateThumbprint <string>]
      [<CommonParameters>]

Invoke-Command
      [[-ComputerName] <string[]>]
      [-FilePath] <string>
      [-Credential <pscredential>]
      [-Port <int>]
      [-UseSSL]
      [-ConfigurationName <string>]
      [-ApplicationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-InDisconnectedSession]
      [-SessionName <string[]>]
      [-HideComputerName]
      [-JobName <string>]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [[-ConnectionUri] <uri[]>]
      [-ScriptBlock] <scriptblock>
      [-Credential <pscredential>]
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-InDisconnectedSession]
      [-HideComputerName]
      [-JobName <string>]
      [-AllowRedirection]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [-CertificateThumbprint <string>]
      [<CommonParameters>]

Invoke-Command
      [[-ConnectionUri] <uri[]>]
      [-FilePath] <string>
      [-Credential <pscredential>]
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-InDisconnectedSession]
      [-HideComputerName]
      [-JobName <string>]
      [-AllowRedirection]
      [-SessionOption <PSSessionOption>]
      [-Authentication <AuthenticationMechanism>]
      [-EnableNetworkAccess]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-VMId] <guid[]>
      [-ScriptBlock] <scriptblock>
      -Credential <pscredential>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-ScriptBlock] <scriptblock>
      -Credential <pscredential>
      -VMName <string[]>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-VMId] <guid[]>
      [-FilePath] <string>
      -Credential <pscredential>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-FilePath] <string>
      -Credential <pscredential>
      -VMName <string[]>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-ScriptBlock] <scriptblock>
      -HostName <string[]>
      [-Port <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-UserName <string>]
      [-KeyFilePath <string>]
      [-Subsystem <string>]
      [-ConnectingTimeout <int>]
      [-SSHTransport]
      [-Options <hashtable>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-ScriptBlock] <scriptblock>
      -ContainerId <string[]>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RunAsAdministrator]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-FilePath] <string>
      -ContainerId <string[]>
      [-ConfigurationName <string>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RunAsAdministrator]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      [-ScriptBlock] <scriptblock>
      -SSHConnection <hashtable[]>
      [-AsJob]
      [-HideComputerName]
      [-JobName <string>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      -FilePath <string>
      -HostName <string[]>
      [-AsJob]
      [-HideComputerName]
      [-UserName <string>]
      [-KeyFilePath <string>]
      [-Subsystem <string>]
      [-ConnectingTimeout <int>]
      [-SSHTransport]
      [-Options <hashtable>]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Invoke-Command
      -FilePath <string>
      -SSHConnection <hashtable[]>
      [-AsJob]
      [-HideComputerName]
      [-RemoteDebug]
      [-InputObject <psobject>]
      [-ArgumentList <Object[]>]
      [<CommonParameters>]

Описание

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

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

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

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

Начиная с PowerShell 6.0, вы можете использовать Secure Shell (SSH) для установки подключения к удаленным компьютерам и вызова команд на удаленных компьютерах. SSH должен быть установлен на локальном компьютере, а удаленный компьютер должен быть настроен с помощью конечной точки SSH PowerShell. Преимущество удаленного сеанса 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. Параметр Session указывает сеанс, сохраненный в переменной $s .

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

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

В этом примере сравниваются эффекты использования параметров ComputerName и СеансаInvoke-Command. В нем показано, как использовать сеанс для запуска ряда команд с общими данными.

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 для Invoke-Command выполнения команд на удаленном компьютере Server02. Первая команда использует Get-Process командлет , чтобы получить процесс PowerShell на удаленном компьютере и сохранить его в переменной $p . Вторая команда получает значение свойства VirtualMemorySize процесса PowerShell.

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

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

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

Пример 5. Вызов команды с блоком скрипта, хранящимся в переменной

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

$command = {
    Get-WinEvent -LogName PowerShellCore/Operational |
      Where-Object -FilterScript { $_.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/Operational с каждого компьютера.

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

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

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

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

Командлет Invoke-Command выполняет Get-Host команду на удаленных компьютерах. Он использует точечную нотацию для получения свойства Version узла 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 командлет для отображения всех свойств объекта задания в списке. Последняя команда получает результаты заданий. Он передает объект задания в $jReceive-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 — это $Log переменная, которая имеет префикс модификатора Using область, чтобы указать, что он был создан в локальном сеансе, а не в удаленном сеансе.

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

В этом примере показан эффект использования параметра HideComputerName объекта Invoke-Command. HideComputerName не изменяет объект, возвращаемый этим командлетом. Он изменяет только дисплей. Командлеты Format по-прежнему можно использовать для отображения свойства 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 -HideComputerName -ScriptBlock {
    Get-Process PowerShell
}

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 .

Пример 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 файлов каталога сервера. Параметр Get-ChildItemPath имеет позицию 0, а параметр Filter — позицию 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

Invoke-Command использует параметр ScriptBlock и Get-ChildItem задает значения массива $args[0] и $args[1] . ArgumentList передает значения массива $args в Get-ChildItem позиции параметров Path и Filter.

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

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

$parameters = @{
    ComputerName = (Get-Content Servers.txt)
    FilePath     = 'C:\Scripts\Sample.ps1'
    ArgumentList = 'Process', 'Service'
}
Invoke-Command @parameters

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

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

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

$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 командлет . Командлет Invoke-Command выполняет Set-Mailbox команду, используя конфигурацию сеанса Microsoft.Exchange . Параметр ConnectionURI указывает URL-адрес конечной точки сервера Exchange Server. Параметр Credential указывает учетные данные, хранящиеся в переменной $LiveCred . Параметр AuthenticationMechanism указывает способ использования обычной проверки подлинности. Параметр ScriptBlock указывает блок скрипта, который содержит команду.

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

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

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

Командлет 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 объекта PSSessionOption значение 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 = @{
  ComputerName   = 'Server02'
  ScriptBlock    = { Get-Item \\Net03\Scripts\LogFiles.ps1 }
  Authentication = 'CredSSP'
  Credential     = 'Domain01\Admin01'
}
Invoke-Command @parameters

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

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

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

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

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

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

$parameters = @{
  ComputerName          = (Get-Content -Path C:\Test\Servers.txt)
  InDisconnectedSession = $true
  FilePath              = '\\Scripts\Public\ConfigInventory.ps1'
  SessionOption         = @{
      OutputBufferingMode = 'Drop'
      IdleTimeout         = [timespan]::FromHours(12)
  }
}
Invoke-Command @parameters

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

Значение SessionOption — это хэш-таблица. Для параметра OutputBufferingMode задано Drop значение , а для параметра IdleTimeout — значение 12 часов.

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

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

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

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

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

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

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

Пример 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\GetInfo.ps1 -SSHConnection $sshConnections

Пример 22. Подключение к удаленному сеансу SSH с помощью параметров SSH

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

$options = @{
    Port=22
    User = 'UserB'
    Host = 'LinuxServer5'
}
$results = Invoke-Command -FilePath c:\Scripts\CollectEvents.ps1 -KeyFilePath '/Users/UserB/id_rsa' -Options $options

Параметры

-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 соединения. Используйте этот параметр, чтобы указать имя приложения, если вы не используете параметр ConnectionURI в команде .

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

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

Type:	String
Position:	Named
Default value:	$PSSessionApplicationName if set on the local computer, otherwise WSMAN
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ArgumentList

Предоставляет значения параметров для scriptblock. Параметры в блоке скрипта передаются по позиции из значения массива, предоставленного в ArgumentList. Это называется сплаттингом массива. Дополнительные сведения о поведении ArgumentList см. в разделе about_Splatting.

Type:	Object[]
Aliases:	Args
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

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

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

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

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Authentication

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

Ниже приведены допустимые значения для этого параметра.

• Default
• Basic
• Credssp
• Digest (дайджест)
• Kerberos
• Согласование
• NegotiateWithImplicitCredential

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

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

Внимание!

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

Type:	AuthenticationMechanism
Accepted values:	Basic, Default, Credssp, Digest, Kerberos, Negotiate, NegotiateWithImplicitCredential
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

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

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

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

Чтобы использовать IP-адрес в значении ComputerName, команда должна включать параметр Credential . Компьютер должен быть настроен для транспорта HTTPS или IP-адрес удаленного компьютера должен быть включен в список TrustedHosts WinRM локального компьютера. Инструкции по добавлению имени компьютера в список TrustedHosts см. в статье How to Add a Computer to the Trusted Host List.

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

Type:	String[]
Aliases:	Cn
Position:	0
Default value:	Local computer
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConfigurationName

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

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

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

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

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

Type:	String
Position:	Named
Default value:	$PSSessionConfigurationName if set on the local computer, otherwise Microsoft.PowerShell
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ConnectingTimeout

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

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

Type:	Int32
Position:	Named
Default value:	Unlimited
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionUri

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

Строка имеет следующий формат:

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

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

http://localhost:5985/WSMAN

Если URI подключения не указан, можно использовать параметры UseSSL и Port , чтобы указать значения 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:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContainerId

Указывает массив идентификаторов контейнеров.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Credential

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

Введите имя пользователя, например User01 или Domain01\User01, или введите объект PSCredential , созданный командлетом Get-Credential . Если ввести имя пользователя, вам будет предложено ввести пароль.

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

Примечание

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

Type:	PSCredential
Position:	Named
Default value:	Current user
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-EnableNetworkAccess

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

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

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

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

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

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

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilePath

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

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

Type:	String
Aliases:	PSPath
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-HideComputerName

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

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

Type:	SwitchParameter
Aliases:	HCN
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HostName

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InDisconnectedSession

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

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

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

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

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

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

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

Type:	SwitchParameter
Aliases:	Disconnected
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

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

Type:	PSObject
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-JobName

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

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

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

Type:	String
Position:	Named
Default value:	Job<n>
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyFilePath

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

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

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

Type:	String
Aliases:	IdentityFilePath
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoNewScope

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

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

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Options

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

Все значения, явно переданные параметрами, имеют приоритет над значениями, переданными в хэш-таблицы Options . Например, при использовании параметра Port переопределяется любая Port пара "ключ-значение", переданная в хэш-сводке Options .

Этот параметр был добавлен в PowerShell 7.3.

Type:	Hashtable
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

-RemoteDebug

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RunAsAdministrator

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ScriptBlock

Указывает выполняющиеся команды. Заключите команды в фигурные скобки ({ }), чтобы создать блок скрипта. При использовании Invoke-Command для удаленного выполнения команды все переменные в команде вычисляются на удаленном компьютере.

Примечание

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

Type:	ScriptBlock
Aliases:	Command
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Session

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

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

Type:	PSSession[]
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SessionName

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SessionOption

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

Примечание

Если вы укажете хэш-строку для SessionOption, PowerShell преобразует ее в объект System.Management.Autiomation.Remoting.PSSessionOption . Значения ключей, указанных в хэш-таблицы, приведены к свойству matching объекта . Это поведение отличается от вызова New-PSSessionOption. Например, значения System.TimeSpan для свойств времени ожидания, таких как IdleTimeout, преобразуют целочисленное значение в такты вместо миллисекунда. Дополнительные сведения об объекте PSSessionOption и его свойствах см. в разделе 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

-SSHConnection

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

Хэш-сводка состоит из следующих элементов:

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

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

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

Type:	Hashtable[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SSHTransport

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

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

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

Type:	SwitchParameter
Accepted values:	true
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Subsystem

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

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

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

Type:	String
Position:	Named
Default value:	powershell
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ThrottleLimit

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

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

Type:	Int32
Position:	Named
Default value:	32
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserName

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

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

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

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

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

Type:	String
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

-VMId

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

Type:	Guid[]
Aliases:	VMGuid
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMName

Указывает массив имен виртуальных машин.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

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

ScriptBlock

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

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

System.Management.Automation.PSRemotingJob

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

PSSession

Если используется параметр InDisconnectedSession , этот командлет возвращает объект PSSession .

Object

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

Примечания

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

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

В Windows Vista и более поздних версиях операционной системы Windows, чтобы использовать параметр Invoke-CommandComputerName для выполнения команды на локальном компьютере, необходимо запустить 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 определяется текущим сеансом. Значение Disconnected означает, что PSSession не подключен к текущему сеансу. Однако это не означает, что PSSession отключен от всех сеансов. Он может быть подключен к другому сеансу. Определить возможность подключения или повторного подключения к сеансу позволяет свойство Availability.

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

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

Исполняемый ssh файл получает данные конфигурации из следующих источников в следующем порядке:

1. Параметры командной строки
2. файл конфигурации пользователя (~/.ssh/config)
3. файл конфигурации для всей системы (/etc/ssh/ssh_config)

Следующие параметры командлета сопоставляются с ssh параметрами и параметрами:

Параметр командлета	Параметр ssh	эквивалентный параметр ssh -o
-KeyFilePath	-i <KeyFilePath>	-o IdentityFile=<KeyFilePath>
-UserName	-l <UserName>	-o User=<UserName>
-Port	-p <Port>	-o Port=<Port>
-ComputerName -Subsystem	-s <ComputerName> <Subsystem>	-o Host=<ComputerName>

Все значения, явно переданные параметрами, имеют приоритет над значениями, переданными в хэш-таблицы параметров . Дополнительные сведения о ssh_config файлах см. в разделе ssh_config(5).

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

• about_PSSessions
• about_Remote
• about_Remote_Disconnected_Sessions
• Сведения об удаленной диагностике
• about_Remote_Variables
• about_Scopes
• Enter-PSSession
• Exit-PSSession;
• Get-PSSession
• Invoke-Item
• New-PSSession
• Remove-PSSession
• WSMan Provider