Hitachi

JP1 Version 13　JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス

5.17.4　定義ファイル更新

機能

JP1/IM - ManagerまたはJP1/IM - Agentの定義ファイルを更新します。

実行権限

次の権限が必要です。

hostCategoryに「Manager」を指定する場合

  • JP1資源グループ：*

  • JP1権限レベル：JP1_Console_Admin

hostCategoryに「Agent」を指定する場合

  • JP1権限レベル：JP1_Console_Admin

APIのバージョン

v1

形式
リクエスト行
POST /application/component/apiVersion/fileOperation/updateFile httpVersion
リクエストのヘッダー
Authorization:BeareranAxYWRtaW46TUdGa01tTTJNMlV3TURFNFh6STNYekE0T2pJME9qTXpYMTlmWDE5ZlgxOWZYMTlmWDE5ZlgycHdNV0ZrYldsdUlDQWdJQ0FnSUNBZ0lDQWdJQ0FnSUNBZ0lDQWdJQ0Fn
Accept-Language: ja

「5.2.3　リクエスト形式」のリクエストヘッダーに従います。ただし，Content-Typeは次の形式となります。 

Content-Type: multipart/form-data; boundary=-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Length: 1024000
Accept: application/json
リクエストのメッセージボディー
[
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Disposition: form-data; name="hostCategory"
 
"ホスト種別"
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Disposition: form-data; name="managerHostName"
 
"定義ファイル更新先Agentホスト管理先Mangerホスト名"
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Disposition: form-data; name="agentHostName"
 
"定義ファイル更新先Agentホスト名"
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Disposition: form-data; name="file"; filename="/C:/Users/xxxxx/Desktop/sample.zip"
Content-Type: application/zip
 
zipデータ
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
]
パラメーター

リクエストのメッセージボディーに指定するパラメーターを次に示します。

パラメーター

省略可否

説明

filename

不可

定義ファイルをzipに圧縮したファイル名を絶対パスで指定します。ファイル名は1〜200バイトで指定します。

ファイルサイズの上限はチェックせず，リクエストボディーのサイズの上限をチェックします。

hostCategory

不可

ホスト種別として「Manager」または「Agent」を指定します。指定したホスト種別の定義ファイルに対して操作を行います。

managerHostName

「説明」欄を参照

  • hostCategoryが「Manager」の場合

    指定項目を無視します。自ホストをJP1/IMのマネージャーホストと仮定し，JP1/IMのマネージャーホストの定義ファイルを更新します。

  • hostCategoryが「Agent」の場合

    定義ファイル更新先のエージェントを管理しているJP1/IMのマネージャーホスト名を1〜255バイトで指定します。

agentHostName

「説明」欄を参照

  • hostCategoryが「Manager」の場合

    指定項目を無視します。

  • hostCategoryが「Agent」の場合

    定義ファイル更新先のエージェントホスト名を1〜255バイトで指定します。
ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード

メッセージ

説明

200

−

APIの処理が成功しました。

KAJY68126-W

統合エージェント制御基盤でワーニングが発生しました。

400

KAJY68111-E

リクエストパラメーターが不正です。

KAJY68205-E

  • リクエストに指定した統合エージェントホスト名がJP1/IM - Managerが管理する構成に存在しません。

  • ログインユーザーにリクエストに指定した統合エージェントの参照・操作権限がありません。

  • リクエストに指定した統合エージェントまたはマネージャーホストの情報が統合エージェントホスト管理DBにありません。

403

KAJY01000-E

認証に使用したユーザーの権限が不足です。

500

KAJY68104-E

統合エージェント制御基盤でエラーが発生しました。

KAJY00009-E

リクエストボディーの上限を超えました。

KAJY00007-E

システムエラーが発生しました（ディスク不足，メモリー不足など）。

KAJY68203-E

インテリジェント統合管理基盤に接続できません。

KAJY68212-E

統合エージェント制御基盤に接続できません。

KAJY68501-E

マネージャーの統合エージェントホスト管理DBに接続できません。
レスポンス

ステータスコードが200の場合に，レスポンスボディーにJSON形式で次の情報を返却します。

{
  "filelist":[
    {
      "filename": "ファイル名",
      "filepath": "ファイルの絶対パス",
      "result": "ファイル更新の結果",
      "message": "メッセージ"
    }, ・・・
  ]
}

