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ファイルの中に配置します。定義ファイル更新機能および定義ファイル削除機能を使う場合に，定義ファイルの配置先や配置後の定義反映のための操作の情報を利用します。

(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に記載の内容を実行し，定義情報を更新します。

updateactionに記載の内容に，次のコマンド文字列が含まれていた場合，JP1/IM - Agentが論理ホストで動作していたときは，「-h 論理ホスト名」を付与して実行します。

• addon_jpc_service_reload

• addon_jpc_service_get_status

• jco_spmd_reload

• jddupdateaction

• jddupdatessomap

また，JP1/IM - Managerの定義ファイルのうち，次のコマンドの実行により定義内容を反映させる定義ファイルについては，定義ファイルの更新と同時に定義の反映も行われます。

• jco_spmd_reload

• jddupdateaction

• jddupdatessomap

上記以外のコマンドで定義内容を反映する定義ファイルについては，対処アクションの手動実行にてコマンドを実行して定義情報の反映を行ってください。

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

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

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

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

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

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

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

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

(g)　jco_spmd_reloadを使って定義情報を反映する定義ファイルについて

jco_spmd_reloadを使って定義情報を反映する定義ファイルについて，定義情報に誤りがある状態で定義ファイルの更新をした場合，次の動作となります。

• 統合オペレーション・ビューアーまたはREST APIの実行結果がエラーとならない

• 定義ファイルのリカバリー処理が行われず，定義情報に誤りがある定義ファイルがマネージャーホストに配置される

• 統合トレースログに定義情報が間違っている旨のエラーメッセージが出力される

定義情報を反映後に正しく定義が反映できない場合は，統合トレースログに出力されるメッセージの対処に従い定義情報を修正し，再度定義情報の更新をしてください。

jco_spmd_reloadを使って定義情報を反映する定義ファイルは次のとおりです。

• 発生元ホストマッピング定義ファイル（user_hostmap.conf）

• ヘルスチェック定義ファイル（jcohc.conf）

• イベントガイド情報ファイル（jco_guide.txt）

• 相関イベント発行システムプロファイル（egs_system.conf）

• 重大度変更定義ファイル（jcochsev.conf）

• イベント拡張属性定義ファイル

• イベント拡張属性定義ファイル（拡張ファイル）

• 共通除外条件表示項目定義ファイル（common_exclude_filter_attr_list.conf）

• 共通除外条件自動入力定義ファイル（common_exclude_filter_auto_list.conf）

• 繰り返しイベント条件表示項目定義ファイル（event_storm_attr_list.conf）

• 繰り返しイベント条件自動入力定義ファイル（event_storm_auto_list.conf）

• 重大度変更定義表示項目定義ファイル（chsev_attr_list.conf）

• 重大度変更定義自動入力定義ファイル（chsev_auto_list.conf）

• モニター画面呼び出し定義ファイル

• 表示メッセージ変更定義ファイル（jcochmsg.conf）

• 表示メッセージ変更定義表示項目定義ファイル（chmsg_attr_list.conf）

• 表示メッセージ変更定義自動入力定義ファイル（chmsg_auto_list.conf）

(h)　注意事項

• 定義反映のための操作が正しく反映されたかを確認する処理に時間が掛かります。反映処理の確認時間は，imagent設定ファイル（jpc_imagent.json）の項目「service_startup_wait_time」で設定します。

  また，定義ファイルの更新処理は，更新対象のファイルごとに行われます。複数のファイルを更新する場合，ファイル数に応じて完了までに時間が掛かります。

  なお，複数ファイルの更新を行った場合，imbase設定ファイル（jpc_imbase.json）の項目「file_operation_timeout」で設定しているファイル操作処理のタイムアウト時間を超過してしまうおそれがあります。タイムアウト時間を超過した場合，更新に失敗するため，次に示す条件を満たすように設定値を調整してください。

  反映処理の確認時間（service_startup_wait_time） × 同時更新ファイル数 ＜ ファイル操作処理のタイムアウト時間（file_operation_timeout）

  ファイル操作処理のタイムアウト時間は，ファイル操作処理全体に対するタイムアウト時間であるため，余裕を持った値を設定してください。

  上記の定義ファイルの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」（2.　定義ファイル）の「imagent設定ファイル（jpc_imagent.json）」および「imbase設定ファイル（jpc_imbase.json）」を参照してください。

• JP1/IM - Agentに同梱しているアドオンプログラム（OSS）のうち，アドオン管理機能に対応するOSSの定義ファイルを更新した場合，OSSラッパーの自動定期再起動を有効にしている（該当するOSSのサービス定義ファイルまたはユニット定義ファイルで環境変数IMA_OSSWRAPPER_RESTART_INTERVALに値（再起動する間隔）を指定し，OSSラッパーがサービスのプロセスを定期的に自動で再起動するようにしている）ときは，OSSの定義ファイルの更新後にOSSを再起動しなかった場合，定義ファイルの更新内容がOSSのプロセスに反映されませんが，この状態で運用を継続すると，OSSラッパーがサービスのプロセスを自動で再起動するタイミングで設定内容が反映されます。

  なお，OSSによっては，再起動することで運用に影響することがあります。OSSを再起動する場合の注意事項については，マニュアル「JP1/Integrated Management 3 - Manager 運用ガイド」の「10.3.1 停止・再起動時の注意事項」を参照してください。

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

定義ファイルの一括配布機能で更新可能なファイルは，アラート設定ファイル（jp1_alerting_rule.yml）だけです。統合オペレーションビューアーの［アラート設定ファイルの配布］ダイアログで，一括配布するアラート設定ファイルのファイル名（jpc_alerting_rules.yml）を指定します。指定したファイル名が異なる場合は，KAJY68127-Eメッセージを出力して，処理を中断します。

［アラート設定ファイルの配布］ダイアログでのファイルの指定時には，ファイルの内容をチェックしません。定義ファイル更新機能で各ホストにファイルを配布または適用するときに，Prometheusサービスで定義内容をチェックし，定義不正があった場合は定義内容を元に戻します。

(b)　ファイル更新について

定義ファイルの一括配布機能は，定義ファイルの更新機能を使用して定義ファイルを更新します。更新後には，各ホストでの更新成否および失敗した場合のエラーメッセージ（各REST APIから返却されたメッセージ）を表示します。

すべての配布先ホストに対する配布処理が終了した場合，配布結果をJP1イベント（イベントID：3F84）で発行します。詳細については，「3.6.5(5)(g) 更新成否の確認」を参照してください。

(c)　配布処理の並列実行

複数ホストへの配布処理では，統合オペレーション・ビューアーから並列で定義ファイル更新のREST APIを実行します。これにより各ホストでの定義ファイル更新が並列で実行します。並列の多重度は10（固定）です。

(d)　一度に配布できるホスト数

定義ファイルの一括配布機能で，一度に配布できるホストの最大数は200台です。200台以上のホストに配布する必要がある場合は，複数回に分けて配布してください。

(e)　配布処理の中断

配布処理に時間が掛かる場合は，［配布結果］ダイアログ，または，統合オペレーション・ビューアーの画面を閉じることで，一括配布処理を停止できます。ただし，画面を閉じる際に，JP1/IM - Managerで実行中の処理は中断されずに続行し，その次に実行される処理が中断されます。

また，画面を閉じる前に実行または終了していた処理はそのままとなり，配布前の定義に戻すことはありません。

［配布結果］ダイアログを閉じて一括配布処理を停止した場合，停止した旨のJP1イベント（ID：3F85）を発行します。詳細については，「3.6.5(5)(g) 更新成否の確認」を参照してください。また，統合オペレーション・ビューアーを閉じて一括配布処理を停止した場合にはJP1イベントを発行しません。

(f)　配布処理のリトライ

配布処理のリトライが必要なホストがある場合は，該当するホストに再度一括配布を実行してください。

(g)　更新成否の確認

配布した定義ファイルの各ホストでの更新の成否は，統合オペレーション・ビューアーの［配布結果］ダイアログおよびJP1イベントで確認できます。

定義ファイルの一括配布機能は，次の表に示す事象でJP1イベントを発行します。一括配布処理全体の結果（ホストごとの更新成否）は，項番3および項番4のJP1イベントのイベント詳細画面の属性値で確認できます。各ホストでの定義ファイルの更新の成否については，項番1および項番2のメッセージで確認できます。

ユーザーは，配布が失敗したホスト，および，配布が中断したホストを確認し，［統合エージェント一覧］画面から該当するホストを選択して再度一括配布を実行します。

上記表の項番1および項番2については，「3.6.5(4)(f) 統合トレースログの出力とJP1イベントの発行」を参照してください。

上記表の項番3および項番4のJP1イベントは，拡張属性に次の情報を出力します。詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「3.2.2(121) イベントID：00003F84の詳細」および「3.2.2(122) イベントID：00003F85の詳細」を参照してください。また，項番3および項番4のJP1イベントのメッセージは常に英語で出力されます。