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

スポンサーリンク

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

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

Remove-SCStaticIPAddressPool コマンドレット

名前

Remove-SCStaticIPAddressPool

概要

静的 IP アドレス プールを削除します。

構文

Remove-SCStaticIPAddressPool
 [-StaticIPAddressPool] <StaticIPAddressPool>
 [-Confirm]
 [-Force]
 [-JobVariable <String>]
 [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-VMMServer <ServerConnection>]
 [-WhatIf]
 [<CommonParameters>]

説明

Remove-SCStaticIPAddressPool コマンドレットは、Virtual Machine Manager (VMM) 静的 IP アドレス プールを削除します。

パラメーター

-Confirm [<SwitchParameter>]

コマンドレットの実行前に確認のプロンプトを表示します。

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

-Force [<SwitchParameter>]

ユーザーの確認を求めずにコマンドを強制実行します。

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

-JobVariable <String>

ジョブ進行状況を追跡、格納する変数を指定します。

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

-OnBehalfOfUser <String>

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

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

-OnBehalfOfUserRole <UserRole>

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

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

-PROTipID <Guid>

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

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

-RunAsynchronously [<SwitchParameter>]

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

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

-StaticIPAddressPool <StaticIPAddressPool>

このコマンドレットが削除する静的 IP アドレス プールを指定します。

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

-VMMServer <ServerConnection>

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

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

-WhatIf [<SwitchParameter>]

コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。

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

<CommonParameters>

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

入力

出力

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

メモ

例 1 : 指定されたサブネットの静的 IP アドレス プールを削除する

コマンド
$HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup02\Production" }
$IPPool = Get-SCStaticIPAddressPool -IPv4 -Subnet "10.0.0.0/24" -VMHostGroup $Hostgroup -Name "Production IP Address Pool"
Remove-SCStaticIPAddressPool -StaticIPAddressPool $IPPool
コマンドの説明

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

2 番目のコマンドは、指定されたサブネットの IPv4 アドレスを用いて、$HostGroup 変数に格納されているホスト グループの静的アドレス プール “Production IP Address Pool” を取得します。 継承が有効な場合、このコマンドレットは親ホスト グループも取得します。このコマンドは、プールを $IPPool 変数に格納します。

最後のコマンドは、$IPPool に格納されている静的アドレス プールを削除します。

関連するリンク

  • Get-SCStaticIPAddressPool
  • Get-SCVMHostGroup
  • New-SCStaticIPAddressPool
  • Set-SCStaticIPAddressPool

参考