記述形式
swrba_protocol_rest.rb -input 入力情報ファイル |
機能説明
REST型の通信を行います。
オプション
-input
運用操作部品に入力情報を入力します。
入力情報ファイル
運用操作部品への入力情報を格納したXML形式ファイルの名前(絶対パス)です。
運用操作部品の動作に必要な入力情報
REST型で通信を行うホスト名です。
運用自動化サーバにREST通信する場合、'localhost'を指定します。
ipaddressを指定する場合、hostnameを指定する必要はありません。
hostnameとipaddressの両方を指定した場合、ipaddressを優先します。
hostnameとipaddressの両方を省略した場合、引数エラーとなります。
ホスト名の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
REST型で通信を行うホストのIPアドレスです。
運用自動化サーバにREST通信する場合、'127.0.0.1'を指定します。
ipaddressを指定する場合、hostnameを指定する必要はありません。
hostnameとipaddressの両方を指定した場合、ipaddressを優先します。
ipaddressを省略した場合、指定したホスト名を元に構成管理データベース(CMDB)を検索し、取得したIPアドレスの値をSystemwalker Runbook Automationが自動的に設定します。
hostnameとipaddressの両方を省略した場合、引数エラーとなります。
IPアドレスの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
実行するHTTP(HTTPS)のメソッド名です。
GET、POST、PUT、DELETEを指定します。
メソッド名を省略した場合、引数エラーとなります。
メソッド名の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
利用するリソースのパスです。
リソースのパスを省略した場合、引数エラーとなります。
パスの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
リソースのパスは、以下のように指定します。
(例) /webdav/index.html
利用するリソースへの引数名と引数の値です。
リソースへの引数名と引数の値を省略した場合、引数エラーとなります。
引数名と引数の値の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
リソースへの引数名と引数の値は、以下のように「引数名=引数の値」で指定します。複数指定する場合は、「&」で区切ります。
(例) label1=value1&label2=value2
REST型で通信を行うホストのポート番号です。
ポート番号は整数型で、0～65535の間で指定します。
ポート番号を省略した場合、80を指定します。
BASIC認証を行うユーザ名です。
ユーザ名を省略した場合、BASIC認証を利用しないREST通信を行います。
ユーザ名の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
BASIC認証を行うユーザのパスワードです。
パスワードを省略した場合、BASIC認証を利用しないREST通信を行います。
パスワードの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
REST型通信の実行結果(XML形式)を解析するための要素名のアドレスです。
実行結果(XML形式)の文字列から、elementで指定したアドレス(xpath)と一致する内容を文字列で出力します。
該当する要素が複数存在する場合は、要素をダブルクォーテーションで囲み、カンマ区切りで文字列を出力します。
(例) データが「要素A」「要素B "C,D"」の場合："要素A","要素B ""C,D"""
該当する要素が存在しない場合、エラーとなります。
要素名を省略した場合、REST型通信の実行結果はXML形式で出力します。
要素名の文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
プロキシサーバのアドレスです。
プロキシサーバのアドレスを省略した場合、プロキシサーバを利用しない通信となります。
アドレスの文字数の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
プロキシサーバのポート番号です。
ポート番号は整数型で、0～65535の間で指定します。
ポート番号を省略した場合、8080を指定します。
REST通信を行うプロトコル種別です。
http、httpsを指定します。
プロトコル種別を省略した場合、httpを指定します。
プロトコル種別の文字列の上限は、1024バイトです。それ以上の場合、引数エラーとなります。
REST通信でボディに格納するXML形式のリクエストです。
XML形式のリクエストを省略した場合、ボディにXML形式のリクエストを格納しないREST通信となります。
XML形式のリクエストの文字列の上限は、2048バイトです。それ以上の場合、引数エラーとなります。
XML形式のリクエストは、以下のように指定します。
(例) <request><data>1234</data></request>
REST型の通信を行う対象となるURLは、入力情報を以下のように作成します。
<protocoltype>://<hostname>:<port>/<resourcepath> <param>
HTTPのメソッド名がGETの場合、<resourcepath>の最後に?を付け、その後ろに<param>を続けて指定します。
HTTPのメソッド名がPOST、PUT、DELETEの場合、引数はHTTPのボディに格納します。
復帰値
復帰値 | 意味 |
0 | REST通信に成功しました。 |
161 | REST通信に失敗しました。リトライ回数を指定した場合、リトライします。 |
176 | elementに該当する要素が存在しませんでした。 |
188 | 実行中に通信が切断しました。 |
189 | サーバに接続できませんでした。 |
197 | 入力情報に誤りがありました。 |
198 | オプションの指定に誤りがありました。 |
標準出力/標準エラー出力
REST型の通信に成功した場合、実行結果を文字列またはXML形式の文字列で標準出力します。
REST型の通信に失敗した場合、エラー内容を文字列で標準エラー出力します。
利用ライブラリ
入力情報ライブラリ
通信ライブラリ
注意事項
本運用操作部品では、HTTP V1.2を利用しています。
実行するHTTP(HTTPS)のメソッド名を指定する場合、すべて大文字にし、GET、POST、PUT、DELETEのいずれかを指定してください。
elementに利用可能な文字列は、半角英数字と半角記号です。
格納場所
Windows | <インストールパス>\itpm\rbaope\bin\parts\standard\ swrba_protocol_rest.rb |
Linux | /opt/FJSVswpm/rbaope/bin/parts/standard/swrba_protocol_rest.rb |
