3.6.5　定義ファイル操作機能

(a)　取得先のホスト

一度の実行で取得できる定義ファイルの一覧取得先のホストは，1つのホストから取得できます。複数のホストから定義ファイルの一覧を取得する場合は，複数回実行する必要があります。

(b)　取得する定義ファイルの一覧

JP1/IM - ManagerまたはJP1/IM - Agentで更新可能な定義ファイル，ユーザー作成定義ファイルリスト定義ファイル（imdd_user_deffile_list.json）またはユーザー定義ファイルリストファイル（jpc_user_deffile_list.json）に定義したユーザー作成の定義ファイルをマージしたリスト（一覧）を取得します。

JP1/IM - ManagerまたはJP1/IM - Agentで更新可能な定義ファイル，ユーザー作成定義ファイルリスト定義ファイルおよびユーザー定義ファイルリストファイルに定義できるファイルについては，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「定義ファイル一覧」（2.　定義ファイル）の注記を参照してください。

ユーザー作成定義ファイルリスト定義ファイルおよびユーザー定義ファイルリストファイルの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」（2.　定義ファイル）の該当するファイルの説明を参照してください。

リスト内で内部情報として保持する1ファイルごとの項目を次に示します。

ユーザー作成定義ファイルリスト定義ファイルまたはユーザー定義ファイルリストファイルの定義内容が不正なファイルについては，定義が不正なファイルとしてリストに追加します。

(a)　取得先のホスト

一度の実行で取得できる定義ファイルの取得先のホストについては，1つのホストのから取得できます。複数のホストから定義ファイルを取得する場合は，複数回実行する必要があります。

(b)　取得要求があった定義ファイル

取得要求があった定義ファイルについて，1つのzipファイルに圧縮して返却します。取得先のホストがWindows，Linuxのどちらの場合でもzipファイルで返却します。zipファイルの名称は，「定義ファイルを取得したホスト名_統合マネージャーホストの現在時間（YYYYMMDDhhmmssSSS）.zip」（YYYYMMDDhhmmssSSSは統合マネージャーホストのローカルタイム）です。ファイル作成時にファイル名が重複した場合は，現在時刻を再取得します。統合オペレーション・ビューアーの画面から取得する場合，ファイルサイズの上限は1MB，取得できるファイル数の上限は10ファイルです。zipファイルの中身は，定義ファイルのほかに，定義ファイルプロパティファイルを作成し同梱します。

定義ファイル操作機能で作成するzipファイルで設定する拡張フィールドは，Go言語でサポートしている「Extended Timestamp Extra Field」を使用します。zipファイルを展開したときに作成される定義ファイルの更新日時は，JP1/IM - Managerホストのタイムゾーンで表現します。

重要

zipファイルを展開するときは「Extended Timestamp Extra Field」に対応しているツールを使用してください。対応していないzip解凍ツールを使用した場合，JP1/IM - ManagerとJP1/IM - Agentのタイムゾーンが異なるときは，zipファイルを展開したときに作成される定義ファイルの更新日時が，JP1/IM - Managerのタイムゾーンで表現されません。また，Windows Server標準のzipツールは「Extended Timestamp Extra Field」に対応していません。

(c)　定義ファイルプロパティファイル

定義ファイルの情報をまとめた定義ファイルプロパティファイルの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「定義ファイルプロパティファイル（imdd_file_properties.json）」（2.　定義ファイル）」を参照してください。このファイルは，定義ファイルを取得する際にzipファイルの中に配置します。定義ファイル更新機能および定義ファイル削除機能を使う場合に，定義ファイルの配置先や配置後の定義反映のための操作の情報を利用します。

(d)　圧縮した定義ファイルの保存場所

圧縮した定義ファイルは，定義ファイルの取得要求の応答のため，JP1/IM - Managerのサーバに一時的に保存します。保存先を次に示します。

■Windowsの場合

Managerパス\public\download\jp1_fileoperation

■UNIXの場合

/opt/jp1imm/public/download/jp1_fileoperation

(e)　一時的に保存していた圧縮した定義ファイルの削除

一時的に保存していた圧縮した定義ファイルは，定義ファイルの取得要求へ応答後は不要になります。そのため，圧縮した定義ファイルを一時保存する処理を実行するときに，処理の実行時刻よりも1日以上前の更新日のファイルが保存先のフォルダに存在する場合は，そのファイルを削除します。

(a)　削除可能なファイルについて

削除可能なファイルは，ユーザー作成定義ファイルリスト定義ファイルまたはユーザー定義ファイルリストファイルに定義されていて，実際にファイルが存在するファイルです。

統合マネージャーの定義ファイルのうち，ユーザーが任意のフォルダに定義ファイルを作成できるファイルについて，定義ファイル操作機能を利用したい場合は，Managerパス\conf\imdd\userに配置する必要があります。論理環境の場合は，「Managerパス」を「共有フォルダ\JP1IMM」に読み替えてください。

ユーザー作成定義ファイルリスト定義ファイルまたはユーザー定義ファイルリストファイルに定義できるファイルについては，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「定義ファイル一覧」（2.　定義ファイル）の注記を参照してください。

(b)　削除するファイルのバックアップ

ファイルを削除する前に1世代だけバックアップを残します。削除終了後，バックアップファイルは削除します。

(c)　ファイル削除後の定義の反映

ファイル削除後は，ユーザー定義ファイルリストファイルのupdateactionに記載の内容を実行し，定義情報を更新します。

(d)　定義反映のための操作に失敗した場合のリカバリー

定義反映のための操作に失敗した場合，削除したファイルをバックアップしていたファイルから復元します。その後，再度定義反映のためにユーザー作成定義ファイルリスト定義ファイルのupdateactionに記載の内容を実行し，定義情報をファイル削除前の状態にリカバリーします。

(e)　バックアップファイルの消去

ファイルの削除や定義反映のための操作の実行処理が終了したあとに，処理の成功，失敗に関わらず，バックアップしていたファイルを削除します。ファイルを削除する処理を実行するときに，削除を行う時刻よりも1日以上前の更新日のファイルがバックアップファイルの保存先に存在する場合は，そのファイルもあわせて削除します。バックアップファイルの削除に失敗しても，定義ファイルの削除機能の処理は継続します。

(f)　統合トレースログの出力とJP1イベントの発行

定義ファイルの削除処理について，成功，失敗の情報を統合トレースログに出力します。削除に成功した場合は，イベントID：00007640のJP1イベントを発行します。削除に失敗した場合は，イベントID：00007641のJP1イベントを発行します。

定義ファイル削除APIでステータスが200の場合，出力するメッセージはKAJY68115-Iです。ステータスが200以外の場合，KAJY68116-Eです。

統合トレースログの出力については，統合エージェントの定義ファイルの削除についても，統合マネージャーの定義ファイルの削除機能で出力します。

重要

• ユーザー作成の定義ファイルを削除した場合，ユーザー作成定義ファイルリスト定義ファイルを編集して，削除したファイルの情報を削除してください。ファイルの情報を削除しない場合，定義ファイル一覧を取得したときにKAJY68102-Wのメッセージが出力されます。

• ユーザー作成の定義ファイルを削除する前に，ユーザー作成定義ファイルリスト定義ファイルから削除予定のファイルの情報を削除すると，ファイルの削除ができずに，不要な定義ファイルが残ったままになります。その場合，ユーザー作成定義ファイルリスト定義ファイルに削除するファイルの情報を追加してください。追加した後に，定義ファイル削除機能でファイルを削除するか，定義ファイルがあるホストに直接ログインしてファイルを削除してください。

(a)　更新可能なファイル

更新可能なファイルは，定義ファイルの一覧で取得できるファイルのうち，実際に存在する，かつ，更新可能なファイルです。

統合マネージャーの定義ファイルのうち，ユーザーが任意のフォルダに定義ファイルを作成できるファイルについて，定義ファイル操作機能を利用したい場合は，Managerパス\conf\imdd\userに配置する必要があります。論理環境の場合は，「Managerパス」を「共有フォルダ\JP1IMM」に読み替えてください。

定義ファイルの一覧で取得できるファイルについては，「3.6.5(1)(b)取得する定義ファイルの一覧」を参照してください。

(b)　更新するファイルのバックアップ

ファイルを更新する前に，1世代だけバックアップを残します。

(c)　ファイル更新後の定義の反映

ファイル更新後にはユーザー定義ファイルリストファイルのupdateactionに記載の内容を実行し，定義情報を更新します。

(d)　定義反映のための操作に失敗した場合のリカバリー

定義反映のための操作に失敗した場合，更新したファイルをバックアップしていたファイルから復元します。再度定義反映のためにユーザー定義ファイルリストファイルのupdateactionに記載の内容を実行し，定義情報をファイル更新前の状態にリカバリーします。

(e)　バックアップファイルの消去

ファイルの更新や定義反映のための操作の実行処理が終了したあとに，処理の成功，失敗に関わらず，バックアップしていたファイルを削除します。ファイルを削除する処理を実行するときに，削除を行う時刻よりも1日以上前の更新日のファイルがバックアップファイルの保存先に存在する場合は，そのファイルもあわせて削除します。バックアップファイルの削除に失敗しても，定義ファイルの更新機能の処理は継続します。

(f)　統合トレースログの出力とJP1イベントの発行

定義ファイルの更新処理について，成功，失敗の情報を統合トレースログに出力します。更新に成功した場合は，イベントID：00007642のJP1イベントを発行します。更新に失敗した場合は，イベントID：00007643のJP1イベントを発行します。

定義ファイル更新APIでステータスが200の場合，出力するメッセージはKAJY68119-Iです。ステータスが200以外の場合，出力するメッセージはKAJY68120-Eです。

統合トレースログの出力については，統合エージェントの定義ファイルの更新についても，統合マネージャーの定義ファイルの更新機能で出力します。