SCVMM 2016 UR5 で利用可能なコマンドレット (Test-SCLoadBalancer) について

スポンサーリンク
Rise of the Tomb Raider

System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。

ここでは Test-SCLoadBalancer コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Test-SCLoadBalancer」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。

Test-SCLoadBalancer コマンドレット

名前

Test-SCLoadBalancer

概要

ロード バランサーをテストします。

構文

Test-SCLoadBalancer
 [-LoadBalancerAddress] <String>
 -ConfigurationProvider <ConfigurationProvider>
 [-JobVariable <String>]
 [-PROTipID <Guid>]
 -Port <UInt16>
 -RunAsAccount <RunAsAccount>
 [-RunAsynchronously]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

説明

Test-SCLoadBalancer コマンドレットは、ロード バランサーに対するテストを実行し、その結果を返します。

パラメーター

-ConfigurationProvider <ConfigurationProvider>

構成プロバイダー オブジェクトを指定します。 構成プロバイダーは、VMM へのプラグインで、VMM PowerShell コマンドをロード バランサーの種類に固有の API 呼び出しに変換します。構成プロバイダーが指定されていない場合、VMM は製造元とモデルの情報を使用して使用可能な構成プロバイダーを選択します。構成プロバイダーが見つからない場合、ロード バランサーは追加されません。

必須true
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-JobVariable <String>

ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-LoadBalancerAddress <String>

ロード バランサーの完全修飾ドメイン名 (FQDN)、もしくは IP アドレスを指定します。通常のフォーマットは FQDN、IPv4 もしくは IPv6 アドレス、ロード バランサーで有効なフォーマットについては、ロード バランサーの製造元に確認する必要があります。

必須true
位置0
既定値None
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

-PROTipID <Guid>

このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-Port <UInt16>

オブジェクトの追加時または接続の作成時に使用するネットワーク ポートを指定します。有効な値 : 1 ~ 4095。

必須true
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-RunAsAccount <RunAsAccount>

このアクションを実行するためのアクセス権を持つ資格情報が含まれる Run As アカウントを指定します。

必須true
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-RunAsynchronously [<SwitchParameter>]

ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-VMMServer <ServerConnection>

VMM サーバー オブジェクトを取得します。

必須false
位置named
既定値None
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。

入力

出力

  • LoadBalancer
    • このコマンドレットは、LoadBalancer オブジェクトを返します。

メモ

例 1 : 指定したロード バランサーをテストします

コマンド
$ConfigProvider = Get-SCConfigurationProvider | where { $_.Type -eq "LoadBalancer" -and $_.Manufacturer -eq "LBManufacturer" -and $_.Model -eq "LB01"}
$RunAsAccount = Get-SCRunAsAccount -Name "LBRunAsAcct"
Test-SCLoadBalancer -LoadBalancerAddress "LB01.Contoso.com" -Port 123 -ConfigurationProvider $ConfigProvider -RunAsAccount $RunAsAccount
コマンドの説明

最初のコマンドは、製造元 “LBManufacturer” とモデル “LB01” の構成プロバイダー オブジェクトを取得し、そのオブジェクトを $ConfigProvider 変数に格納します。

2 番目のコマンドは、実行アカウント “LBRunAsAcct” を取得し、そのオブジェクトを $RunAsAccount 変数に格納します。

最後のコマンドは、テストを実行するための資格情報として $RunAsAccount に格納された実行アカウントを使用して、”LB01.Contoso.com” というアドレスでロード バランサーをテストし、その結果を表示します。

関連するリンク

  • Add-SCLoadBalancer
  • Get-SCConfigurationProvider
  • Get-SCLoadBalancer
  • Read-SCLoadBalancer
  • Remove-SCLoadBalancer
  • Set-SCLoadBalancer

参考