New-PSSessionOption

Синтаксис

New-PSSessionOption
   [-MaximumRedirection <Int32>]
   [-NoCompression]
   [-NoMachineProfile]
   [-Culture <CultureInfo>]
   [-UICulture <CultureInfo>]
   [-MaximumReceivedDataSizePerCommand <Int32>]
   [-MaximumReceivedObjectSize <Int32>]
   [-OutputBufferingMode <OutputBufferingMode>]
   [-MaxConnectionRetryCount <Int32>]
   [-ApplicationArguments <PSPrimitiveDictionary>]
   [-OpenTimeout <Int32>]
   [-CancelTimeout <Int32>]
   [-IdleTimeout <Int32>]
   [-ProxyAccessType <ProxyAccessType>]
   [-ProxyAuthentication <AuthenticationMechanism>]
   [-ProxyCredential <PSCredential>]
   [-SkipCACheck]
   [-SkipCNCheck]
   [-SkipRevocationCheck]
   [-OperationTimeout <Int32>]
   [-NoEncryption]
   [-UseUTF16]
   [-IncludePortInSPN]
   [<CommonParameters>]

Описание

Командлет New-PSSessionOption создает объект, содержащий дополнительные параметры для управляемого пользователем сеанса (PSSession). Объект можно использовать в качестве значения параметра SessionOption командлетов, создающих PSSession, например New-PSSession, Enter-PSSessionи Invoke-Command.

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

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

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

Примеры

Пример 1. Создание параметра сеанса по умолчанию

Эта команда создает объект SessionOption со значениями по умолчанию.

New-PSSessionOption

MaximumConnectionRedirectionCount : 5
NoCompression                     : False
NoMachineProfile                  : False
ProxyAccessType                   : IEConfig
ProxyAuthentication               : Negotiate
ProxyCredential                   :
SkipCACheck                       : False
SkipCNCheck                       : False
SkipRevocationCheck               : False
OperationTimeout                  : 00:03:00
NoEncryption                      : False
UseUTF16                          : False
Culture                           :
UICulture                         :
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize         :
ApplicationArguments              :
OpenTimeout                       : 00:03:00
CancelTimeout                     : 00:01:00
IdleTimeout                       : 00:04:00

Пример 2. Настройка сеанса с помощью объекта параметра сеанса

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

$pso = New-PSSessionOption -Culture "fr-fr" -MaximumReceivedObjectSize 10MB
New-PSSession -ComputerName Server01 -SessionOption $pso

Первая команда создает объект SessionOption и сохраняет его в значении переменной $pso . Вторая команда использует New-PSSession командлет для создания сеанса на удаленном компьютере Server01. Команда использует объект SessionOption в значении переменной в качестве значения $pso параметра SessionOption команды.

Пример 3. Запуск интерактивного сеанса

Эта команда использует Enter-PSSession командлет для запуска интерактивного сеанса с компьютером Server01.

Enter-PSSession -ComputerName Server01 -SessionOption (New-PSSessionOption -NoEncryption -NoCompression)

Значение параметра SessionOption — это New-PSSessionOption команда с параметрами NoEncryption и NoCompression.

Команда New-PSSessionOption заключена в скобки, чтобы убедиться, что она выполняется перед командой Enter-PSSession .

Пример 4. Изменение объекта параметра сеанса

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

$a = New-PSSessionOption
$a.OpenTimeout

Days              : 0
Hours             : 0
Minutes           : 3
Seconds           : 0
Milliseconds      : 0
Ticks             : 1800000000
TotalDays         : 0.00208333333333333
TotalHours        : 0.05
TotalMinutes      : 3
TotalSeconds      : 180
TotalMilliseconds : 180000

$a.UICulture = (Get-UICulture)
$a.OpenTimeout = (New-Timespan -Minutes 4)
$a.MaximumConnectionRedirectionCount = 1
$a

MaximumConnectionRedirectionCount : 1
NoCompression                     : False
NoMachineProfile                  : False
ProxyAccessType                   : IEConfig
ProxyAuthentication               : Negotiate
ProxyCredential                   :
SkipCACheck                       : False
SkipCNCheck                       : False
SkipRevocationCheck               : False
OperationTimeout                  : 00:03:00
NoEncryption                      : False
UseUTF16                          : False
Culture                           :
UICulture                         : en-US
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize         :
ApplicationArguments              :
OpenTimeout                       : 00:04:00
CancelTimeout                     : 00:01:00
IdleTimeout                       : 00:04:00

