5.5.22 ネットワークアダプタの設定変更
機能
VMware vSphere環境で，仮想サーバに割り当てられているネットワークアダプタの設定を変更します。
接続先ネットワークは次のどれかの方法で指定してください。
(1)標準仮想スイッチのポートグループ名(VMware.connectionPortGroupNameプロパティ)を指定する。
(2)分散ポートグループ名(VMware.connectionVDPortGroupNameプロパティ)を指定する。
(3)分散仮想スイッチ名(VMware.distributedSwitchNameプロパティ)およびポートID(VMware.portIDプロパティ)を指定する。
接続先ネットワークを指定しない場合，接続先ネットワークの変更を行いません。
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。
ネットワークアダプタのタイプ(VMware.vNetworkAdapterTypeプロパティ)について次に示します。
・ネットワークアダプタのタイプを指定します。プロパティとして指定可能な値は，e1000，e1000e，Flexible，EnhancedVmxnet，Vmxnet3です。ただし，前提製品のバージョンによっては指定できないネットワークアダプタのタイプもあります。前提製品で指定可能なネットワークアダプタのタイプを確認した上，値を指定してください。
・ネットワークアダプタのタイプにVMXNET2(拡張)を設定する場合は，EnhancedVmxnetを指定してください。
利用場面
仮想サーバに割り当てられているネットワークアダプタの設定を変更する場合に利用できます。
前提条件
【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server
(2)仮想サーバを管理するVMware vSphere ESXi
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。
(2)VMware vCenter Server上の設定に関する条件
・仮想サーバの名称が一意であること。
・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。
そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。
- 仮想サーバ名
- ポートグループ名
- 分散ポートグループ名
- 分散仮想スイッチ名
【実行対象サーバ内前提製品】
・VMware PowerCLI
【実行対象サーバ内前提製品の稼働OS】
・Windows Server
注意事項
(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)接続先ネットワークを複数の方法で指定した場合，この部品は異常終了します。
(3)接続先ネットワークを指定し，戻り値27でこの部品が異常終了した場合，接続先ネットワークに接続され，設定変更が失敗していることがあります。その場合，タスクログのエラーメッセージに従い原因を取り除いたあと，この部品を再実行してください。
(4)この部品を同一のネットワークアダプタに対し，複数同時に実行しないでください。同時に実行した場合，部品は正常終了しますが，ネットワークアダプタに不正な値が設定されるおそれがあります。
実行権限
(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。
バージョン
02.11.00
部品のタグ
Modify VM,VMware vSphere
タスクログに表示される部品の名称
vsphereSetNetworkAdapter
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
VMware.vCenterServerName |
vCenterサーバ名 |
VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
VMware.userName |
VMware vCenter Serverに接続するためのユーザー名 |
VMware vCenter Serverに接続するためのユーザー名を指定します。 |
− |
入力 |
○ |
|
VMware.password |
VMware vCenter Serverに接続するためのパスワード |
VMware vCenter Serverに接続するためのパスワードを指定します。 |
− |
入力 |
○ |
|
VMware.portNumber |
VMware vCenter Server接続用ポート番号 |
VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。 |
443 |
入力 |
△ |
|
VMware.protocol |
VMware vCenter Server接続用プロトコル |
VMware vCenter Serverに接続するためのプロトコルを指定します。 |
https |
入力 |
○ |
|
VMware.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。 |
− |
入力 |
○ |
|
VMware.targetNetworkAdapter |
ネットワークアダプタ名 |
設定を変更するネットワークアダプタ名を指定します。 |
− |
入力 |
○ |
|
VMware.connectionPortGroupName |
標準仮想スイッチのポートグループ名 |
ネットワークアダプタと接続する標準仮想スイッチのポートグループ名を指定します。 |
− |
入力 |
△ |
|
VMware.connectionDVPortGroupName |
分散ポートグループ名 |
ネットワークアダプタと接続する分散ポートグループ名を指定します。 |
− |
入力 |
△ |
|
VMware.dVSwitchName |
分散仮想スイッチ名 |
ネットワークアダプタと接続する分散仮想スイッチ名を指定します。このプロパティを指定する場合は，ポートIDも必ず併せて指定してください。 |
− |
入力 |
△ |
|
VMware.portID |
ポートID |
ネットワークアダプタと接続する分散仮想スイッチのポートIDを指定します。 |
− |
入力 |
△ |
|
VMware.startConnetedSwitch |
仮想サーバ起動時の接続要否 |
仮想サーバを起動したときに，ネットワークアダプタを接続する場合はtrueを，接続しない場合はfalseを指定します。 |
− |
入力 |
△ |
|
VMware.vNetworkAdapterType |
ネットワークアダプタのタイプ |
ネットワークアダプタのタイプを指定します。指定可能な値は，e1000，e1000e，Flexible，EnhancedVmxnet，Vmxnet3です。 |
− |
入力 |
△ |
|
VMware.wakeOnLanSwitch |
Wake-on-LAN機能の設定 |
ネットワークアダプタのWake-on-LAN機能を有効にする場合はtrueを，無効にする場合はfalseを指定します。 |
− |
入力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |