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

3.9.4 OSを再起動

機能説明

指定したサーバのOSを再起動します。

shutdownコマンドにより、OSへ再起動依頼を行います。

オプション

基本オプション

(1) hostname

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

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

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

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

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

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

拡張オプション

(1) deferringtime

OS再起動を開始するまでの猶予時間(分)です。

1~1,440(1日)の範囲で時間指定が可能です。

ただしOSのshutdownコマンドの仕様により、1440分まで猶予できない場合があります。

詳細は、各OSのshutdownコマンドを確認してください。

(例) OS再起動を10分後に開始する場合:10

猶予時間を省略した場合、1分が設定されます。

(2) ostype

OSを再起動するサーバのOS種別です。

Windows、Linux、Solarisを指定します。なお、大文字/小文字は区別しません。

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

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

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

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

(3) username

運用操作部品を実行する対象のホストへSSHを利用して接続するユーザー名です。

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

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

ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。

  • 業務サーバがWindowsの場合: Administrator

  • 業務サーバがLinux、Solarisの場合: root

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

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

(4) password

運用操作部品を実行する対象のホストへSSHを利用して接続するユーザーのパスワードです。

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

接続に必要なパスワードは複数指定できます。指定する順番は、hostnameに指定したホスト名またはIPアドレスと同じ順番にします。

ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。

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

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

(5) execusername

運用操作部品を実行する対象のホストでshutdownコマンドを実行するユーザー名です。

実行ユーザー名およびexecpasswordの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザーの値をSystemwalker Runbook Automationが自動的に設定します。CMDBに登録されていない場合は、接続ユーザー名で実行します。

hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、Administratorユーザーで実行します。このため、ユーザー名を指定しても無効になります。

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

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

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

(6) execpassword

本運用操作部品ではexecpasswordの値を使用しません。execpasswordの値を指定した場合、無効となります。

(7) multiplicity

OS再起動の実行多重度を指定します。

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

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

省略した場合、および上記の範囲を超えた値を指定した場合は、10が指定されたものとして動作します。

(8) operationmode

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

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

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

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

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

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

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

(9) timeout

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

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

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

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

(10) retry

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

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

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

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

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

(11) retry_interval

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

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

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


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

復帰値

アイコン

シンボル名
矢印名

復帰値

意味

成功

0

OSの再起動依頼に成功しました。

失敗

161

OSの再起動依頼に失敗しました。リトライ回数を指定した場合、リトライします。なお、ホスト名を複数指定した場合、リトライしません。

180

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

187

運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)時の認証に失敗しました。

または、運用操作部品による操作を実施する際に、業務サーバとの通信処理(ファイル転送基盤)で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。

188

RBAエージェントが導入されていない業務サーバに対して運用操作部品による操作を実施中に、業務サーバとのネットワーク通信(SSH)が切断されました。

189

運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)できませんでした。

または、運用操作部品による操作を実施する際に、業務サーバとの通信処理(ファイル転送基盤)で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。

197

オプションの指定に誤りがありました。もしくは、構成管理データベース(CMDB)の登録情報に問題があります。

200

OSの再起動が異常終了しました。

201

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

202

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

203

運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。

205

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

206

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

207

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

208

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

出力情報

変数

意味

message

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

    OSの再起動依頼に成功した場合、以下のメッセージを設定します。

    The operation component was successful.

    OSの再起動依頼に失敗した場合、エラー内容を文字列として設定します。

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

    すべてのOSの再起動依頼に成功した場合、以下のメッセージを設定します。

    The operation component was successful.

    一部、または、すべてのOSの再起動依頼に失敗した場合、失敗したOSの再起動依頼の情報をos_reboot_resultと同じ形式で出力します。

os_reboot_result

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

os_reboot_list

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

os_reboot_fault_list

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

returnCode

復帰値を設定します。

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

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


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

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

<例>

hostnameに"host1,host2,host3"を指定し、host3のOSの再起動依頼に失敗した場合

"hostname",Return_code,"Output","Message"
"host1",0,"","Success"
"host2",0,"","Success"
"host3",161,"","-bash: shutdown: command not found"


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

<例>

"hostname",Return_code,"Output","Message"
"host3",161,"","-bash: shutdown: command not found"

注意事項