Поделиться через

Import-PSSession

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Импортирует команды из другого сеанса в текущий.

Синтаксис

Import-PSSession
      [-Prefix <String>]
      [-DisableNameChecking]
      [[-CommandName] <String[]>]
      [-AllowClobber]
      [-ArgumentList <Object[]>]
      [-CommandType <CommandTypes>]
      [-Module <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [[-FormatTypeName] <String[]>]
      [-Certificate <X509Certificate2>]
      [-Session] <PSSession>
      [<CommonParameters>]

Описание

Командлет Import-PSSession импортирует команды, такие как командлеты, функции и псевдонимы, из PSSession на локальном или удаленном компьютере в текущий сеанс. Вы можете импортировать любую команду, которую Get-Command командлет может найти в PSSession.

Import-PSSession Используйте команду для импорта команд из настраиваемой оболочки, например оболочки Microsoft Exchange Server, или из сеанса, включающего модули Windows PowerShell и оснастки или другие элементы, которые не находятся в текущем сеансе.

Чтобы импортировать команды, сначала используйте New-PSSession командлет для создания PSSession. Затем используйте Import-PSSession командлет для импорта команд. По умолчанию импортирует все команды, Import-PSSession кроме команд с теми же именами, что и команды в текущем сеансе. Чтобы импортировать все команды, используйте параметр AllowClobber .

Импортированные команды можно использовать точно так же, как и любую команду в сеансе. При использовании импортированных команд импортированная часть команды выполняется неявно в сеансе, из которой она была импортирована. Однако удаленные операции полностью обрабатываются Windows PowerShell. Вам даже не нужно помнить о них, за исключением того, что нужно поддерживать подключение к другому сеансу (PSSession) открытым. Если его закрыть, импортированные команды перестают быть недоступными.

Так как импортированные команды могут занять больше времени, чем локальные команды, Import-PSSession добавляет параметр AsJob в каждую импортированную команду. Этот параметр позволяет выполнить команду в качестве фонового задания Windows PowerShell. См. дополнительные сведения о заданиях.

При использовании Import-PSSessionWindows PowerShell добавляет импортированные команды во временный модуль, который существует только в сеансе, и возвращает объект, представляющий модуль. Чтобы создать постоянный модуль, который можно использовать в будущих сеансах, используйте Export-PSSession командлет.

Командлет Import-PSSession использует неявную функцию удаленного взаимодействия Windows PowerShell. При импорте команд в текущий сеанс они неявно выполняются в исходном сеансе или аналогичном сеансе на исходном компьютере.

Начиная с Windows PowerShell 3.0, можно использовать Import-Module командлет для импорта модулей из удаленного сеанса в текущий сеанс. Эта функция использует неявное удаленное взаимодействие. Он эквивалентен использованию Import-PSSession для импорта выбранных модулей из удаленного сеанса в текущий сеанс.

Примеры

Пример 1. Импорт всех команд из PSSession

$S = New-PSSession -ComputerName Server01
Import-PSSession -Session $S

Эта команда импортирует все команды из PSSession на компьютере Server01 в текущий сеанс, за исключением команд, которые имеют такие же имена, как и команды в текущем сеансе.

Так как эта команда не использует параметр CommandName , он также импортирует все данные форматирования, необходимые для импортированных команд.

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

$S = New-PSSession https://ps.testlabs.com/powershell
Import-PSSession -Session $S -CommandName *-test -FormatTypeName *
New-Test -Name Test1
Get-Test test1 | Run-Test

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

Первая команда использует New-PSSession командлет для создания PSSession. Он сохраняет PSSession в переменной $S .

Вторая команда использует Import-PSSession командлет для импорта команд из PSSession в $S текущий сеанс. Он использует параметр CommandName для указания команд с существительным test и параметром FormatTypeName для импорта данных форматирования для команд Test.

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

Пример 3. Импорт командлетов из PSSession

$S1 = New-PSSession -ComputerName s1
$S2 = New-PSSession -ComputerName s2
Import-PSSession -Session s1 -Type cmdlet -Name New-Test, Get-Test -FormatTypeName *
Import-PSSession -Session s2 -Type Cmdlet -Name Set-Test -FormatTypeName *
New-Test Test1 | Set-Test -RunType Full

Этот пример показывает, что импортированные командлеты можно использовать точно так же, как и локальные командлеты.

Эти команды импортируют New-Test и Get-Test командлеты из PSSession на компьютере Server01 и Set-Test командлете из PSSession на компьютере Server02.

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

Пример 4. Выполнение импортированной команды в качестве фонового задания

$S = New-PSSession -ComputerName Server01
Import-PSSession -Session $S -CommandName *-test* -FormatTypeName *
$batch = New-Test -Name Batch -AsJob
Receive-Job $batch

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

Так как импортированные команды могут занять больше времени, чем локальные команды, Import-PSSession добавляет параметр AsJob в каждую импортированную команду. Параметр AsJob позволяет выполнять команду в качестве фонового задания.

Первая команда создает PSSession на компьютере Server01 и сохраняет объект PSSession в переменной $S .

Вторая команда используется Import-PSSession для импорта командлетов Test из PSSession в $S текущий сеанс.

Третья команда использует параметр AsJob импортированного New-Test командлета для выполнения New-Test команды в качестве фонового задания. Команда сохраняет объект задания, New-Test который возвращается в переменной $batch .

Четвертая команда использует Receive-Job командлет для получения результатов задания в переменной $batch .

Пример 5. Импорт командлетов и функций из модуля Windows PowerShell

$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S {Import-Module TestManagement}
Import-PSSession -Session $S -Module TestManagement

В этом примере показано, как импортировать командлеты и функции из модуля Windows PowerShell на удаленном компьютере в текущий сеанс.

Первая команда создает PSSession на компьютере Server01 и сохраняет ее в переменной $S .

Вторая команда использует Invoke-Command командлет для выполнения Import-Module команды в PSSession.$S

Как правило, модуль будет добавлен во все сеансы командой Import-Module в профиле Windows PowerShell, но профили не выполняются в PSSessions.

Третья команда использует параметр module для Import-PSSession импорта командлетов и функций в модуле в текущий сеанс.

Пример 6. Создание модуля во временном файле

PS C:\> Import-PSSession $S -CommandName Get-Date, SearchHelp -FormatTypeName * -AllowClobber

Name              : tmp_79468106-4e1d-4d90-af97-1154f9317239_tcw1zunz.ttf
Path              : C:\Users\User01\AppData\Local\Temp\tmp_79468106-4e1d-4d90-af97-1154f9317239_tcw1
zunz.ttf\tmp_79468106-4e1d-4d90-af97-1154f9317239_
tcw1zunz.ttf.psm1
Description       : Implicit remoting for http://server01.corp.fabrikam.com/wsman
Guid              : 79468106-4e1d-4d90-af97-1154f9317239
Version           : 1.0
ModuleBase        : C:\Users\User01\AppData\Local\Temp\tmp_79468106-4e1d-4d90-af97-1154f9317239_tcw1
zunz.ttf
ModuleType        : Script
PrivateData       : {ImplicitRemoting}
AccessMode        : ReadWrite
ExportedAliases   : {}
ExportedCmdlets   : {}
ExportedFunctions : {[Get-Date, Get-Date], [SearchHelp, SearchHelp]}
ExportedVariables : {}
NestedModules     : {}

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

Команда использует Import-PSSession командлет для импорта командлета Get-Date и функции SearchHelp в текущий сеанс.

Командлет Import-PSSession возвращает объект PSModuleInfo , представляющий временный модуль. Значение свойства Path показывает, что Import-PSSession в временном расположении создан файл модуля скрипта (PSM1). Свойство ExportedFunctions показывает, что Get-Date командлет и функция SearchHelp были импортированы как функции.

Пример 7. Выполнение команды, скрытой импортированной командой

PS C:\> Import-PSSession $S -CommandName Get-Date -FormatTypeName * -AllowClobber

PS C:\> Get-Command Get-Date -All

CommandType   Name       Definition
-----------   ----       ----------
Function      Get-Date   ...
Cmdlet        Get-Date   Get-Date [[-Date] <DateTime>] [-Year <Int32>] [-Month <Int32>]

PS C:\> Get-Date
09074

PS C:\> (Get-Command -Type Cmdlet -Name Get-Date).PSSnapin.Name
Microsoft.PowerShell.Utility

PS C:\> Microsoft.PowerShell.Utility\Get-Date
Sunday, March 15, 2009 2:08:26 PM

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

Первая команда импортирует Get-Date командлет из PSSession в переменной $S . Так как текущий Get-Date сеанс включает командлет, параметр AllowClobber требуется в команде.

Вторая команда использует параметр All командлета Get-Command для получения всех Get-Date команд в текущем сеансе. Выходные данные показывают, что сеанс включает исходный Get-Date командлет и Get-Date функцию. Функция Get-Date запускает импортированный Get-Date командлет в PSSession в $S.

Третья команда выполняет Get-Date команду. Так как функции имеют приоритет над командлетами, Windows PowerShell запускает импортированную Get-Date функцию, которая возвращает дату Джулиана.

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

Четвертая команда получает имя оснастки Windows PowerShell, которая добавила исходный Get-Date командлет в текущий сеанс.

Пятая команда использует полное имя командлета Get-Date для выполнения Get-Date команды.

Дополнительные сведения о приоритете команд и скрытых командах см. в about_Command_Precedence.

Пример 8. Импорт команд с определенной строкой в именах

PS C:\> Import-PSSession -Session $S -CommandName **Item** -AllowClobber

Эта команда импортирует команды, имена которых включают Item из PSSession в $S. Так как команда включает параметр CommandName , но не параметр FormatTypeData , импортируется только команда.

Используйте эту команду при выполнении Import-PSSession команды на удаленном компьютере, и у вас уже есть данные форматирования для команды в текущем сеансе.

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

PS C:\> $M = Import-PSSession -Session $S -CommandName *bits* -FormatTypeName *bits*
PS C:\> Get-Command -Module $M
CommandType     Name
-----------     ----
Function        Add-BitsFile
Function        Complete-BitsTransfer
Function        Get-BitsTransfer
Function        Remove-BitsTransfer
Function        Resume-BitsTransfer
Function        Set-BitsTransfer
Function        Start-BitsTransfer
Function        Suspend-BitsTransfer

Эта команда показывает, как использовать параметр Get-Command модуля для определения того, какие команды были импортированы в сеанс командойImport-PSSession.

Первая команда использует Import-PSSession командлет для импорта команд, имена которых включают "биты" из PSSession в $S переменную. Команда Import-PSSession возвращает временный модуль, а команда сохраняет модуль в переменной $m .

Вторая команда использует Get-Command командлет для получения команд, экспортируемых модулем в переменной $M .

Параметр модуля принимает строковое значение, предназначенное для имени модуля. Однако при отправке объекта модуля Windows PowerShell использует метод ToString в объекте модуля, который возвращает имя модуля.

Команда Get-Command эквивалентна Get-Command $M.Name".

Параметры

-AllowClobber

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

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

По умолчанию Import-PSSession не импортирует команды с тем же именем, что и команды в текущем сеансе.

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

-ArgumentList

Задает массив команд, результатом использования указанных аргументов (значений параметров).

Например, чтобы импортировать вариант Get-Item команды в диске сертификата (Cert:) в psSession в $Sтипе Import-PSSession -Session $S -Command Get-Item -ArgumentList cert:.

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

-Certificate

Указывает сертификат клиента, используемый для подписи файлов формата (*). Format.ps1xml) или файлы модулей скрипта (PSM1) во временном модуле, который Import-PSSession создает.

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

Чтобы найти сертификат, используйте командлет или используйте Get-PfxCertificate Get-ChildItem командлет на диске Сертификата (Cert:). Если сертификат недопустимый или не имеет достаточных полномочий, команда завершается ошибкой.

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

-CommandName

Задает команды с указанными именами или шаблонами имен. Разрешено использовать подстановочные знаки. Используйте CommandName или его псевдоним, имя.

По умолчанию Import-PSSession импортирует все команды из сеанса, за исключением команд, которые имеют те же имена, что и команды в текущем сеансе. Это предотвращает скрытие или замену команд в текущем сеансе импортированными командами. Чтобы импортировать все команды, даже те, которые скрывают или заменяют другие команды, используйте параметр AllowClobber .

Если вы используете параметр CommandName , файлы форматирования для команд не импортируются, если вы не используете параметр FormatTypeName . Аналогичным образом, если вы используете параметр FormatTypeName , команды не импортируются, если вы не используете параметр CommandName .

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

-CommandType

Указывает тип объектов команд. Значение по умолчанию — Cmdlet. Используйте CommandType или его псевдоним Type. Допустимые значения для этого параметра:

  • Alias: псевдонимы Windows PowerShell в удаленном сеансе.
  • All: командлеты и функции в удаленном сеансе.
  • Application: все файлы, отличные от файлов Windows-PowerShell в путях, перечисленных в переменной среды Path ($env:path) в удаленном сеансе, включая .txt, .exe и .dll файлы.
  • Cmdlet: командлеты в удаленном сеансе. Значение по умолчанию — "Cmdlet".
  • ExternalScript: PS1-файлы в путях, перечисленных в переменной среды Path ($env:path) в удаленном сеансе.
  • Filter и Function: функции Windows PowerShell в удаленном сеансе.
  • Script: блоки скрипта в удаленном сеансе.

Эти значения определяются как перечисление на основе флага. Можно объединить несколько значений, чтобы задать несколько флагов с помощью этого параметра. Значения можно передать параметру CommandType в виде массива значений или в виде строки, разделенной запятыми этих значений. Командлет объединяет значения с помощью операции binary-OR. Передача значений в виде массива является самым простым параметром, а также позволяет использовать завершение табуляции для значений.

Тип:CommandTypes
Aliases:Type
Допустимые значения:Alias, Function, Filter, Cmdlet, ExternalScript, Application, Script, Workflow, Configuration, All
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DisableNameChecking

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

По умолчанию, когда импортируемый модуль экспортирует командлеты или функции с недопустимыми командами в именах, Windows PowerShell отображает следующее предупреждающее сообщение:

"ПРЕДУПРЕЖДЕНИЕ. Некоторые импортированные имена команд включают неутвержденные команды, которые могут сделать их менее обнаруживаемыми. Используйте подробный параметр для получения дополнительных сведений или типа Get-Verb , чтобы просмотреть список утвержденных команд".

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

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

-FormatTypeName

Указывает инструкции по форматированию указанных типов Microsoft платформа .NET Framework. Введите имена типов. Разрешено использовать подстановочные знаки.

Значение этого параметра должно быть именем типа, возвращаемого командой Get-FormatData в сеансе, из которого импортируются команды. Чтобы получить все данные форматирования в удаленном сеансе, введите *.

