5.6.6 仮想サーバの仮想スイッチ設定
機能
この部品は,Hyper-V環境の仮想サーバに仮想スイッチを設定します。
この部品が前提とするサーバを次に示します。
・Hyper-Vサーバ(実行対象サーバ)
Hyper-VがインストールされているWindowsサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
仮想サーバに設定されているNICの中から,指定されたMACアドレスのNICに対し,仮想スイッチを設定します。
NICにすでに設定されている仮想スイッチは,指定された仮想スイッチに上書きされます。
仮想スイッチの指定がない場合,仮想スイッチとの接続が切断された状態になります。
MACアドレスに不正な値が指定された場合や指定がない場合,Hyper-Vの認識するNICの順番に従い,仮想スイッチを設定します。
仮想スイッチは最大4個まで設定することができます。指定した仮想スイッチの数が,仮想サーバが持つNICの数より多い場合,NICに割り当てられなかった仮想スイッチの設定は無効になりますのでご注意ください。
利用場面
この部品は,Hyper-V環境の仮想サーバに仮想スイッチを設定する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
(1)Hyper-Vサーバの前提製品
・Windows Server 2016 Hyper-V
(2)仮想サーバの前提OS
・Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
ただし,Server Core/Nano Serverインストール環境は除く。
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2016 Standard/Datacenter
ただし,Server Core/Nano Serverインストール環境は除く。
【実行対象サーバ内前提製品の使用条件】
(1)仮想サーバ名はHyper-Vサーバ内で一意であること。
(2)仮想スイッチ名はHyper-Vサーバ内で一意であること。
(3)仮想サーバにレガシーネットワークアダプターが設定されていないこと。
バージョン
02.12.00
部品のタグ
Modify VM,Hyper-V 2016
タスクログに表示される部品の名称
hyperv2016SetVirtualSwitch
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
23 |
異常(環境不正) 前提環境不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
hyperv.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
hyperv.virtualSwitch1 |
仮想スイッチ名(1個目用) |
仮想サーバに設定されているNIC(1個目用)に設定する仮想スイッチ名(1個目用)を指定します。 |
− |
入力 |
△ |
OS.nic1MacAddress |
NICのMACアドレス(1個目用) |
仮想スイッチ名(1個目用)を設定するNICのMACアドレスを指定します。 |
− |
入力 |
△ |
hyperv.virtualSwitch2 |
仮想スイッチ名(2個目用) |
仮想サーバに設定されているNIC(2個目用)に設定する仮想スイッチ名(2個目用)を指定します。 |
− |
入力 |
△ |
OS.nic2MacAddress |
NICのMACアドレス(2個目用) |
仮想スイッチ名(2個目用)を設定するNICのMACアドレスを指定します。 |
− |
入力 |
△ |
hyperv.virtualSwitch3 |
仮想スイッチ名(3個目用) |
仮想サーバに設定されているNIC(3個目用)に設定する仮想スイッチ名(3個目用)を指定します。 |
− |
入力 |
△ |
OS.nic3MacAddress |
NICのMACアドレス(3個目用) |
仮想スイッチ名(3個目用)を設定するNICのMACアドレスを指定します。 |
− |
入力 |
△ |
hyperv.virtualSwitch4 |
仮想スイッチ名(4個目用) |
仮想サーバに設定されているNIC(4個目用)に設定する仮想スイッチ名(4個目用)を指定します。 |
− |
入力 |
△ |
OS.nic4MacAddress |
NICのMACアドレス(4個目用) |
仮想スイッチ名(4個目用)を設定するNICのMACアドレスを指定します。 |
− |
入力 |
△ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
− |