機能説明
構成管理データベース(Configuration Management Data Base)に格納されている構成要素(Configuration Item)を取得します。
オプション
必須オプション
構成要素を取得依頼するホスト名またはIPアドレスです。
構成要素の取得先を運用自動化サーバに設定する場合、'localhost'または'127.0.0.1'を指定します。
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
構成要素を取得するための条件式です。
searchxpathを省略した場合、引数エラーとなります。
条件式の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
構成要素を取得するための条件式は、以下のように指定します。
(例)
特定の論理サーバの情報を取得：/%LogicalServer[./#observed/rc:LogicalServer[@hostname='論理サーバ名']]
OS種別が"Windows"の論理サーバ情報を取得：
/%LogicalServer[(./#observed/rc:LogicalServer/rc:SystemSettings/rc:OSSetting[matches(@name,'Windows.*')])]
詳細オプション
構成要素から属性情報を取得するための条件式です。
xpathを指定した場合、条件に一致した属性情報を取得します。
条件に一致した属性情報が複数存在する場合は、属性情報をダブルクォーテーションで囲み、カンマ区切りで文字列を出力します。
(例) 属性情報が「A」「B "C,D"」の場合："A","B ""C,D"""
xpathを省略した場合、searchxpathで指定したサーバの構成要素を取得します。
xpathの文字列の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
構成要素から属性情報を取得するための条件式は、以下のように指定します。
(例)
特定の論理サーバの属性情報を取得：
entities/cmdb:item/cmdb:record/ns0:LogicalServer/attribute::属性名
構成要素を取得依頼するホストのOS種別です。
Windows、Linux、Solarisを指定します。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
構成要素を取得依頼するホストへSSHを利用して接続するユーザ名です。
接続ユーザ名の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザ名の値をSystemwalker Runbook Automationが自動的に設定します。
接続ユーザ名の文字列の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
構成要素を取得依頼するホストへSSHを利用して接続するユーザのパスワードです。
接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
接続に必要なパスワードの文字列の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
構成要素を取得依頼するホストで、構成要素を取得するユーザ名です。
ユーザ名の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザの値をSystemwalker Runbook Automationが自動的に設定します。
ユーザ名の文字列の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
構成要素を取得依頼するホストで、構成要素を取得するユーザのパスワードです。
パスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザのパスワードの値をSystemwalker Runbook Automationが自動的に設定します。
パスワードの文字列の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
運用操作部品の実行の完了待ち合わせ時間(秒)です。
1～86,400(1日)の範囲で指定が可能です。
(例) 完了待ち合わせを10分間行う場合：600
完了待ち合わせ時間を省略した場合、300(秒)を指定します。
上記の範囲外の値を入力した場合、300(秒)を指定します。
運用操作部品の実行の起動リトライ回数です。
0～5の範囲で指定が可能です。
(例) 起動リトライを2回行う場合：2
起動リトライ回数を省略した場合、0(回)を指定します。
上記の範囲外の値を入力した場合、0(回)を指定します。
復帰値
復帰値 | 意味 |
0 | 構成要素の取得に成功しました。 |
161 | 構成要素の取得に失敗しました。 |
187 | SSH認証に失敗しました。 |
188 | 実行中に通信が切断しました。 |
189 | サーバに接続できませんでした。 |
197 | オプションの内容に誤りがありました。 |
201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。 |
203 | 運用操作部品の実行が失敗しました。運用自動化サーバの環境に問題があります。 |
標準出力/標準エラー出力
構成要素を取得した場合、取得結果をXML形式の文字列として標準出力します。
構成要素の取得に失敗した場合、エラー内容を文字列として標準エラー出力します。
注意事項
本運用操作部品は、SSH通信を利用して動作を実現しています。
運用操作部品を利用して各サーバに運用操作を指示する場合には、以下のソフトウェアが必要です。
注1) Windowsシステムにおいて、運用自動化サーバと連携サーバ・業務サーバ間でSSH通信を行う場合、必ず以下のソフトウェアが必要です。
SSH V2.0以上
SSHがインストールされていない環境では、OpenSSH(cygwin OpenSSH V1.7以上)をインストールしてください。
注2) UNIXシステムにおいて、SSH通信する場合、OSのバージョンによって以下のソフトウェアが必要となる場合があります。
SSH V2.0以上
Solaris9、Solaris10、Linux(RH5.0)の場合、OSの標準機能としてインストールされています。
SSHがインストールされていない環境では、OpenSSHをインストールしてください。
本運用操作部品の使用にあたり、業務サーバで通信の許可が必要になる通信ポートはTCPの22番です。
運用自動化サーバ以外のサーバに存在する構成管理データベースに格納されている構成要素を取得する場合、構成管理データベースが存在するサーバに作業用ファイルを格納するフォルダ(ディレクトリ)が必要となります。構成管理データベースが存在するサーバの環境変数"SWRBA_CMDB_WORK_HOME"に作業用ファイルを格納するフォルダ(ディレクトリ)のパスを指定してください。
運用自動化サーバ以外のサーバ(連携サーバ・業務サーバ)で、OS種別がWindowsのサーバに存在する構成管理データベースの構成要素を取得する場合、cygwinの環境変数に構成管理データベースの環境変数を設定する必要があります。cygwinの環境変数に"F4AN_INSTALL_PATH"を作成し、連携サーバ・業務サーバで設定されている構成管理データベースの環境変数を指定してください。
構成要素を取得依頼するホストのOS種別を指定する場合、頭文字を大文字にし、Windows、Linux、Solarisのいずれかを指定してください。
復帰値の確認は、BPMコンソールを用いて行います。詳細については、“Systemwalker Runbook Automation 管理ガイド”の“伝票の処理状態確認”を参照してください。
202、203の復帰値が出力された場合は、運用フローが異常終了しています。運用自動化サーバ(Windows(R)の場合はイベントログ上、Solaris/Linuxの場合はシステムログ上)に出力されているメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