Если команда не включает параметр CommandName или FormatTypeName, импортирует инструкции по форматированию для всех платформа .NET Framework типов, Import-PSSession возвращаемых командой Get-FormatData в удаленном сеансе.

Если используется параметр FormatTypeName , никакие команды не импортируются, если вы не используете параметр CommandName .

Аналогичным образом, если вы используете параметр CommandName , файлы форматирования для команд не импортируются, если только вы не используете параметр FormatTypeName .

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

-FullyQualifiedModule

Это значение может быть именем модуля, полной спецификацией модуля или путем к файлу модуля.

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

Если значение является спецификацией имени или модуля, PowerShell выполняет поиск в PSModulePath для указанного модуля.

Спецификация модуля — это хэш-файл, имеющий следующие ключи.

  • ModuleName - Обязательный указывает имя модуля.
  • GUID - Необязательный атрибут указывает GUID модуля.
  • Также требуется указать по крайней мере один из трех приведенных ниже ключей.
    • ModuleVersion — задает минимальную допустимую версию модуля.
    • MaximumVersion — задает максимальную допустимую версию модуля.
    • RequiredVersion — указывает точную, требуемую версию модуля. Это нельзя использовать с другими ключами версии.

Невозможно указать параметр ПолностьюQualifiedModule в той же команде, что и параметр module . Два параметра являются взаимоисключающими.

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

-Module

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

