ページの先頭行へ戻る
Systemwalker Runbook Automation リファレンスガイド
Systemwalker
第3章 運用操作部品リファレンス > 3.9 サーバの操作部品 > 3.9.9 仮想サーバを停止
前次

3.9.9 仮想サーバを停止

機能説明

仮想環境の管理製品に接続して、仮想サーバを停止します。

仮想環境の管理製品には、CMDBに登録されている情報を元に接続します。

オプション

基本オプション

(1) servername

停止するサーバ名です。仮想環境の管理製品に登録されている仮想サーバ名を指定します。

停止するサーバ名は複数指定できます。

ServerView Resource Orchestratorで仮想環境を管理している場合は、L-Server名を指定します。

サーバ名を省略した場合、引数エラーとなります。

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

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

拡張オプション

(1) forcestop

仮想サーバの停止操作の強制オプションです。

仮想サーバのOSのシャットダウン処理を行わずに、強制的に停止する場合に“on”を指定します。

強制停止を行わない場合は、“off”を指定します。

省略値は“off”です。なお、大文字／小文字は区別しません。

(2) multiplicity

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

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

servernameに指定されたサーバ名の個数を超える値が指定された場合、servernameに指定されたサーバ名の個数が指定されたものとして動作します。

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

本オプションに大きな値を指定すると仮想環境の管理製品に負荷がかかる場合があります。

(3) operationmode

停止するサーバ名を複数指定した場合の部品の動作モードを指定します。

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

  • continue : 指定したサーバの最後まで実行する。

  • abort : エラーを検出したサーバで処理を中断する。

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

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

停止するサーバ名が1つのとき、本オプションの指定は無視されます。

(4) timeout

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

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

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

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

(5) retry

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

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

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

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

なお、サーバ名を複数指定した場合、本オプションの指定は無視されます。

(6) retry_interval

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

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

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


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

復帰値

アイコン

シンボル名
矢印名

復帰値

意味

成功

0

仮想サーバの停止に成功しました。

173

仮想サーバは停止中です。

失敗

161

仮想環境の管理製品との通信処理でエラーが発生しました。リトライ回数を指定した場合、リトライします。なお、サーバ名を複数指定した場合、リトライしません。

171

仮想環境の管理製品との通信処理で認証エラーが発生しました。

172

仮想サーバの停止に失敗しました。

180

複数の操作に失敗しました。各サーバに対する操作の復帰値は、出力情報“server_stop_result”の“Return_code”を確認してください。

188

実行中に通信が切断しました。

189

仮想環境の管理サーバに接続できませんでした。

ServerView Resource Orchestratorで仮想環境を管理していない場合、エージェントが導入されているサーバに対して運用操作部品による操作を実施する際に、サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。

197

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

－

－

201

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

202

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

203

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

205

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

206

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

207

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

208

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

出力情報

変数

意味

message

  • servernameにサーバ名を1個指定した場合

    実行結果を示すメッセージを設定します。

  • servernameにサーバ名を複数指定した場合

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

    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],[復帰値],[出力情報],[メッセージ]


[出力情報]には以下を出力します。

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

＜例＞

servernameに"server1,server2,server3"を指定し、server3のサーバの停止に失敗した場合

"servername",Return_code,"Output","Message"
"server1",0,"server1","The virtual server termination processing has been completed.
VirtualServerName=<server1>"
"server2",0,"server2","The virtual server termination processing has been completed.
VirtualServerName=<server2>"
"server3",161,"","Error occurred. VirtualServerName=<server3> detail=<Message='Invalid servername specified
or information registered in CMDB is wrong.'>"

（※）読みやすさのため改行していますが、1つのサーバは1行で出力されます。


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

＜例＞

"servername",Return_code,"Output","Message"
"server3",161,"","Error occurred. VirtualServerName=<server3> detail=<Message='Invalid servername specified
or information registered in CMDB is wrong.'>"

（※）読みやすさのため改行していますが、1つのサーバは1行で出力されます。

注意事項

前次
Copyright 2010-2017 FUJITSU LIMITED