ページの先頭行へ戻る
Systemwalker Runbook Automation リファレンスガイド
Systemwalker

3.9.2 サーバを停止

機能説明

指定したサーバを停止します。

IPMIを利用して、サーバの停止依頼を行います。

オプション

基本オプション

(1) hostname

運用操作部品を実行する対象のホスト名またはIPアドレスです。

ホスト名またはIPアドレスは複数指定できます。

ホスト名またはIPアドレスを省略した場合、引数エラーとなります。

'localhost'、'127.0.0.1'、'::1'などのループバックインターフェースのホスト名またはIPアドレスを指定した場合、引数エラーとなります。

ホスト名またはIPアドレスの個数の上限は、100個です。それより大きい場合、引数エラーとなります。

指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。

拡張オプション

(1) ipmiipaddress

停止するサーバのIPMIに設定されているIPアドレスです。

IPアドレスの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したIPアドレスの値をSystemwalker Runbook Automationが自動的に設定します。

IPアドレスは複数指定できます。指定する順番は、hostnameに指定したホスト名またはIPアドレスと同じ順番にします。

IPアドレスの個数の上限は、100個です。それより大きい場合、引数エラーとなります。

指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。

(2) ipmiusername

停止するサーバのIPMIに設定されているユーザー名です。

ユーザー名またはパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。

ユーザー名は複数指定できます。指定する順番は、ipmiipaddressに指定した停止するサーバのIPMIに設定されているIPアドレスと同じ順番にします。

ユーザー名の個数の上限は、100個です。それより大きい場合、引数エラーとなります。

指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。

(3) ipmipassword

停止するサーバのIPMIに設定されているユーザーのパスワードです。

ユーザー名またはパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したパスワードの値をSystemwalker Runbook Automationが自動的に設定します。

パスワードは複数指定できます。指定する順番は、ipmiipaddressに指定した停止するサーバのIPMIに設定されているIPアドレスと同じ順番にします。

パスワードの個数の上限は、100個です。それより大きい場合、引数エラーとなります。

指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。

(4) multiplicity

サーバ停止の実行多重度を指定します。

1~100の範囲で指定が可能です。

hostnameに指定されたホスト名またはIPアドレスの個数を超える値が指定された場合、hostnameに指定されたホスト名またはIPアドレスの個数が指定されたものとして動作します。

省略した場合は、1が指定されたものとして動作します。

ipmiipaddressオプションに重複しないIPアドレスを複数指定した場合、実行多重度を指定します。

(5) operationmode

停止するサーバのホスト名またはIPアドレスを複数指定した場合の部品の動作モードを指定します。

指定できる値は以下です。なお、大文字/小文字は区別しません。

  • continue : 指定したホストの最後まで実行する。

  • abort : エラーを検出したホストで処理を中断する。

省略した場合、および上記以外を指定した場合は、"continue"が指定されたものとして動作します。

"abort"を指定し、実行多重度が2以上指定されている場合、エラーを検出した時点で実行中のサーバの処理が終了してから中断します。

停止するサーバのホスト名またはIPアドレスが1つのとき、本オプションの指定は無視されます。

(6) timeout

運用操作部品の実行の完了待ち合わせ時間(秒)です。

300~86,400(1日)の範囲で指定が可能です。

(例) 完了待ち合わせを10分間行う場合:600

指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値:201で中断します。

(7) retry

運用操作部品の実行の起動リトライ回数です。

運用操作部品が復帰値:161で終了した場合に、起動リトライを行う回数を指定します。0~5の範囲で指定が可能です。

起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。

(例) 起動リトライを2回行う場合:2

なお、停止するサーバのホスト名またはIPアドレスを複数指定した場合、起動リトライはしません。

(8) retry_interval

運用操作部品のリトライ間隔(秒)です。

運用操作部品が復帰値:161で終了した場合に、起動リトライを行うまでの間隔を指定します。1~14400の範囲で指定が可能です。

(例) 300秒間隔でリトライを行う場合:300


timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。

復帰値

アイコン

シンボル名
矢印名

復帰値

意味

成功

0

サーバの停止依頼に成功しました。

失敗

161

サーバの停止依頼に失敗しました。リトライ回数を指定した場合、リトライします。なお、ホスト名を複数指定した場合、リトライしません。

180

複数の操作に失敗しました。各ホストに対する操作の復帰値は、出力情報:server_stop_resultの"Return_code"を確認してください。

189

サーバに接続できませんでした。

197

オプションの内容に誤りがありました。

201

運用操作部品の実行がタイムアウトしました。

202

運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。

203

運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。

205

運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。

206

運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。

207

運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。

208

運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。

出力情報

変数

意味

message

  • hostnameにホスト名またはIPアドレスを1個指定した場合

    サーバの停止依頼に成功した場合、以下のメッセージを設定します。

    The operation component was successful.

    サーバの停止依頼に失敗した場合、エラー内容を文字列として設定します。

  • hostnameにホスト名またはIPアドレスを複数指定した場合

    すべてのサーバの停止依頼に成功した場合、以下のメッセージを設定します。

    The operation component was successful.

    一部、または、すべてのサーバの停止依頼に失敗した場合、失敗したサーバの情報をserver_stop_resultと同じ形式で出力します。

server_stop_result

指定したサーバに対して実行した結果を設定します。

server_stop_list

停止依頼に成功したサーバの一覧をCSV形式で設定します。

server_stop_fault_list

停止依頼に失敗したサーバの一覧をCSV形式で設定します。

returnCode

復帰値を設定します。

server_stop_resultの出力形式は以下です。

[hostname],[復帰値],[出力情報],[メッセージ]


[出力情報]には、何も出力しません。

[メッセージ]には以下を出力します。

<例>

hostnameに"host1,host2,host3"を指定し、host3のサーバの停止依頼に失敗した場合

"hostname",Return_code, "Output","Message"
"host1",0,"","Success"
"host2",0,"","Success"
"host3",161,"","Lanplus RAKP2 HMAC don't match with BMC"


上記の例の場合、messageには以下が出力されます。

<例>

"hostname",Return_code, "Output","Message"
"host3",161,"","Lanplus RAKP2 HMAC don't match with BMC"

注意事項