Import-PSSession не может импортировать поставщиков из оснастки.

Дополнительные сведения см. в about_PSSnapins и about_Modules.

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

-Prefix

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

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

Например, если указать префикс Remote, а затем импортировать Get-Date командлет, командлет известен в сеансе как Get-RemoteDate, и он не путается с исходным Get-Date командлетом.

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

-Session

Указывает PSSession , из которого импортируются командлеты. Введите переменную, содержащую объект сеанса или команду, которая получает объект сеанса, например New-PSSession команду или Get-PSSession команду. Можно указать только один сеанс. Этот параметр является обязательным.

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

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

None

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

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

PSModuleInfo

Этот командлет возвращает тот же объект модуля, что New-Module и Get-Module возвращаемые командлетами. Однако импортированный модуль является временным и существует только в текущем сеансе. Чтобы создать постоянный модуль на диске, используйте Export-PSSession командлет.

Примечания

  • Import-PSSession использует инфраструктуру удаленного взаимодействия PowerShell. Для использования этого командлета компьютер должен быть настроен на удаленное взаимодействие WS-Management. Дополнительные сведения см. в about_Remote и about_Remote_Requirements.
  • Import-PSSession не импортирует переменные или поставщики PowerShell.
  • При импорте команд, которые имеют те же имена, что и команды в текущем сеансе, импортированные команды в сеансе могут скрывать псевдонимы, функции и командлеты, а также заменять функции и переменные. Чтобы предотвратить конфликты имен, используйте параметр префикса . Дополнительные сведения см. в разделе about_Command_Precedence.
  • Import-PSSession преобразует все команды в функции перед их импортом. В результате импортированные команды работают немного иначе, чем если бы они сохранили свой исходный тип команды. Например, если импортировать командлет из PSSession и затем импортировать командлет с таким же именем из модуля или оснастки, импортированный из PSSession командлет всегда выполняется по умолчанию, поскольку функции имеют приоритет над командлетами. И наоборот, если импортировать псевдоним в сеанс, где уже есть псевдоним с таким же именем, всегда используется исходный псевдоним, поскольку псевдонимы имеют приоритет над функциями. Дополнительные сведения см. в разделе about_Command_Precedence.
  • Import-PSSessionWrite-Progress использует командлет для отображения хода выполнения команды. Во время выполнения команды может отображаться индикатор выполнения .
  • Чтобы найти команды для импорта, Import-PSSession использует Invoke-Command командлет для выполнения Get-Command команды в PSSession. Чтобы получить данные форматирования для команд, он использует Get-FormatData командлет. При выполнении Import-PSSession команды могут отображаться сообщения об ошибках из этих командлетов. Кроме того, Import-PSSession не удается импортировать команды из PSSession, которая не включает Get-CommandGet-FormatDataкомандлеты , Select-Objectи Get-Help командлеты.
  • Импортированные команды имеют те же ограничения, что и другие удаленные команды, включая невозможность запуска программы с пользовательским интерфейсом, например "Блокнот".
  • Так как профили Windows PowerShell не выполняются в PSSessions, команды, добавляемые в сеанс, недоступны Import-PSSession. Чтобы импортировать команды из профиля, используйте Invoke-Command команду для запуска профиля в PSSession вручную перед импортом команд.
  • Временный модуль, который Import-PSSession создает, может включать файл форматирования, даже если команда не импортирует данные форматирования. Если команда не импортирует данные форматирования, все создаваемые файлы форматирования не будут содержать данные форматирования.
  • Для использования Import-PSSessionполитика выполнения в текущем сеансе не может быть ограничена или AllSigned, так как временный модуль, Import-PSSession который создает файлы скриптов без знака, запрещенные этими политиками. Чтобы использовать Import-PSSession политику выполнения без изменения политики выполнения для локального компьютера, используйте параметр Set-ExecutionPolicy Scope для установки менее строгой политики выполнения для одного процесса.
  • В Windows PowerShell 2.0 разделы справки по командам, импортированным из другого сеанса, не включают префикс, назначенный с помощью параметра префикса . Чтобы получить справку для импортированной команды Windows PowerShell 2.0, используйте исходное имя команды (без префикса).