機能説明
指定したサーバの電源状態を取得します。
オプション
基本オプション
電源状態を取得するサーバのホスト名またはIPアドレスです。
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
拡張オプション
電源状態を取得するサーバのIPMIに設定されているIPアドレスです。
IPアドレスの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したIPアドレスの値をSystemwalker Runbook Automationが自動的に設定します。
IPアドレスの文字列の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
電源状態を取得するサーバのIPMIに設定されているユーザー名です。
ユーザー名またはパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ユーザー名の文字列の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
電源状態を取得するサーバのIPMIに設定されているユーザーのパスワードです。
ユーザー名またはパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したパスワードの値をSystemwalker Runbook Automationが自動的に設定します。
パスワードの文字列の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
運用操作部品の実行の完了待ち合わせ時間(秒)です。
300～86,400(1日)の範囲で指定が可能です。
(例) 完了待ち合わせを10分間行う場合：600
指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。
運用操作部品の実行の起動リトライ回数です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。
起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。
(例) 起動リトライを2回行う場合：2
運用操作部品のリトライ間隔(秒)です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行うまでの間隔を指定します。1～14400の範囲で指定が可能です。
(例) 300秒間隔でリトライを行う場合：300
timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。
復帰値
アイコン | シンボル名 | 復帰値 | 意味 |
|---|---|---|---|
| 電源OFF | 0 | 電源状態の取得に成功しました。電源はOFFです。 |
| 電源ON | 1 | 電源状態の取得に成功しました。電源はONです。 |
| 失敗 | 161 | 電源状態の取得に失敗しました。リトライ回数を指定した場合、リトライします。 |
189 | サーバに接続できませんでした。 | ||
197 | オプションの内容に誤りがありました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message | サーバの電源状態の取得に成功した場合、以下の文字列を設定します。
サーバの電源状態の取得に失敗した場合、エラー内容を文字列として設定します。 |
returnCode | 復帰値を設定します。 |
注意事項
本運用操作部品を利用してサーバの電源状態を取得する場合には、業務サーバのハードウェアが以下の仕様に対応している必要があります。
IPMI V2.0
IPMIが設定されていない環境では、IPMIの設定を行ってください。
本運用操作部品では、ipmiipaddress、ipmiusername、ipmipasswordの入力を省略した場合、CMDBに格納された値をSystemwalker Runbook Automationが自動的に設定します。そのため、CMDBに格納された値を利用する場合、必要となる情報を事前にCMDBへswrba_ipmiimportコマンドを利用して格納する必要があります。CMDBへ情報を格納する場合、パスワードは省略しないでください。swrba_ipmiimportコマンドの詳細については、“1.4.12 swrba_ipmiimport(IPMI情報のインポートコマンド)”を参照してください。
swrba_ipmiimportコマンドで指定する入力ファイル(CSV形式)の例
"処理を行うサーバのIPアドレス","IPMIのIPアドレス","IPMIのユーザー名","IPMIのパスワード"
本運用操作部品の使用にあたり、業務サーバで通信の許可が必要になる通信ポートはUDPの623番です。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
「～」「￡」「―」「∥」「￠」「￢」「￣」「￥」「〃」
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
