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

スポンサーリンク
Microsoft Public Affiliate Program (JP)(マイクロソフトアフィリエイトプログラム)

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

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

Get-SCLoadBalancer コマンドレット

名前

Get-SCLoadBalancer

概要

ロード バランサー オブジェクトを取得します。

構文

Get-SCLoadBalancer
 [[-LoadBalancerAddress] <String>]
 [-All]
 [-LogicalNetwork <LogicalNetwork[]>]
 [-Manufacturer <String>]
 [-Model <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Get-SCLoadBalancer
 [[-LoadBalancerAddress] <String>]
 -Cloud <Cloud>
 [-LogicalNetwork <LogicalNetwork[]>]
 [-Manufacturer <String>]
 [-Model <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Get-SCLoadBalancer
 [[-LoadBalancerAddress] <String>]
 -CloudRootHostGroup <HostGroup[]>
 [-LogicalNetwork <LogicalNetwork[]>]
 [-Manufacturer <String>]
 [-Model <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Get-SCLoadBalancer
 [[-LoadBalancerAddress] <String>]
 -CloudRootVMwareResourcePool <VmwResourcePool>
 [-LogicalNetwork <LogicalNetwork[]>]
 [-Manufacturer <String>]
 [-Model <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Get-SCLoadBalancer
 [[-LoadBalancerAddress] <String>]
 -ID <Guid>
 [-LogicalNetwork <LogicalNetwork[]>]
 [-Manufacturer <String>]
 [-Model <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Get-SCLoadBalancer
 [[-LoadBalancerAddress] <String>]
 [-LogicalNetwork <LogicalNetwork[]>]
 [-Manufacturer <String>]
 [-Model <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 -VMHostGroup <HostGroup>
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

説明

Get-SCLoadBalancer コマンドレットは、複数のロード バランサー オブジェクト情報を取得します。

パラメーター

-All [<SwitchParameter>]

このコマンドレットが親オブジェクトから独立したすべての従属オブジェクトを取得する場合に指定します。例えば、コマンド Get-SCVirtualDiskDrive -All は、各仮想ディスク ドライブ オブジェクトが関連付けられている仮想マシン オブジェクト、もしくはテンプレート オブジェクトに関係なく、すべての仮想ディスク ドライブ オブジェクトを取得します。

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

-Cloud <Cloud>

プライベート クラウド オブジェクトを指定します。

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

-CloudRootHostGroup <HostGroup[]>

プライベート クラウドに対して定義されたホスト グループを指定します。

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

-CloudRootVMwareResourcePool <VmwResourcePool>

プライベート クラウドに対するルート レベルで定義された VMware リソース プールを指定します。

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

-ID <Guid>

特定のオブジェクトに対するグローバル一意識別子、もしくは GUID として数値 ID を指定します。

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

-LoadBalancerAddress <String>

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

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

-LogicalNetwork <LogicalNetwork[]>

論理ネットワークを指定します。論理ネットワークは、IP サブネットと VLAN の名前付きグループであり、ネットワークの割り当てを整理して単純化するために使用されます。

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

-Manufacturer <String>

物理デバイスを製造した会社名を指定します。有効な文字は、次のとおり :

  • 英字 (a-z)
  • 数字 (0-9)
  • アンダースコア (_)
  • ハイフン (-)
  • ドット (.)
  • 一重引用符 (‘)
必須 false
位置 named
既定値 None
パイプライン入力を許可する False
ワイルドカード文字を許可する false

-Model <String>

物理デバイスのモデルを指定します。

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

-OnBehalfOfUser <String>

ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーの代わりに操作します。

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

-OnBehalfOfUserRole <UserRole>

ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。

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

-VMHostGroup <HostGroup>

仮想マシン ホスト グループ オフジェクトを指定します。

必須 true
位置 named
既定値 None
パイプライン入力を許可する 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 : ホスト グループに対するすべてのロード バランサー情報を取得する

コマンド
$HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup01" }
$LoadBalancers = Get-SCLoadBalancer -VMHostGroup $HostGroup
$LoadBalancers
コマンドの説明

最初のコマンドは、ホスト グループ オブジェクト “All Hosts\HostGroup01” を取得し、そのオブジェクトを $HostGroup 変数に格納します。

2 番目のコマンドは、$HostGroup に格納されたホスト グループにアクセス可能なすべてのロード バランサーオブジェクトを取得し、そのオブジェクトを $LoadBalancers 変数に格納します。

最後のコマンドは、$LoadBalancers に格納された各ロード バランサーに関する情報を表示します。

例 2 : ホスト グループに対する与えられた種類のすべてのロード バランサー情報を取得する

コマンド
$HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup02\Production" }
$LoadBalancers = Get-SCLoadBalancer -VMHostGroup $HostGroup -Manufacturer "LB Manufacturer" -Model "LB01"
$LoadBalancers
コマンドの説明

最初のコマンドは、ホスト グループ オブジェクト “All Hosts\HostGroup02\Production” を取得し、$HostGroup 変数に格納します。

2 番目のコマンドは、$HostGroup に格納されたホスト グループにアクセス可能な指定した物理デバイスを製造した会社 “LB Manufacturer” および物理デバイスのモデル “LB01” を持つロード バランサー オブジェクトを取得し、そのオブジェクトを $LoadBalancers 変数に格納します。

最後のコマンドは、$LoadBalancers に格納された各ロード バランサーに関する情報を表示します。

関連するリンク

  • Add-SCLoadBalancer
  • Get-SCVMHostGroup
  • Read-SCLoadBalancer
  • Remove-SCLoadBalancer
  • Set-SCLoadBalancer
  • Test-SCLoadBalancer

参考