機能説明
指定したサーバの連携対象製品に登録されているジョブネットの状態を取得します。
オプション
基本オプション
ジョブネットの状態を取得するサーバのホスト名またはIPアドレスです。
管理サーバで運用操作部品を実行する場合、以下を指定します。
IPv4の場合: “localhost”または“127.0.0.1”
IPv6の場合: “localhost”または“::1”
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
ジョブネットの状態を取得する対象となるジョブネット名です。
ジョブネット名を省略した場合、引数エラーとなります。
ジョブネット名の文字数の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
連携対象製品がSystemwalker Operation Managerの場合、指定したジョブネット名のジョブネットが複数のプロジェクトに存在する場合は、ジョブネットが存在しないものとみなし、エラーとなります。この場合は拡張オプションのprojectnameを指定してください。
拡張オプション
ジョブネット情報の格納先のプロジェクト名を指定します。
このオプションが有効となるのは連携対象製品がSystemwalker Operation Managerの場合です。
基本オプションのjobnetnameで指定したジョブネット名のジョブネットが1つだけ存在する場合は、省略することができます。
基本オプションのjobnetnameで指定したジョブネット名のジョブネットが複数のプロジェクトに存在する場合は、ジョブネットが存在しないものとみなし、エラーとなります。この場合は、プロジェクト名を指定します。
プロジェクト名の文字列の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
複数サブシステム運用をしているシステムで、操作対象のサブシステムを指定するためのオプションです。操作対象とするサブシステム番号を、0から9の範囲で指定します。このオプションを省略した場合、サブシステム番号0が操作対象となります。
このオプションが有効となるのは連携対象製品がSystemwalker Operation Managerの場合です。
0から9以外の値の場合、引数エラーとなります。
ジョブネットの状態を取得するホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: システムユーザー
業務サーバがLinux、Solarisの場合: root
接続ユーザーの文字数の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
ジョブネットの状態を取得するホストへSSHを利用して接続するユーザーのパスワードです。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
パスワードの文字数の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
ジョブネットの状態を取得するホストで実行するユーザー名です。
実行ユーザー名およびexecpasswordの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザーの値をSystemwalker Runbook Automationが自動的に設定します。CMDBに登録されていない場合は、接続ユーザー名で実行します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。
実行ユーザーの文字数の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。
本運用操作部品ではexecpasswordの値を使用しません。execpasswordの値を指定した場合、無効となります。
ジョブネットの状態を取得するホストのOS種別です。
Windows、Linux、Solarisを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
連携するジョブ管理製品名です。
“OMGR”を指定します。なお、大文字／小文字は区別しません。
ジョブ管理製品名の指定を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した値をSystemwalker Runbook Automationが自動的に設定します。本運用操作部品の連携対象はSystemwalker Operation Managerだけです。
文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
連携対象製品のコマンドインストールパスを指定します。
省略された場合はSystemwalker Operation Managerのコマンドインストールパスとなります。
インストールパスの指定を省略した場合は、それぞれ以下のようになります。
ジョブネットの状態を取得するホスト | 通信方法 | mwinstalledpathに指定される値 |
|---|---|---|
Windowsの管理サーバ | － | システムの環境変数PATHの値を使用して動作します |
Linuxの管理サーバ | － | rootユーザーの環境変数PATHの値を使用して動作します |
Windowsの業務サーバ | ファイル転送基盤 | システムの環境変数PATHの値を使用して動作します |
SSH | 接続ユーザーまたは実行ユーザーの環境変数PATHの値を使用して動作します | |
Linux、Solarisの業務サーバ | ファイル転送基盤 | rootユーザーの環境変数PATHの値を使用して動作します |
SSH | 接続ユーザーまたは実行ユーザーの環境変数PATHの値を使用して動作します |
本運用操作部品の連携対象はSystemwalker Operation Managerだけです。
指定できるインストールパスの上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品の実行の完了待ち合わせ時間(秒)です。
300～86,400(1日)の範囲で指定が可能です。
(例) 完了待ち合わせを10分間行う場合：600
指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。
運用操作部品の実行の起動リトライ回数です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。
起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。
(例) 起動リトライを2回行う場合：2
運用操作部品のリトライ間隔(秒)です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行うまでの間隔を指定します。1～14400の範囲で指定が可能です。
(例) 300秒間隔でリトライを行う場合：300
timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.7 運用操作部品実行定義ファイル”を参照してください。
復帰値
アイコン | シンボル名 | 復帰値 | 意味 |
|---|---|---|---|
| 成功 | 0 | ジョブネットの状態の取得に成功しました。 |
| 失敗 | 159 | 対象のジョブネットが見つかりませんでした。 |
161 | ジョブネットの状態の取得に失敗しました。リトライ回数を指定した場合、リトライします。 | ||
187 | 運用操作部品による操作を実施する際、サーバにネットワーク接続(SSH)時の認証に失敗しました。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
188 | Systemwalker Runbook Automationエージェントが導入されていないサーバに対して運用操作部品による操作を実施中に、サーバとのネットワーク通信(SSH)が切断されました。 | ||
189 | 運用操作部品による操作を実施する際、サーバにネットワーク接続(SSH)できませんでした。 または、運用操作部品による操作を実施する際に、サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
197 | オプションの内容に誤りがありました。 | ||
200 | ジョブネットの状態の取得が異常終了しました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message | ジョブネットの状態取得に成功した場合、以下のメッセージを設定します。 The operation component was successful. ジョブネットの状態取得に失敗した場合、エラー内容を文字列として設定します。 |
jobnet_status | ジョブネットの状態の取得結果を以下の文字列で設定します。
|
returnCode | 復帰値を設定します。 |
注意事項
本運用操作部品は、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにSystemwalker Runbook Automationエージェントが未導入の場合は、jobnetnameオプションおよびprojectnameオプションに日本語を指定すると運用操作部品の操作結果は保証されません。日本語を指定する場合は業務サーバにSystemwalker Runbook Automationエージェントを導入してください。
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
