4.3.1 アダプタコマンドでの情報取得
JP1/IM - Manager(インテリジェント統合管理基盤)でユーザー作成プラグインを作成して管理対象から情報を取得する場合は,ユーザー作成プラグインとともにアダプタコマンドが必要となります。アダプタコマンドの実行は一度だけです。複数回実行して情報を取得することはできません。また,アダプタコマンドとユーザー作成プラグインは1対1の関係です。
アダプタコマンドは,インテリジェント統合管理基盤と標準入出力を使用して通信を行い,インテリジェント統合管理基盤から起動されると,インテリジェント統合管理基盤に対する応答を,標準出力で出力します。
- 〈この項の構成〉
(1) 戻り値
アダプタコマンドは,処理結果の概要を戻り値で返却します。
項番 |
戻り値 |
機能 |
---|---|---|
1 |
0 |
正常終了 |
2 |
1〜49 |
ワーニング発生時のエラーに割り当てる。(一部の情報だけ取得失敗など。) |
3 |
50〜99 |
リトライ可能な一時的なエラーに割り当てる。 |
4 |
100〜149 |
環境不正(バージョンが異なるなど) |
5 |
150〜199 |
プログラム不正 |
戻り値の範囲内で,アダプタコマンド独自の戻り値を追加することもできます。アダプタコマンド実行時のエラーに関する詳細情報は,別途標準エラー出力で返却する必要があります。
(2) 実行ディレクトリ
アダプタコマンドが配置されているディレクトリに設定されます。
(3) 入出力
アダプタコマンドとインテリジェント統合管理基盤とのデータ通信には,引数,標準入力,標準出力および標準エラー出力が使用されます。
アダプタコマンドの標準入力,標準出力は,「共通ヘッダー」と「データ本体」から構成されます。「データ本体」にアダプタコマンドからインテリジェント統合管理基盤に渡す情報を記入します。
形式を次に示します。
共通ヘッダー<改行コード(<CR><LF> or <LF>)>データ本体
ヘッダーの構成を次に示します。ヘッダーはCSV形式で表示されます。
プロトコル名称,プロトコルバージョン,文字コード,プログラムプロダクト名称
ヘッダーの詳細を次に示します。
項番 |
名称 |
形式 |
設定値 |
---|---|---|---|
1 |
プロトコル名称 |
文字列 |
JBSPGCMD |
2 |
プロトコルバージョン |
「アダプタコマンド設定ファイルのバージョン」※と同じバージョンを設定してください。
|
|
3 |
文字コード |
アダプタコマンドの実行環境に合わせて,次の文字コードを設定してください。
|
|
4 |
製品名称 |
「コンポーネント識別子」※と同じ値を設定してください。 |
アダプタコマンド実行時にエラーが発生した場合は,標準エラー出力で詳細を出力します。その際の出力内容は,ASCII文字の範囲で設定してください。
(4) 注意事項
-
次のコマンドはアダプタコマンドとして使用できません。
-
サブ入力コマンド(対話操作)を必要とするコマンド
-
エスケープシーケンスや制御コードを伴うコマンド
-
コマンド実行先でウインドウを作成するコマンド
-
デーモンなどの,終了しないコマンド
-
-
アダプタコマンドは多重起動される可能性があります。多重起動が不可能なアダプタコマンドの場合は独自に排他処理を行い,多重起動された場合はビジーとして返却するようにしてください。
-
標準入出力による送受信は,同時に実行できません。標準入力によって要求を受信するアダプタコマンドの場合は,要求データをすべて受信したあとに応答データの送信を開始してください。
-
アダプタコマンドは,次の権限で実行されます。
-
Windowsの場合:SYSTEM
-
UNIXの場合:root
-
-
アダプタコマンドにはタイムアウト時間があります。このため,タイムアウトする前に応答の返却が終わる必要があります。タイムアウト時間は60分です。
(5) アダプタコマンド設定ファイル
アダプタコマンド設定ファイルで,アダプタコマンドのファイル名を設定します。命名規則を次に示します。
Adapter_SIDに指定するコンポーネント名.conf
- 指定例
-
「Adapter_SIDに指定するコンポーネント名」が「/VENDOR/TOOLA」の場合
Adapter_VENDOR_TOOLA.conf
アダプタコマンド設定ファイルの格納先を次に示します。
- Windowsの場合
-
JP1/Baseインストールフォルダ\plugin\conf
- UNIXの場合
-
/opt/jp1base/plugin/conf
アダプタコマンド設定ファイルの設定項目を次に示します。ラベルと値を,タブまたはスペース区切りで記載してください。
項番 |
項目名 |
ラベル |
設定値 |
---|---|---|---|
1 |
アダプタコマンド設定ファイルのバージョン |
fileversion |
12000000 |
2 |
アダプタコマンドのパス |
cmdpath |
アダプタコマンドのコマンド名を含めたパスを,フルパス形式で指定します。ダブルクォートなどでパスを囲む必要はありません。 |
3 |
アダプタコマンドと連携する製品 |
upperpp |
/HITACHI/JP1/IM/DD |
4 |
アダプタコマンド種別 |
componenttype |
JDD_CONFINFO |
アダプタコマンド設定ファイルの設定例を次に示します。
fileversion 12000000 cmdpath C:\Program Files (x86)\Hitachi\jp1pc\bin\jp1getconfinfo.exe upperpp /HITACHI/JP1/IM/DD componenttype JDD_CONFINFO
- 重要
-
-
1行に記述できるのは,4,096文字までです。
-
同じラベル名が複数存在した場合は,エラーとなります。
-
必須のラベルが指定されていなかった場合はエラーとなります。
-
ファイル中に1つでもエラーが存在した場合は,そのファイルは無効となります。
-
ファイルの終端は改行となります。
-
ファイルに記載できるのはASCII文字だけです。
-
ラベルを指定する場合,行頭に空白,タブの指定はできません。
-
空白,タブだけの行は無視されます。
-