Broker PowerShell SDKコマンド

最終公開日 : Nov 13, 2026
Broker PowerShell SDKを使用して、デリバリーグループのAutoscaleを構成できます。PowerShellコマンドを使用してAutoscaleを構成するには、PowerShell SDKバージョン7.21.0.12以降を使用する必要があります。PowerShell SDKの詳細については、「SDKとAPI」(/ja-jp/citrix-virtual-apps-desktops/2511/sdk-api.html)を参照してください。
Related information
オートスケール™

Set-BrokerDesktopGroup

既存のBrokerDesktopGroupを無効または有効にするか、その設定を変更します。このコマンドレットの詳細については、<https://citrix.github.io/delivery-controller-sdk/Broker/Set-BrokerDesktopGroup/>を参照してください。

例

PowerShellコマンドレットの使用方法の詳細については、以下の例を参照してください。
Autoscale™を有効にする
  • 名前が「MyDesktop」であるデリバリーグループに対してAutoscaleを有効にしたいとします。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例:
    • PS C:\> Set-BrokerDesktopGroup "MyDesktop" -AutoscalingEnabled $true
容量バッファをピーク時とオフピーク時で個別に構成する
  • 名前が「MyDesktop」であるデリバリーグループに対して、容量バッファをピーク時は20%、オフピーク時は10%に設定したいとします。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例:
    • PS C:\> Set-BrokerDesktopGroup "MyDesktop" -PeakBufferSizePercent 20 -OffPeakBufferSizePercent 10
切断時のタイムアウト設定を構成する
  • 名前が「MyDesktop」であるデリバリーグループに対して、切断時のタイムアウト値をピーク時は60分、オフピーク時は30分に設定したいとします。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例:
    • PS C:\> Set-BrokerDesktopGroup "MyDesktop" -PeakDisconnectTimeout 60 -OffPeakDisconnectTimeout 30
ログオフ時のタイムアウト設定を構成する
  • 「MyDesktop」という名前のデリバリーグループについて、ピーク時のログオフ時のタイムアウト値を60分に、オフピーク時の値を30分に設定するとします。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例:
    • PS C:\> Set-BrokerDesktopGroup "MyDesktop" -PeakLogOffTimeout 60 -OffPeakLogOffTimeout 30
電源オフ遅延設定を構成する
  • 「MyDesktop」という名前のデリバリーグループについて、電源オフ遅延を15分に設定するとします。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例:
    • PS C:\> Set-BrokerDesktopGroup "MyDesktop" -PowerOffDelay 15
電源オフ遅延が適用されない期間を構成する
  • 「MyDesktop」という名前のデリバリーグループについて、30分経過するまで電源オフ遅延を適用するとします。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例:
    • C:\PS> Set-BrokerDesktopGroup "MyDesktop" -SettlementPeriodBeforeAutoShutdown 30。
マシンインスタンスコスト設定を構成する
  • 「MyDesktop」という名前のデリバリーグループについて、1時間あたりのマシンインスタンスコストを0.2ドルに設定するとします。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例:
    • PS C:\> Set-BrokerDesktopGroup "MyDesktop" -MachineCost 0.2
メンテナンスモードのVMをオートスケールプールから除外する
  • 10台のマシンを持つデリバリーグループがあり、そのうち2台のマシンがメンテナンスモードであるとします。オートスケールのバッファ容量は50%に設定されています。メンテナンスモードのVMをオートスケールプールから除外したい場合は、PoolSizeExcludesMaintenanceModeをTrueに設定します。メンテナンスモードの2台のマシンはマシンプールに含まれないため、オートスケールは4台のマシンを起動します。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例:
    • PS C:\> Set-BrokerDesktopGroup -PoolSizeExcludesMaintenanceMode $true
    シングルセッションのデリバリーグループのPoolSizeExcludesMaintenanceModeのデフォルト値はFalseです。
    マルチセッションのデリバリーグループのPoolSizeExcludesMaintenanceModeのデフォルト値はTrueです。

New-BrokerPowerTimeScheme

デリバリーグループのBrokerPowerTimeSchemeを作成します。詳細については、<https://citrix.github.io/delivery-controller-sdk/Broker/New-BrokerPowerTimeScheme/>を参照してください。

例

UID値が3のデリバリーグループに対して電源時間スキームを作成するとします。新しいスキームは、週末、月曜日、火曜日を対象とします。午前8時から午後6時30分までの時間帯は、スキームに含まれる日のピーク時間として定義されます。ピーク時間の場合、プールサイズ（電源がオンのまま維持されるマシンの数）は20です。オフピーク時間の場合、5です。Set-BrokerDesktopGroup PowerShellコマンドを使用できます。例：
  • PS C:\> $ps48=(0..47 | %{ if ($_ -lt 16 -or $_ -gt 37) { 5 } else { 20 } } )
  • PS C:\> $pt48=(0..47 | %{ if ($_ -lt 16 -or $_ -gt 37) { $false } else { $true } } )
  • PS C:\> New-BrokerPowerTimeScheme -Name 'First Half Week' -DaysOfWeek Weekend,Monday,Tuesday -DesktopGroupUid 3 -PeakHalfHours $pt48 -PoolSize $ps48

動的セッションタイムアウトのパラメーター

以下のBroker PowerShell SDKコマンドレットは、複数の新しいパラメーターをサポートすることで、動的セッションタイムアウトに対応するように拡張されました。
  • Get-BrokerDesktopGroup
  • New-BrokerDesktopGroup
  • Set-BrokerDesktopGroup
これらのパラメーターには以下が含まれます。
  • DisconnectPeakIdleSessionAfterSeconds – ピーク時にアイドル状態のセッションが切断されるまでの時間を秒単位で表します。このプロパティのデフォルト値は0で、ピーク時の関連動作が無効になっていることを示します。0より大きい値は、ピーク時のみデリバリーグループの動作を有効にします。
  • DisconnectOffPeakIdleSessionAfterSeconds - オフピーク時にアイドル状態のセッションが切断されるまでの時間を秒単位で表します。このプロパティのデフォルト値は0で、オフピーク時の関連動作が無効になっていることを示します。0より大きい値は、オフピーク時のみデリバリーグループの関連動作を有効にします。
  • LogoffPeakDisconnectedSessionAfterSeconds - ピーク時に切断されたセッションが終了されるまでの時間を秒単位で表します。このプロパティのデフォルト値は0で、ピーク時の関連動作が無効になっていることを示します。0より大きい値は、ピーク時のみデリバリーグループの関連動作を有効にします。
  • LogoffOffPeakDisconnectedSessionAfterSeconds - オフピーク時に切断されたセッションが終了されるまでの時間を秒単位で表します。このプロパティのデフォルト値は0で、オフピーク時の関連動作が無効になっていることを示します。0より大きい値は、オフピーク時のみデリバリーグループの関連動作を有効にします。

例

名前が「MyDesktop」であるデリバリーグループのピーク時のアイドルセッションタイムアウトを3,600秒に設定するとします。Set-BrokerDesktopGroup PowerShellコマンドを使用します。例：
  • C:\PS> Set-BrokerDesktopGroup "MyDesktop" -DisconnectOffPeakIdleSessionAfterSeconds 3600
これにより、名前が「MyDesktop」であるデスクトップグループのオフピーク時に1時間以上アイドル状態だったセッションが切断されます。