機能説明
指定したノード（サーバ、ネットワーク機器）のポートに対してTCPによる接続が可能であるか確認します。
この部品により、指定したポートを利用する通信が可能であることを確認できます。
管理サーバがLinuxの場合のみ、使用できます。
オプション
基本オプション
運用操作部品を実行する対象のホスト名またはIPアドレスです。
管理サーバでポートの状態を確認する場合、以下を指定します。
IPv4の場合: 'localhost'または'127.0.0.1'
IPv6の場合: 'localhost'または'::1'
ただし、管理サーバがSELinuxかつ、管理サーバで運用操作部品を実行する場合、管理サーバのホスト名またはIPアドレスを指定します。
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
接続可能か確認するノードのポート番号またはサービス名です。
サービス名を指定した場合、管理サーバの/etc/servicesに登録されているポート番号を確認します。
ポート番号またはサービス名を複数指定できます。ポート番号とサービス名を混在して指定可能です。
ポート番号またはサービス名を省略した場合、引数エラーとなります。
ポート番号またはサービス名の個数の上限は、100個です。それより大きい場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
接続可能か確認するポート番号またはサービス名は、以下のように指定します。
(例) SSHによる接続が可能か確認する場合："ssh"
(例) 22番ポートと25番ポートによる接続が可能か確認する場合： 22,25
拡張オプション
運用操作部品の実行の完了待ち合わせ時間(秒)です。
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 | ポートの接続確認に失敗しました。リトライ回数を指定した場合、リトライします。 |
| 失敗 | 196 | 管理サーバがLinuxの場合に、指定できないオプションが指定されました。または、管理サーバがWindows(R)の場合に、使用できないオプションが指定されました。 |
197 | 入力情報に誤りがありました。 | ||
198 | オプションの指定に誤りがありました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message |
|
port_service_check_result | 指定したサーバに対して実行した結果を設定します。 |
port_disconnect_list | 接続できないポート番号の一覧をCSV形式で設定します。 |
returnCode | 復帰値を設定します。 |
port_service_check_resultの出力形式は以下です。
[port],[復帰値],[出力情報],[メッセージ]
[出力情報]には、何も出力しません。
[メッセージ]には以下を出力します。
ポート接続確認が成功し、接続が可能である場合、"Success"という文字列を出力します。
ポートの接続確認に失敗した場合、エラー内容を文字列で出力します。
（例）portオプションに「"22","25"」を指定して、22番ポートのみ接続が可能であった場合：
"port",Return_code,"Output","Message"
"22",0,"","Success"
"25",161,"","Connection refused."
上記の例の場合、messageには以下が出力されます。
（例）
"port",Return_code,"Output","Message"
"25",161,"","Connection refused."
注意事項
本運用操作部品は、SYNスキャンにてポートの接続確認を実施しています。
本運用操作部品を使用した場合、ポートスキャンに対するセキュリティ対策により異常と検知される場合があります。そのため、以下の範囲で使用してください。
Systemwalker Runbook Automationで運用操作/監視操作を行う業務サーバに対してのみ、本運用操作部品を実行してください。
portオプションに複数のポート番号またはサービス名を指定した場合、管理サーバから複数のポートに対して短時間のSYNスキャンが行われます。このため、管理サーバから複数のポートに対してSYNスキャンがあったとしても異常を検知しないよう、業務サーバのセキュリティ対策を設定してください。
portオプションにサービス名を指定する場合、そのサービスが管理サーバのOSに登録されている必要があります。指定可能なサービス名は、以下のOSの設定を確認してください。
Linuxの場合：/etc/services ファイル
サービス名には、半角英数字と"-"(ハイフン)および"_"(アンダーバー)のみを利用してください。
本運用操作部品で確認可能なプロトコルはTCPです。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
「～」「￡」「―」「∥」「￠」「￢」「￣」「￥」「〃」
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
