機能説明
サーバが正常に稼働しているか確認します。
具体的には以下の確認を行います。
－ 指定したサービスが起動しているか確認します。
－ 指定したポートに対してTCPによる接続が可能であるか確認します。
管理サーバがWindows(R)の場合、portオプションに値を設定すると以下のようになります。
serviceオプションに値を設定している場合：
portオプションに設定した内容は無視します。
serviceオプションに値を設定していない場合：
運用操作部品の実行はエラーになります。
オプション
基本オプション
運用操作部品を実行する対象のホスト名またはIPアドレスです。
管理サーバで運用操作部品を実行する場合、以下を指定します。
IPv4の場合: 'localhost'または'127.0.0.1'
IPv6の場合: 'localhost'または'::1'
ただし、管理サーバがSELinuxかつ、管理サーバで運用操作部品を実行する場合、管理サーバのホスト名またはIPアドレスを指定します。
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
起動状況を確認するサービス名です。Windowsのサービス名を指定します。
起動状況を確認するホストがLinux、Solarisの場合、サービス名を指定しても無効になります。
サービス名を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したサービス名の値をSystemwalker Runbook Automationが自動的に設定します。
サービス名は複数指定できます。
サービス名の個数の上限は、100個です。それより大きい場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
起動状況を確認するサービス名は、以下のように指定します。
(例) Dhcp
(例) Dhcp,EventLog
接続可能か確認するポート番号またはサービス名です。
サービス名を指定した場合、管理サーバの/etc/servicesに登録されているポート番号を確認します。
ポート番号またはサービス名を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したポート番号またはサービス名の値をSystemwalker Runbook Automationが自動的に設定します。
ポート番号またはサービス名を複数指定できます。ポート番号とサービス名を混在して指定可能です。
ポートの個数の上限は、100個です。それより大きい場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
接続可能か確認するポート番号またはサービス名は、以下のように指定します。
（例）SSHによる接続が可能か確認する場合：“ssh”
（例）22番ポートと25番ポートによる接続が可能か確認する場合：22,25
拡張オプション
運用操作部品を実行するホストのOS種別です。
Windows、Linux、Solarisを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行するホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: Administrator
業務サーバがLinux、Solarisの場合: root
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行するホストへSSHを利用して接続するユーザーのパスワードです。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、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 運用操作部品実行定義ファイル”を参照してください。
復帰値
アイコン | シンボル名 | 復帰値 | 意味 |
|---|---|---|---|
| 正常稼働 | 0 | サーバは正常に稼働しています。 |
| 異常稼働 | 161 | サービスが停止しています。または、ポートの接続確認に失敗しました。リトライ回数を指定した場合、リトライします。 |
| 失敗 | 179 | サービスが見つかりませんでした。 |
187 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)時の認証に失敗しました。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
188 | RBAエージェントが導入されていない業務サーバに対して運用操作部品による操作を実施中に、業務サーバとのネットワーク通信(SSH)が切断されました。 | ||
189 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)できませんでした。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
196 | 管理サーバがWindows(R)の場合に、使用できないオプションが指定されました。 | ||
197 | オプションの内容に誤りがありました。 | ||
200 | サービスの起動確認に失敗しました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。 | ||
203 | 運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message | すべてのサービスの起動確認およびポートの接続確認に成功した場合、以下のメッセージを設定します。 The operation component was successful. 一部、または、すべての確認に失敗した場合、失敗したサービスおよびポートの情報をserver_check_resultと同じ形式で出力します。 サーバの正常稼働の確認に失敗した場合、エラー内容を文字列として設定します。 |
server_check_result | 指定したサービスおよびポートに対して実行した結果を設定します。 |
service_stop_list | サービスの状態が"Stop"のサービス一覧をCSV形式で設定します。 |
port_disconnect_list | 接続できないポート番号の一覧をCSV形式で設定します。 |
returnCode | 復帰値を設定します。 |
server_check_resultの出力形式は以下です。
[service],[復帰値], [出力情報],[メッセージ]
[port],[復帰値], [出力情報],[メッセージ]
[出力情報]には、何も出力しません。
[メッセージ]には以下を出力します。
[service]の場合
サービスが起動していると判断された場合、"Run"という文字列を出力します。
サービスが起動していないと判断された場合、"Stop"という文字列を出力します。
サービスの起動確認に失敗した場合、エラー内容を文字列で出力します。
[port]の場合
ポートの接続確認が成功し、接続が可能である場合、"Success"という文字列を出力します。
ポートの接続確認が失敗した場合、エラー内容を文字列で出力します。
＜例＞
serviceオプションに"service1, service2, service3"を指定し、portオプションに"22,25"を指定した場合
"service",Return_code,"Output","Message"
"service1",0,"","Run"
"service2",0,"","Run"
"service3",161,"","Stop"
"port","Return_code","Output","Message"
"22",0,"","Success"
"25",161,"","Connection refused."
上記の例の場合、messageには以下が出力されます。
＜例＞
"service",Return_code,"Output","Message"
"service3",161,"","Stop"
"port","Return_code","Output","Message"
"25",161,"","Connection refused."
注意事項
本運用操作部品のポートの接続確認は、SYNスキャンにて実施しています。
本運用操作部品のポートの接続確認を使用した場合、ポートスキャンに対するセキュリティ対策により異常と検知される場合があります。そのため、以下の範囲で使用してください。
ポートの接続確認を行う場合、Systemwalker Runbook Automationで運用操作/監視操作を行う業務サーバに対してのみ、本運用操作部品を実行してください。
portオプションに複数のポート番号またはサービス名を指定した場合、管理サーバから複数のポートに対して短時間のSYNスキャンが行われます。このため、管理サーバから複数のポートに対してSYNスキャンがあったとしても異常を検知しないよう、業務サーバのセキュリティ対策を設定してください。
本運用操作部品は、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
本運用操作部品では、serviceオプションおよびportオプションの入力を省略した場合、CMDBに登録された値をSystemwalker Runbook Automationが自動的に設定します。そのため、CMDBに登録された値を利用する場合、必要となる情報を事前にCMDBへ登録する必要があります。登録方法については、“3.21 CMDBへの情報登録(サーバの正常稼働状態の確認情報)”を参照してください。
serviceオプションとportオプションの両方に値が設定されていない場合はエラーになります。構成管理データベース(CMDB)から取得した結果、値が設定されていない場合もエラーになります。
portオプションにサービス名を指定する場合、そのサービスが管理サーバのOSに登録されている必要があります。指定可能なサービス名は、以下のOSの設定を確認してください。
Linux/Solarisの場合：/etc/services ファイル
portオプションに指定するサービス名には、半角英数字と"-"(ハイフン)および"_"(アンダーバー)のみを利用してください。
本運用操作部品でポートの接続確認が可能なプロトコルはTCPです。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
「～」「￡」「―」「∥」「￠」「￢」「￣」「￥」「〃」
業務サーバにRBAエージェントが未導入の場合は、serviceオプションに日本語を指定すると運用操作部品の操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
