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

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

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

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

Grant-SCIPAddress コマンドレット

名前

Grant-SCIPAddress

概要

指定されたアドレス プールから静的、もしくは仮想 IP アドレスを割り当てます。

構文

  Grant-SCIPAddress
 [-Description <String>]
 [-DisableReconcile <Boolean>]
 [-ExplicitRevokeRequired <Boolean>]
 [-GrantToObjectID <Guid>]
 -GrantToObjectType {VirtualNetworkAdapter | VIP | HostNetworkAdapter | LoadBalancerConfiguration | VirtualMachine | HostCluster | VMSubnet | NetworkService | NATConnection | NetworkGateway | StorageArray | VMNetworkGateway | None}
 [-IPAddress <String>]
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 -StaticIPAddressPool <StaticIPAddressPool>
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Grant-SCIPAddress
 [-Description <String>]
 [-DisableReconcile <Boolean>]
 [-ExplicitRevokeRequired <Boolean>]
 -IPAddress <String>
 [-JobVariable <String>]
 [-NetworkController <VirtualSwitchExtensionManager>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-Owner <String>]
 [-PROTipID <Guid>]
 -PublicIPAddress
 [-RunAsynchronously]
 [-UserRole <UserRole>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

説明

Grant-SCIPAddress コマンドレットは、指定されたアドレス プールから静的、もしくは仮想 IP アドレスを割り当てます。

特定の IP アドレスを付与するには、IPAddress パラメーターを使用します。それ以外の場合、Virtual Machine Manager (VMM) はアドレス プールから IP アドレスを選択します。

パラメーター

-Description <String>

オブジェクトに対する説明を指定します。

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

-DisableReconcile <Boolean>

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

-ExplicitRevokeRequired <Boolean>

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

-GrantToObjectID <Guid>

割当て済み IP アドレス、もしくは MACアドレスが割当てられるオブジェクト ID を指定します。

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

-GrantToObjectType <AllocatedToObjectType>

割当て済み IP アドレス、もしくは仮想 IP アドレスが割り当てられている AllocatedToObjectType の値を指定します。このパラメーターで利用可能な値は、次のとおり :

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

-IPAddress <String>

IPv4、もしくは IPv6 アドレスを指定します。

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

-JobVariable <String>

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

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

-NetworkController <VirtualSwitchExtensionManager>

ネットワーク コントローラーを指定します。

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

-OnBehalfOfUser <String>

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

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

-OnBehalfOfUserRole <UserRole>

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

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

-Owner <String>

有効なドメイン ユーザー アカウント形式で VMM オブジェクトの所有者を指定します。

  • フォーマット例 : -Owner “Contoso\PattiFuller”
  • フォーマット例 : -Owner “PattiFuller@Contoso”
必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-PROTipID <Guid>

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

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

-PublicIPAddress [<SwitchParameter>]

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

-RunAsynchronously [<SwitchParameter>]

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

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

-StaticIPAddressPool <StaticIPAddressPool>

静的 IP アドレスを割り当てることができる IP アドレス プールを指定します。

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

-UserRole <UserRole>

必須false
位置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 を参照してください。

入力

出力

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

メモ

このコマンドレットには、Get-SCStaticIPAddressPool コマンドレットを用いて取得可能な VMM 静的 IP アドレス プール オブジェクトが必要となります。

例 1 : IP アドレスを割り当てる

コマンド
$VM = Get-SCVirtualMachine -Name "VM01"
$vNICs = $VM.VirtualNetworkAdapters
$IPPool = Get-SCStaticIPAddressPool -Name "Production IP Address Pool"
Grant-SCIPAddress -StaticIPAddressPool $IPPool -GrantToObjectType VirtualNetworkAdapter -GrantToObjectID $v
NICs[0].ID -Description $VM.Name
コマンドの説明

最初のコマンドは、仮想マシン オブジェクト”VM01″ を取得し、そのオブジェクトを $VM 変数を格納します。

2 番目のコマンドは、仮想マシン VM01 の仮想ネットワーク アダプター オブジェクトを取得し、オブジェクトを $vNICs 変数に格納します。

3 番目のコマンドは、静的 IP アドレス プール オブジェクト “Production IP Address Pool” を取得し、そのオブジェクトを $IPPool 変数に格納します。

最後のコマンドは、$IPPool に格納された静的 IP アドレス プールから $vNIC に格納されている最初の仮想ネットワーク アダプターに IP アドレスを割り当て、割当て済み IP アドレスの説明として VM01 を提供します。

関連するリンク

  • Get-SCIPAddress
  • Get-SCVirtualMachine
  • Get-SCStaticIPAddressPool
  • Revoke-SCIPAddress
  • Set-SCIPAddress

参考