5.5.3 ESXサーバのメンテナンスモード設定
機能
VMware vSphere環境で，ESXサーバに対して「メンテナンスモードへの切り替え」，または「メンテナンスモードを終了」を実行します。
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・ESXサーバ
VMware vSphere ESXiがインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。
メンテナンスモード(VMware.esxSetMaintenanceModeプロパティ)について次に示します。
・メンテナンスモードに切り替える場合は"ON"を，メンテナンスモードを終了する場合は"OFF"を指定してください。
利用場面
ESXサーバのメンテナンス時にメンテナンスモードへの切り替え，またはメンテナンスモードを終了する場合に使用できます。
前提条件
【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server
(2)仮想サーバを管理するVMware vSphere ESXi
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。
(2)VMware vSphere ESXiの状態が「接続中」または「接続中(メンテナンス モード)」であること。
【実行対象サーバ内前提製品】
・VMware PowerCLI
【実行対象サーバ内前提製品の稼働OS】
・Windows Server
注意事項
(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)ESXサーバがメンテナンスモードの場合に，メンテナンスモード(VMware.esxSetMaintenanceModeプロパティ)に"ON"を指定するとメンテナンスモードへの切り替えをせず，この部品は正常終了します。また，ESXサーバがメンテナンスモードでない場合に，メンテナンスモード(VMware.esxSetMaintenanceModeプロパティ)に"OFF"を指定するとメンテナンスモードの終了をせず，この部品は正常終了します。
(3)クラスタに所属しているESXサーバをメンテナンスモードに切り替える際に，ESXサーバ名(VMware.vmHostNameプロパティ)に指定したESXサーバ上にパワーオフまたはサスペンド中の仮想サーバが存在する場合，仮想サーバを同一のクラスタに所属している別のESXサーバに移動しません。パワーオフまたはサスペンド中の仮想サーバを移動する必要がある場合は，事前に仮想サーバを移動してください。
実行権限
(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。
バージョン
02.11.00
部品のタグ
Modify VM,VMware vSphere
タスクログに表示される部品の名称
vsphereSetMaintenanceMode
戻り値
|
戻り値 |
説明 |
|---|---|
|
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.vmHostName |
ESXサーバ名 |
VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。 |
− |
入力 |
○ |
|
VMware.esxSetMaintenanceMode |
メンテナンスモード |
メンテナンスモードへ切り替える場合は"ON"を，メンテナンスモードを終了する場合は"OFF"を指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |