Set-RdsHostPool
ホスト プールのプロパティを設定します。
構文
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-FriendlyName <String>]
[-Description <String>]
[-MaxSessionLimit <Int32>]
[-ValidationEnv <bool>]
[-AssignmentType {Automatic | Direct}]
[<CommonParameters>]
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-BreadthFirstLoadBalancer]
[-MaxSessionLimit <Int32>]
[-ValidationEnv <bool>]
[-AssignmentType {Automatic | Direct}]
[<CommonParameters>]
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-DepthFirstLoadBalancer]
-MaxSessionLimit <Int32>
[-ValidationEnv <bool>]
[-AssignmentType {Automatic | Direct}]
[<CommonParameters>]
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-CustomRdpProperty <String>]
[-ValidationEnv <bool>]
[-AssignmentType {Automatic | Direct}]
[<CommonParameters>]
Set-RdsHostPool
[-TenantName] <String>
[-Name] <String>
[-ValidationEnv <bool>]
[-Ring <int>]
[-AssignmentType {Automatic | Direct}]
[<CommonParameters>]
説明
Set-RdsHostPool コマンドレットは、指定したホスト プールのプロパティを設定します。 このコマンドレットには 3 つのパラメーター セットがあります。 1 つ目は、ユーザープロファイルディスクを無効にするために使用されます。 2 つ目は、ユーザー・プロファイル・ディスクを使用可能にするために使用されます。 3 つ目は、ホスト プールの他のすべてのプロパティを設定するために使用されます。
例
例 1: 深さ優先の負荷分散を使用するようにホスト プールを設定する
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -DepthFirstLoadBalancer -MaxSessionLimit 10
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
FriendlyName :
Description :
Persistent : False
CustomRdpProperty :
MaxSessionLimit : 10
LoadBalancerType : DepthFirst
ValidationEnv : False
Ring :
AssignmentType :
このコマンドは、深さ優先のロード・バランシングを使用するようにホスト・プールを設定し、受信ユーザー全員が MaxSessionLimit (この例では 10 に指定) に達するまで特定のセッション・ホストに転送されます。 MaxSessionLimit パラメータは、最初のセッション ホストでこのセッション制限に達するまで接続が後続のセッション ホストに分散されないため、深さ優先のロード バランシングを設定する際の要件です。
例 2: 幅優先の負荷分散を使用するようにホスト プールを設定する
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -BreadthFirstLoadBalancer
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
FriendlyName :
Description :
Persistent : False
CustomRdpProperty :
MaxSessionLimit : 10
LoadBalancerType : BreadthFirst
ValidationEnv : False
Ring :
AssignmentType :
このコマンドは、ホスト プールが幅優先のロード バランシングを使用するように設定し、受信ユーザーがホスト プール内のセッション ホスト間で均等に誘導されるようにします。 幅優先モードのロード・バランシングは、深さ優先モードのロード・バランシングよりも制限が少ないため、MaxSessionLimit パラメータはオプションです。
例 3: ホスト プールを検証環境として扱うように設定します
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -ValidationEnv $true
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
FriendlyName :
Description :
Persistent : False
CustomRdpProperty : use multimon:i:0;
MaxSessionLimit : 10
LoadBalancerType : BreadthFirst
ValidationEnv : True
Ring :
AssignmentType :
このコマンドは、ホスト・プールを検証ホスト・プールとして設定します。 検証ホスト プールは、サービスの更新をより速い頻度で受信するため、サービスの変更を運用環境に広くデプロイする前にテストできます。
例 4: 直接割り当てを使用するようにホスト プールを設定する
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Direct
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Direct
このコマンドは、直接割り当てを使用するようにホスト プールを設定して、ユーザーに割り当てる個人用デスクトップ セッション ホストを決定します。 直接割り当てでは、ホスト・プールに接続する前に、ユーザーをセッション・ホストに割り当てる必要があります。
例 5: 自動割り当てを使用するようにホスト プールを設定する
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Automatic
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Automatic
このコマンドは、自動割り当てを使用して、ユーザーに割り当てるパーソナル デスクトップ セッション ホストを決定するようにホスト プールを設定します。 自動割り当てでは、ホストプールに接続する前にユーザーをセッションホストに割り当てる必要はありません。
例 4: 直接割り当てを使用するようにホスト プールを設定する
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Direct
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Direct
このコマンドは、直接割り当てを使用するようにホスト プールを設定して、ユーザーに割り当てる個人用デスクトップ セッション ホストを決定します。 直接割り当てでは、ホスト・プールに接続する前に、ユーザーをセッション・ホストに割り当てる必要があります。
例 5: 自動割り当てを使用するようにホスト プールを設定する
PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Automatic
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
FriendlyName :
Description :
Persistent : True
CustomRdpProperty :
MaxSessionLimit : 999999
LoadBalancerType : Persistent
ValidationEnv : False
Ring :
AssignmentType : Automatic
このコマンドは、自動割り当てを使用して、ユーザーに割り当てるパーソナル デスクトップ セッション ホストを決定するようにホスト プールを設定します。 自動割り当てでは、ホストプールに接続する前にユーザーをセッションホストに割り当てる必要はありません。
パラメーター
-AssignmentType
パーソナル デスクトップ ホスト プールの割り当てタイプ:
- [自動] は、ユーザーがホスト プールに初めて接続したときに、セッション ホストが自動的に割り当てられることを意味します。
- 直接、つまり、ユーザーは接続する前にプール内のセッション ホストに直接割り当てる必要があります。
型: | PersonalDesktopAssignmentType |
指定可能な値: | Automatic, Direct |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-BreadthFirstLoadBalancer
ホスト プールの幅優先ロード バランシングの使用を有効にするスイッチを切り替えます。 幅優先は、新しいユーザーセッションがユーザーセッションの数が最も少ないセッションホストに転送されることを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CustomRdpProperty
このコレクションで公開されているすべての RemoteApp プログラムとリモート デスクトップの .rdp ファイルに含めるリモート デスクトップ プロトコル (RDP) 設定を指定します。 詳細については、 サポートされているリモート デスクトップ RDP ファイル設定 を参照してください。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DepthFirstLoadBalancer
ホストプールの深さ優先ロードバランシングの使用を有効にするように切り替えます。 深さ優先は、新しいユーザーセッションが、最大セッション制限にまだ達していないユーザーセッションの数が最も多いセッションホストに転送されることを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Description
ホスト プールの説明。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-FriendlyName
表示するホスト・プールのフレンドリ名。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-MaxSessionLimit
ホスト プール内のセッション ホストごとに許可されるセッションの最大数。 ロード・バランシングに深さ優先モードが設定されている場合、この値は、1 つのホストへのユーザーのロード・バランシングを停止し、次のホストへのユーザーの送信を開始するタイミングを決定するために使用されます。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
ホスト プールの名前。
型: | String |
Aliases: | HostPoolName |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TenantName
テナントの名前。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ValidationEnv
ホスト プールを検証ホスト プールとして扱う必要があるかどうかを示すブール値。 検証ホスト プールは、非検証ホスト プールよりも速い頻度でサービス更新を受け取るため、サービスの変更を運用環境に広くデプロイする前にテストできます。
型: | String |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
System.String
出力
Microsoft.RDInfra.RDManagementData.RdMgmtHostPool