Используйте этот метод для создания стандартного объекта сеанса в своей организации, а затем настраивайте отдельные его версии для определенных целей.

Пример 5. Создание переменной предпочтения

Эта команда создает переменную $PSSessionOption предпочтения.

$PSSessionOption = New-PSSessionOption -OpenTimeOut 120000

$PSSessionOption Если переменная предпочтения задана в сеансе, она устанавливает значения по умолчанию для параметров в сеансах, созданных с New-PSSessionпомощью командлетов, Enter-PSSessionи Invoke-Command командлетов.

Чтобы сделать переменную доступной $PSSessionOption во всех сеансах, добавьте ее в сеанс PowerShell и в профиль PowerShell.

Дополнительные сведения о переменной $PSSessionOption предпочтения см. в about_Preference_Variables. Дополнительные сведения о профилях см. в about_Profiles.

Пример 6. Выполнение требований к конфигурации удаленного сеанса

В этом примере показано, как использовать объект SessionOption для выполнения требований к конфигурации удаленного сеанса.

$skipCN = New-PSSessionOption -SkipCNCheck
New-PSSession -ComputerName 171.09.21.207 -UseSSL -Credential Domain01\User01 -SessionOption $SkipCN

Первая команда использует New-PSSessionOption командлет для создания объекта SessionOption с свойством SkipCNCheck. Команда сохраняет полученный объект сеанса в переменной $skipCN .

Вторая команда использует New-PSSession командлет для создания нового сеанса на удаленном компьютере. Переменная $skipCN проверки используется в значении параметра SessionOption .

Так как компьютер определяется ip-адресом, значение параметра ComputerName не соответствует ни одному из распространенных имен в сертификате, который используется для протокола SSL. В результате требуется параметр SkipCNCheck .

Пример 7. Предоставление аргументов удаленному сеансу

В этом примере показано, как использовать параметр ApplicationArguments командлета New-PSSessionOption , чтобы сделать дополнительные данные доступными для удаленного сеанса.

$team = @{Team="IT"; Use="Testing"}
$TeamOption = New-PSSessionOption -ApplicationArguments $team
$s = New-PSSession -ComputerName Server01 -SessionOption $TeamOption
Invoke-Command -Session $s {$PSSenderInfo.ApplicationArguments}

Name                 Value
----                 -----
Team                 IT
Use                  Testing
PSVersionTable       {CLRVersion, BuildVersion, PSVersion, WSManStackVersion...}

Invoke-Command -Session $s {
  if ($PSSenderInfo.ApplicationArguments.Use -ne "Testing") {
    .\logFiles.ps1
  }
  else {
    "Just testing."
  }
}

Just testing.

Первая команда создает хэш-таблицу с двумя ключами, командой и использованием. Команда сохраняет хэш-таблицу в переменной $team . Дополнительные сведения о хэш-таблицах см. здесь.

New-PSSessionOption Затем командлет с помощью параметра ApplicationArguments создает объект SessionOption, сохраненный в переменной$team. При New-PSSessionOption создании объекта параметра сеанса он автоматически преобразует хэш-таблицу в значение параметра ApplicationArguments в ПримитивDictionary, чтобы данные могли быть надежно переданы в удаленный сеанс.

Командлет New-PSSession запускает сеанс на компьютере Server01. Он использует параметр SessionOption для включения параметров в $teamOption переменную.

Командлет Invoke-Command демонстрирует, что данные в $team переменной доступны командам в удаленном сеансе. Данные отображаются в свойстве ApplicationArguments автоматической переменной $PSSenderInfo .

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

Параметры

-ApplicationArguments

-CancelTimeout

-Culture

-IdleTimeout

-IncludePortInSPN

-MaxConnectionRetryCount

-MaximumReceivedDataSizePerCommand

-MaximumReceivedObjectSize

-MaximumRedirection

-NoCompression

-NoEncryption

-NoMachineProfile

-OpenTimeout

-OperationTimeout

-OutputBufferingMode

-ProxyAccessType

-ProxyAuthentication

-ProxyCredential

-SkipCACheck

-SkipCNCheck

-SkipRevocationCheck

-UICulture

-UseUTF16

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

None

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

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

PSSessionOption

Примечания

Если параметр SessionOption не используется в команде для создания PSSession, параметры сеанса определяются значениями свойств переменной $PSSessionOption предпочтения, если он задан. Дополнительные сведения об переменной $PSSessionOption см. в about_Preference_Variables.

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

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

• Enter-PSSession
• Invoke-Command
• New-PSSession