5.11.7 HAクラスタの仮想サーバのオプション設定
機能
VMware vSphere環境で，vSphere HAクラスタの仮想サーバの動作を定義するオプションを設定します。
設定できる項目を次に示します。ただし，HAクラスタ名(vmware.haClusterNameプロパティ)と仮想サーバ名(VMware.vmNameプロパティ)は同時に指定できません。
・HAクラスタ名(VMware.haClusterNameプロパティ)を指定した場合。
デフォルトのクラスタ設定の「仮想サーバ再起動の優先順位」および「ホスト隔離時の対応」を設定できます。
・仮想サーバ名(VMware.vmNameプロパティ)を指定した場合。
仮想サーバ設定の「仮想サーバ再起動の優先順位」および「ホスト隔離時の対応」を設定できます。
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・ESXサーバ
VMware vSphere ESXiがインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。
・HAクラスタ
vSphere HAクラスタまたはvSphere HAクラスタを構成しているサーバです。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。
仮想サーバ再起動の優先順位(VMware.haRestartPriorityプロパティ)について次に示します。
・指定できる値を次に示します。ただし，"ClusterRestartPriority"は仮想サーバへの設定にだけ使用できます。
設定値 意味
Disabled 無効
Low 低
Medium 中
High 高
ClusterRestartPriority クラスタ設定の使用
ホスト隔離時の対応(VMware.haIsolationResponseプロパティ)について次に示します。
・指定できる値を次に示します。ただし，"AsSpecifiedByCluster"は仮想サーバへの設定にだけ使用できます。
設定値 意味
PowerOff パワーオフ
DoNothing パワーオンのままにする
Shutdown シャットダウン
AsSpecifiedByCluster クラスタ設定の使用
利用場面
vSphere HAクラスタ構築時または設定変更時に，仮想サーバの動作を定義するオプションを設定する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-10以降
【実行対象システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0
(2)仮想サーバを管理するVMware vSphere ESXの前提製品
・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。
(2)VMware vCenter Server上の設定に関する条件
・vSphere HAクラスタ，仮想サーバの名称が一意であること。
・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。
そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。
- HAクラスタ名
- 仮想サーバ名
(3)vSphere HAクラスタが構築されていること。
【実行対象サーバ内前提製品】
・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0
・VMware PowerCLI 6.5 Release1
・VMware PowerCLI 6.5.1，6.5.4
・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
・Windows Server 2019 Standard/Datacenter
注意事項
(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)HAクラスタ名(VMware.haClusterNameプロパティ)，仮想サーバ名(VMware.vmNameプロパティ)はどちらかを指定してください。どちらも指定されている，またはどちらの指定も無い場合，この部品は異常終了します。
(3)仮想サーバ再起動の優先順位(VMware.haRestartPriorityプロパティ)，ホスト隔離時の対応(VMware.haIsolationResponseプロパティ)はどちらかもしくは両方を指定してください。どちらの指定も無い場合，この部品は異常終了します。
実行権限
(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。
バージョン
02.11.00
部品のタグ
Modify VM,VMware vSphere
タスクログに表示される部品の名称
vsphereSetHaVMOption
戻り値
|
戻り値 |
説明 |
|---|---|
|
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.haClusterName |
HAクラスタ名 |
VMware vCenter Serverが管理するvSphere HAクラスタ名を指定します。 |
− |
入力 |
△ |
|
VMware.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。 |
− |
入力 |
△ |
|
VMware.haRestartPriority |
仮想サーバ再起動の優先順位 |
仮想サーバ再起動の優先順位を指定します。 |
− |
入力 |
△ |
|
VMware.haIsolationResponse |
ホスト隔離時の対応 |
ホスト隔離時の対応を指定します。 |
− |
入力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |