機能説明
VMホストを強制停止します。
オプション
基本オプション
vCenterサーバのホスト名またはIPアドレスです。
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
実行対象とするVMホストのESXサーバ名です。
ESXサーバ名は複数指定できます。
ESXサーバ名を省略した場合、引数エラーとなります。
ESXサーバ名の個数の上限は、100個です。それより大きい場合、引数エラーとなります。
ESXサーバ名の複数指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
拡張オプション
vCenterサーバで操作を実行するユーザー名です。
実行するユーザー名の入力を省略した場合、引数エラーとなります。ただし実行するユーザー名と、実行に必要なパスワードを両方とも省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した“VMware vCenter Server”に関連づけられているユーザーの値をSystemwalker Runbook Automationが自動的に設定します。
実行するユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
vCenterサーバで操作を実行するユーザーのパスワードです。
実行に必要なパスワードの入力を省略した場合、引数エラーとなります。ただし実行するユーザー名と、実行に必要なパスワードを両方とも省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した“VMware vCenter Server”に関連づけられているユーザーのパスワードの値をSystemwalker Runbook Automationが自動的に設定します。
実行に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
vmhostオプションにESXサーバ名を複数指定した場合におけるVMホストに対しての実行多重度を指定します。
1～100の範囲で指定が可能です。
vmhostに指定されたサーバ名の個数を超える値が指定された場合、vmhostに指定されたサーバ名の個数が指定されたものとして動作します。
省略した場合は、10が指定されたものとして動作します。
本オプションに大きな値を指定した場合、vCenterサーバに負荷がかかる場合があります。
vmhostオプションにESXサーバ名を複数指定した場合の運用操作部品の動作モードを指定します。
指定できる値は以下です。なお、大文字／小文字は区別しません。
－ continue : 指定したVMホストの最後まで実行する。
－ abort : エラーを検出したVMホストで処理を中断する。
省略した場合は、“continue”が指定されたものとして動作します。
“abort”を指定し、実行多重度が2以上指定されている場合、エラーを検出した時点で実行中のサーバの処理が終了してから中断します。
ESXサーバ名が1つのとき、本オプションの指定は無視されます。
運用操作部品の実行の完了待ち合わせ時間(秒)です。
300～86,400(1日)の範囲で指定が可能です。
(例) 完了待ち合わせを10分間する場合：600
指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。
運用操作部品の実行の起動リトライ回数です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。
起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。
(例) 起動リトライを2回する場合：2
なお、ESXサーバ名を複数指定した場合、本オプションの指定は無視されます。
運用操作部品のリトライ間隔(秒)です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行うまでの間隔を指定します。1～14400の範囲で指定が可能です。
(例) 300秒間隔でリトライを行う場合：300
timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。“2.5 運用操作部品実行定義ファイル”を参照してください。
復帰値
アイコン | シンボル名 | 復帰値 | 意味 |
|---|---|---|---|
| 成功 | 0 | VMホストの停止に成功しました。 |
| 失敗 | 42 | PowerShellが実行できませんでした。vCenterサーバのPowerShellの実行環境に問題があります。 |
161 | vCenterサーバへの接続または操作に失敗しました。リトライ回数を指定した場合、リトライします。なお、ESXサーバ名を複数指定した場合、リトライしません。 | ||
171 | vCenterサーバとの通信処理で認証エラーが発生しました。 | ||
180 | 複数の操作に失敗しました。各サーバに対する操作の復帰値は、出力情報“vmhost_stop_result”の“Return_code”を確認してください。 | ||
189 | エージェントが導入されているサーバに対して運用操作部品による操作を実施する際に、サーバとの通信処理（ファイル転送基盤）で異常が発生しました。標準エラー出力にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
197 | オプションの内容に誤りがありました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message |
|
vmhost_stop_result | 指定したVMホストに対して実行した結果を設定します。 |
vmhost_stop_list | VMホストの操作に成功したサーバの一覧をCSV形式で設定します。 |
vmhost_stop_fault_list | VMホストの操作に失敗したサーバの一覧をCSV形式で設定します。 |
returnCode | 復帰値を設定します。 |
vmhost_stop_resultの出力形式は以下です。
[hostname],[復帰値],[出力情報],[メッセージ]
[出力情報]には何も出力しません。
[メッセージ]には以下を出力します。
VMホストの操作に成功した場合、"Success"という文字列を出力します。
VMホストの操作に失敗した場合、エラー内容を文字列で出力します。
＜例＞
vmhostに"esx1,esx2,esx3"を指定し、esx3の強制停止に失敗した場合
"vmhost",Return_code,"Output","Message"
"esx1",0,"","Success"
"esx2",0,"","Success"
"esx3",161,"","2012/03/01 16:00:00 Get-VMHost VMHost with name 'esx3' was not found, using the specified filter(s)."
上記の例の場合、messageには以下が出力されます。
＜例＞
"hostname",Return_code,"Output","Message"
"esx3",161,"","2012/03/01 16:00:00 Get-VMHost VMHost with name 'esx3' was not found, using the specified filter(s)."
注意事項
本運用操作部品を利用してVMホストの操作を指示する場合、vCenterサーバにエージェントの導入が必要です。また、vCenterサーバに以下のソフトウェアが必要です。
VMware vSphere PowerCLI
Windows PowerShell
vCenterサーバにおいて、上記を使用するための環境設定が必要です。詳細については、“3.20 vCenterサーバの設定”を参照してください。
本運用操作部品では、vmusername、vmpasswordの入力を省略した場合、CMDBに格納された値をSystemwalker Runbook Automationが自動的に設定します。そのため、CMDBに格納された値を利用する場合、必要となる情報を事前に設定する必要があります。設定方法の詳細については、“3.20 vCenterサーバの設定”の“ServerView Resource Orchestratorで管理していない場合”を参照してください。
本運用操作部品では、vmhostオプションで指定したESXサーバ上で仮想サーバが動作中の場合や、ESXサーバがメンテナンスモードに設定されていない場合でも、強制的にESXサーバを停止します。
vmhostオプションに停止しているESXサーバを指定した場合、復帰値は“0”となります。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
本運用操作部品は以下の仮想化ソフトウェアを対象としています。
VMware vSphere 4.0、4.1、5.0および5.1
