Export-PSSession

Export-PSSession
    [-OutputModule] <String>
    [[-CommandName] <String[]>]
    [[-FormatTypeName] <String[]>]
    [-Session] <PSSession>
    [-Force]
    [-Encoding <Encoding>]
    [-AllowClobber]
    [-ArgumentList <Object[]>]
    [-CommandType <CommandTypes>]
    [-Module <String[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [-Certificate <X509Certificate2>]
    [<CommonParameters>]

Командлет Export-PSSession получает командлеты, функции, псевдонимы и другие типы команд из другого сеанса PowerShell (PSSession) на локальном или удаленном компьютере и сохраняет их в модуле PowerShell. Чтобы добавить команды из модуля в текущий сеанс, используйте командлет Import-Module.

В отличие от Import-PSSession, которая импортирует команды из другого psSession в текущий сеанс, Export-PSSession сохраняет команды в модуле. Команды не импортируются в текущий сеанс.

Чтобы экспортировать команды, используйте командлет New-PSSession для создания PSSession с командами, которые необходимо экспортировать. Затем используйте командлет Export-PSSession для экспорта команд.

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

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

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

$S = New-PSSession -ComputerName Server01
Export-PSSession -Session $S -OutputModule Server01

Команда New-PSSession создает PSSession на компьютере Server01. PsSession хранится в переменной $S. Команда Export-PSSession экспортирует команды переменной $S и форматирование данных в модуль Server01.

В этом примере экспортируются все команды Get и Set с сервера.

$newSession = @{
    ConnectionUri = 'https://exchange.microsoft.com/mailbox'
    Credential = 'exchangeadmin01@hotmail.com'
    Authentication = 'Negotiate'
}
$S = New-PSSession @newSession

$exportSession = @{
    Session = $S
    Module = 'exch*'
    CommandName = 'Get-*', 'Set-*'
    FormatTypeName = '*'
    OutputModule = "$PSHOME\Modules\Exchange"
    Encoding = 'ascii'
}

Export-PSSession @exportSession

Эти команды экспортируют команды Get и Set из оснастки Microsoft Exchange Server на удаленном компьютере в модуль Exchange в каталоге $PSHOME\Modules на локальном компьютере. Размещение модуля в каталоге $PSHOME\Modules делает его доступным для всех пользователей компьютера.

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

$newSession = @{
    ComputerName = 'Server01'
    Credential = 'Server01\User01'
}
$S = New-PSSession @newSession

$exportSession = @{
    Session = $S
    OutputModule = 'TestCmdlets'
    Type = 'Cmdlet'
    CommandName = '*test*'
    FormatTypeName = '*'
}
Export-PSSession @exportSession

Remove-PSSession $S
Import-Module TestCmdlets
Get-Help Test*
Test-Files

Команда New-PSSession создает psSession на компьютере Server01 и сохраняет его в переменной $S. Команда Export-PSSession экспортирует командлеты, имена которых начинаются с теста из PSSession в $S в модуль TestCmdlets на локальном компьютере.

Командлет Remove-PSSession удаляет psSession в $S из текущего сеанса. Эта команда показывает, что psSession не нужно использовать команды, импортированные из сеанса. Командлет Import-Module добавляет командлеты в модуль TestCmdlets в текущий сеанс. Команда может выполняться в любой сеанс в любое время.

Командлет Get-Help получает справку для командлетов, имена которых начинаются с test. После добавления команд в модуль в текущий сеанс можно использовать командлеты Get-Help и Get-Command, чтобы узнать об импортированных командах. Командлет Test-Files был экспортирован с компьютера Server01 и добавлен в сеанс. Командлет Test-Files выполняется в удаленном сеансе на компьютере, с которого была импортирована команда. PowerShell создает сеанс из сведений, хранящихся в модуле TestCmdlets.

В этом примере экспортируются команды, хранящиеся в переменной, в текущий сеанс.

Export-PSSession -Session $S -AllowClobber -OutputModule AllCommands

Эта команда Export-PSSession экспортирует все команды и все данные форматирования из PSSession в переменной $S в текущий сеанс. Параметр AllowClobber включает команды с теми же именами, что и команды в текущем сеансе.

В этом примере показано, как выполнять экспортированные команды с особыми параметрами при закрытии PSSession, создавшего экспортированные команды.

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

Чтобы выполнить экспортированные команды с специальными параметрами в удаленном сеансе, необходимо создать удаленный сеанс с этими параметрами перед импортом модуля. Используйте командлет New-PSSession с параметром SessionOption

$Options = New-PSSessionOption -NoMachineProfile
$S = New-PSSession -ComputerName Server01 -SessionOption $Options
Export-PSSession -Session $S -OutputModule Server01
Remove-PSSession $S
New-PSSession -ComputerName Server01 -SessionOption $Options
Import-Module Server01

Командлет New-PSSessionOption создает объект PSSessionOption и сохраняет объект в переменной $Options. Команда New-PSSession создает PSSession на компьютере Server01. Параметр сеанса использует объект, хранящийся в $Options. Сеанс хранится в переменной $S.

Командлет Export-PSSession экспортирует команды из PSSession в $S в модуль Server01. Командлет Remove-PSSession удаляет psSession в переменной $S.

Командлет New-PSSession создает новый интерфейс PSSession, который подключается к компьютеру Server01. Параметр сеанса использует объект, хранящийся в $Options. Командлет Import-Module импортирует команды из модуля Server01. Команды в модуле выполняются в PSSession на компьютере Server01.

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

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

Export-PSSession использует инфраструктуру удаленного взаимодействия PowerShell. Чтобы использовать этот командлет, компьютер должен быть настроен для удаленного взаимодействия. Дополнительные сведения см. в about_Remote_Requirements.

Нельзя использовать Export-PSSession для экспорта поставщика PowerShell.

Экспортированные команды выполняются неявно в PSSession, из которого они были экспортированы. Сведения о удаленном выполнении команд обрабатываются PowerShell полностью. Экспортированные команды можно выполнять так же, как и локальные команды.

Export-ModuleMember записывает и сохраняет сведения о PSSession в модуле, экспортируемом им. Если psSession, из которого экспортируются команды, закрываются при импорте модуля и не существует активных PSSessions на тот же компьютер, команды в модуле пытаются воссоздать PSSession. Если попытка повторно создать psSession завершается ошибкой, экспортированные команды не будут выполняться.

Сведения о сеансе, которые Export-ModuleMember фиксируют и сохраняются в модуле, не включают параметры сеанса, такие как указанные в переменной предпочтения $PSSessionOption или с помощью параметра SessionOption командлетов New-PSSession, Enter-PSSessionили Invoke-Command. Если исходный PSSession закрыт при импорте модуля, модуль будет использовать другой PSSession на том же компьютере, если он доступен. Чтобы включить импортированные команды для выполнения в правильно настроенном сеансе, создайте PSSession с параметрами, которые необходимо выполнить перед импортом модуля.

Чтобы найти команды для экспорта, Export-PSSession использует командлет Invoke-Command для выполнения команды Get-Command в PSSession. Для получения и сохранения данных форматирования для команд используется командлеты Get-FormatData и Export-FormatData. При выполнении команды Invoke-Command могут отображаться сообщения об ошибках из Get-Command, Get-FormatData, Export-FormatDataи Export-PSSession. Кроме того, Export-PSSession не может экспортировать команды из сеанса, который не включает командлеты Get-Command, Get-FormatData, Select-Objectи Get-Help.

Export-PSSession использует командлет Write-Progress для отображения хода выполнения команды. Во время выполнения команды может появиться индикатор хода выполнения.

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

Так как профили PowerShell не выполняются в PSSessions, команды, добавляемые в сеанс, недоступны для Export-PSSession. Чтобы экспортировать команды из профиля, используйте команду Invoke-Command для запуска профиля в PSSession вручную перед экспортом команд.

Модуль, который Export-PSSession создает, может включать файл форматирования, даже если команда не импортирует данные форматирования. Если команда не импортирует данные форматирования, все созданные файлы форматирования не будут содержать данные форматирования.