New-PSTransportOption

  • 参考
模块:
Microsoft.PowerShell.Core

创建包含用于会话配置的高级选项的对象。

语法

New-PSTransportOption
   [-MaxIdleTimeoutSec <Int32>]
   [-ProcessIdleTimeoutSec <Int32>]
   [-MaxSessions <Int32>]
   [-MaxConcurrentCommandsPerSession <Int32>]
   [-MaxSessionsPerUser <Int32>]
   [-MaxMemoryPerSessionMB <Int32>]
   [-MaxProcessesPerSession <Int32>]
   [-MaxConcurrentUsers <Int32>]
   [-IdleTimeoutSec <Int32>]
   [-OutputBufferingMode <OutputBufferingMode>]
   [<CommonParameters>]

说明

New-PSTransportOption cmdlet 创建一个对象，它包含会话配置的传输选项。 你可以将该对象用作创建或更改会话配置的 cmdlet 的 TransportOption 参数的值，如 Register-PSSessionConfiguration 和 Set-PSSessionConfiguration cmdlet。

还可以通过编辑 WSMan: 驱动器中会话配置属性的值更改传输选项设置。 有关详细信息，请参阅“WSMan 提供程序”。

会话配置选项表示设置在服务器端上的会话值或远程连接的接收端。 当创建会话时，或当客户端从会话断开连接或重新连接到会话时，客户端或连接的发送端可以设置会话选项值。 除非另有说明，当设置值冲突时，客户端的值优先。 但是，客户端的值不能与会话配置中设置的最大值和配额发生冲突。

不带参数时，New-PSTransportOption 为所有选项生成具有 null 值的传输选项对象。 如果省略一个参数，则该对象具有该参数表示的属性的 null 值。 Null 值不会影响会话配置。

有关会话选项的详细信息，请参阅 New-PSSessionOption。 有关会话配置的详细信息，请参阅 about_Session_Configurations。

此 cmdlet 是在 Windows PowerShell 3.0 中引入的。

示例

示例 1：生成默认传输选项

New-PSTransportOption

ProcessIdleTimeoutSec           :
MaxIdleTimeoutSec               :
MaxSessions                     :
MaxConcurrentCommandsPerSession :
MaxSessionsPerUser              :
MaxMemoryPerSessionMB           :
MaxProcessesPerSession          :
MaxConcurrentUsers              :
IdleTimeoutSec                  :
OutputBufferingMode             :

该命令在没有参数的情况下运行 New-PSTransportOption。 输出显示该 cmdlet 为所有属性生成具有 null 值的传输选项对象。

示例 2：获取会话配置选项

此示例演示如何使用传输选项对象来设置会话配置选项。

$t = New-PSTransportOption -MaxSessions 40
Register-PSSessionConfiguration -Name ITTasks -TransportOption $t
Get-PSSessionConfiguration -Name ITTasks | Format-List -Property *

Architecture                  : 64
Filename                      : %windir%\system32\pwrshplugin.dll
ResourceUri                   : http://schemas.microsoft.com/powershell/ITTasks
MaxConcurrentCommandsPerShell : 1000
UseSharedProcess              : false
ProcessIdleTimeoutSec         : 0
xmlns                         : http://schemas.microsoft.com/wbem/wsman/1/config/PluginConfiguration
MaxConcurrentUsers            : 5
lang                          : en-US
SupportsOptions               : true
ExactMatch                    : true
RunAsUser                     :
IdleTimeoutms                 : 7200000
PSVersion                     : 3.0
OutputBufferingMode           : Block
AutoRestart                   : false
MaxShells                     : 40
MaxMemoryPerShellMB           : 1024
MaxIdleTimeoutms              : 43200000
SDKVersion                    : 2
Name                          : ITTasks
XmlRenderingType              : text
Capability                    : {Shell}
RunAsPassword                 :
MaxProcessesPerShell          : 15
Enabled                       : True
MaxShellsPerUser              : 25
Permission                    :

第一个命令使用 New-PSTransportOption cmdlet 创建传输选项对象，将其保存在 $t 变量中。 该命令使用 MaxSessions 参数将会话的最大数量增加到 40。

第二个命令使用 Register-PSSessionConfiguration cmdlet 创建 ITTasks 会话配置。 该命令使用 TransportOption 参数指定 $t 变量中的传输选项对象。

第三个命令使用 Get-PSSessionConfiguration cmdlet 获取 ITTasks 会话配置，使用 Format-List cmdlet 在列表中显示会话配置对象的所有属性。 输出显示会话配置的 MaxShells 属性的值为 40。

示例 3：设置传输选项

此命令显示在使用会话配置的会话上设置会话配置中的传输选项的效果。

$t = New-PSTransportOption -IdleTimeoutSec 3600
Set-PSSessionConfiguration -Name ITTasks -TransportOption $t
$s = New-PSSession -Name MyITTasks -ConfigurationName ITTasks
$s | Format-List -Property *

State                  : Opened
IdleTimeout            : 3600000
OutputBufferingMode    : Block
ComputerName           : localhost
ConfigurationName      : ITTasks
InstanceId             : 4110c3f5-68ea-40fa-9bbf-04a433dbb02d
Id                     : 1
Name                   : MyITTasks
Availability           : Available
ApplicationPrivateData : {PSVersionTable}
Runspace               : System.Management.Automation.RemoteRunspace

第一个命令使用 New-PSTransportOption cmdlet 创建传输选项对象。 该命令使用 IdleTimeoutSec 参数将对象的 IdleTimeoutSec 属性值设置为一小时（3600 秒）。 该命令将传输对象保存在 $t 变量中。

第二个命令使用 Set-PSSessionConfiguration cmdlet 更改 ITTasks 会话配置的传输选项。 该命令使用 TransportOption 参数指定 $t 变量中的传输选项对象。

第三个命令使用 New-PSSession cmdlet 创建本地计算机上的 MyITTasks 会话。 该命令使用 ConfigurationName 属性指定 ITTasks 会话配置。 该命令将会话保存在 $s 变量中。请注意，该命令不使用 的 SessionOptionNew-PSSession 参数来设置会话的自定义空闲超时。 如果它执行了此操作，则在会话选项中设置的空闲超时值将优先于在会话配置中设置的空闲超时。

第四个命令使用 Format-List cmdlet 显示列表中 $s 变量中的会话的所有属性。 此输出显示会话具有一小时（360,000 毫秒）的空闲超时。

参数

-IdleTimeoutSec

确定当远程计算机没有从本地计算机接收任何通信时，每个会话保持打开状态的时长。 包括检测信号。 当时间间隔已过时，该会话将关闭。

当用户想要断开连接并重新连接到会话时，空闲超时值非常重要。 仅当会话未超时时，用户才可以重新连接。

IdleTimeoutSec 参数对应于会话配置的 IdleTimeoutMs 属性。

输入一个值（以秒为单位）。 默认值为 7200（2 小时）。 最小值为 60（1 分钟）。 最大为 WSMan 配置 (WSMan:\\\<ComputerName\>\Shell\IdleTimeout) 中的 Shell 对象的 IdleTimeout 属性的值。 默认值为 7200000 毫秒（2 小时）。

如果在会话选项和会话配置中设置空闲超时值，则在会话选项中设置的值优先，但它不能超过会话配置的 MaxIdleTimeoutMs 属性的值。 若要设置 MaxIdleTimeoutMs 属性的值，请使用 MaxIdleTimeoutSec 参数。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxConcurrentCommandsPerSession

将可以同时在每个会话中运行的命令数限制为指定的值。 默认值为 1000。

MaxConcurrentCommandsPerSession 参数对应于会话配置的 MaxConcurrentCommandsPerShell 属性。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxConcurrentUsers

将可以同时在每个会话中运行命令的用户数限制为指定的值。 默认值为 5。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxIdleTimeoutSec

将为每个会话设置的空闲超时值限制为指定的值。 默认值为 [Int]::MaxValue（约 25 天）。

当用户想要断开连接并重新连接到会话时，空闲超时值非常重要。 仅当会话未超时时，用户才可以重新连接。

MaxIdleTimeoutSec 参数对应于会话配置的 MaxIdleTimeoutMs 属性。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxMemoryPerSessionMB

将每个会话使用的内存限制为指定的值。 输入一个值（以兆字节为单位）。 默认值为 1024 兆字节 (1 GB)。

MaxMemoryPerSessionMB 参数对应于会话配置的 MaxMemoryPerShellMB 属性。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxProcessesPerSession

将在每个会话中运行的进程数限制为指定的值。 默认值为 15。

MaxProcessesPerSession 参数对应于会话配置的 MaxProcessesPerShell 属性。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxSessions

限制使用会话配置的会话数。 默认值为 25。

MaxSessions 参数对应于会话配置的 MaxShells 属性。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxSessionsPerUser

将使用会话配置和使用给定用户的凭据运行的会话数限制为指定的值。 默认值为 25。

当指定此值时，请考虑许多用户可能使用以用户身份运行的凭据。

MaxSessionsPerUser 参数对应于会话配置的 MaxShellsPerUser 属性。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OutputBufferingMode

当输出缓冲区时已满时，确定如何在断开连接的会话中管理命令输出。 此参数的可接受值为：

  • Block 当输出缓冲区已满时，将挂起执行，直到清除此缓冲区。
  • Drop 当输出缓冲区已满时，执行将继续。 由于已保存新的输出，因此将丢弃最早的输出。
  • None 未指定任何输出缓冲模式。

会话的 OutputBufferingMode 属性的默认值为 Block。

Type:Nullable<T>[OutputBufferingMode]
Accepted values:None, Drop, Block
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProcessIdleTimeoutSec

将每个主机进程的超时值限制为指定的值。 默认值为 0，意味着该进程没有超时值。

其他会话配置具有每个进程的超时值。 例如，Microsoft.PowerShell.Workflow 会话配置具有 28800 秒（8 小时）的每个进程的超时值。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

WSManConfigurationOption

备注

  • 会话配置对象的属性会根据为会话配置设置的选项以及这些选项的值而有所不同。 此外，使用会话配置文件的会话配置还具有其他属性。