メンバー名

説明

filename

ファイル名を記載します。

filepath

ファイルの配置先の絶対パスを記載します。

result

ファイル更新の結果を記載します。

記載する文字列については，表5-16を参照してください。

filelist:message

ファイル更新のための操作が失敗した場合のエラーメッセージIDとその本文を記載します。成功した場合は省略します。

resultが「recovery fail」の場合に記載するエラーメッセージは，定義反映のための操作に失敗したときのメッセージを記載します。
表5‒16　 resultの内容

ファイルの上書き

定義反映のための操作

リカバリー処理

resultの内容

〇

〇

−

success

×

−

−

update fail

〇

×

〇

action fail

〇

×

×

recovery fail
（凡例）

〇：成功　×：失敗　−：処理なし

戻り値

  • ステータスコードが200の場合

    なし

  • ステータスコードが200以外の場合

    レスポンスのメッセージボディーに，「5.2.6 エラー発生時のレスポンスメッセージ」に記載されているレスポンス形式の例外オブジェクトが返却されます。

    JP1/IM - Managerがバージョン13-10以降，かつ，定義ファイル更新先AgentホストのJP1/IM - Agentがバージョン13-10以降の場合で，すべての定義ファイルの更新に失敗したときは，「extensions」（拡張情報）に，次の情報を設定します。

    項目

    説明

    filelist

    このAPIの説明項目「レスポンス」のレスポンスボディーに示すJSON形式の文字列
使用例
リクエスト：
POST http://hostname:20703/im/api/v1/fileOperation/updateFile HTTP/1.1
Content-Type: multipart/form-data;boundary=-----5a6a576p44OV44Kh44Kk44Or5pu05paw
[
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Disposition: form-data; name="hostCategory"
 
"Agent"
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Disposition: form-data; name="managerHostname"
 
"immanager"
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Disposition: form-data; name="agentHostname"
 
"imagent"
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
Content-Disposition: form-data; name="file"; filename="/C:/Users/xxxxx/Desktop/sample.zip"
Content-Type: multipart/form-data; boundary=
-----5a6a576p44OV44Kh44Kk44Or5pu05paw
 
zipデータ
-----5a6a576p44OV44Kh44Kk44Or5pu05paw--
]
レスポンス：
HTTP/1.1 200 OK
Content-Type:application/json
・・・省略・・・
 
{
  "filelist":[
    {
      "filename": "user_file_sd_config_test2.yml",
      "filepath": "C:\\Program Files\\Hitachi\\jp1ima\\conf\\user",
      "result": "update fail",
      "message": "KAJY68126-W 統合エージェント制御基盤でワーニングが発生。(詳細情報 : KNBC20020-W 定義ファイルの更新に失敗しました。(詳細情報: specified file not included in user-definition file list file. filename= C:\\Program Files\\Hitachi\\jp1ima\\conf\\user\\user_file_sd_config_test2.yml))"
    }, ・・・
  ]
}
注意事項

  • 定義ファイルを更新する前に，定義ファイルの書式，文字コードなどが正しいことを，マニュアルで確認してください。

    定義ファイルが不正な場合，更新に失敗するおそれがあります。定義ファイルの更新が失敗すると，JP1イベントが送信されるため，発生したJP1イベントの内容を確認して対処してください。

  • 定義ファイルの更新時に，自動的に再起動されるサービスがあります。

    サービスが再起動されることによって，監視業務が一時的に停止することがあります。また，クラスタ構成の場合，クラスタソフトの監視対象サービスに対する停止の検知時間の設定※により，フェールオーバーが発生するおそれがあります。そのため，定義ファイルの更新は，システムのメンテナンスの時間に実施してください。

注※

停止の検知時間の目安は，マシンスペックや負荷状況にも依存しますが，1つの定義ファイルの更新ごとに，サービスを再起動するため，定義ファイル1つにつき1分程度と考えてください。

例えば，定義ファイルを10個同時に更新する運用の場合，クラスタソフトの停止の検知時間の設定を10分にしてください。

検知時間を延ばすことができない場合は，定義ファイル操作機能を使用せず，ホストにログインして，直接定義ファイルを更新してください。

ページの先頭へ

Copyright (C) 2023, 2024 Hitachi, Ltd.

Copyright (C) 2023, 2024 Hitachi Solutions, Ltd.