ユーザー作成定義ファイルリスト定義ファイル（imdd_user_deffile_list.json）

〈このページの構成〉

形式
ファイル
格納先ディレクトリ
説明
定義の反映時期
ファイルの文字コード
記述内容
定義例

形式

定義ファイルの形式

{
  "filelist":[
    {
      "filename": "ファイル名",
      "filepath": "ファイルの絶対パス",
      "filecategoryID": "ファイルのカテゴリーID",
      "filecategoryName": "ファイルのカテゴリー名",
      "updateaction": "定義反映のための操作"
    }, ・・・
  ]
}

モデルファイルの形式

{
  "filelist":[
    {
      "filename": "",
      "filepath": "",
      "filecategoryID": "",
      "filecategoryName": "",
      "updateaction": ""
    }
  ]
}

ページの先頭へ

ファイル

imdd_user_deffile_list.json

imdd_user_deffile_list.json.model（モデルファイル）

ページの先頭へ

格納先ディレクトリ

Windowsの場合

物理ホストのとき: Managerパス\conf\imdd\fileoperation\
論理ホストのとき: 共有フォルダ\jp1imm\conf\imdd\fileoperation\

UNIXの場合

物理ホストのとき: /etc/opt/jp1imm/conf/imdd/fileoperation/
論理ホストのとき: 共有ディレクトリ/jp1imm/conf/imdd/fileoperation/

ページの先頭へ

説明

ユーザーが作成する定義ファイルのうち，JP1/IM - Managerが提供する機能で更新や削除ができるファイルを定義するファイルです。

ページの先頭へ

定義の反映時期

定義ファイル一覧取得APIの実行時に反映されます。

ページの先頭へ

ファイルの文字コード

UTF-8（ファイルにBOMが付いていた場合，BOMを無視してロードします）

ページの先頭へ

記述内容

項目名	省略可否	説明
filename	不可	ファイル名を記載します。
filepath	可	ファイルの配置先を絶対パスで記載します。ファイルパス（ファイル名を含めた絶対パス）が，200文字を超えた場合はエラーとなります。指定したファイルパスにfilenameで指定した名称のファイルが存在しない場合は，不正な定義とみなされます。この設定項目を省略した場合，「Managerパス`\conf\imdd\user`」が仮定されます（論理環境の場合は「Managerパス」を「共有フォルダ`\jp1imm`」に読み替えてください）。
filecategoryID	可	複数のファイルをグルーピングしたい場合に指定するカテゴリーIDを記載します。同一のカテゴリーIDを指定したファイルは，同じカテゴリー名に属すると判断されます。指定できる文字は，半角英数字と「`-`」（ハイフン）と「`_`」（アンダースコア）です。最大32文字まで指定できます。「`jp1_`」から始まるカテゴリーIDは指定できません。
filecategoryName	可	カテゴリーIDに対するカテゴリー名を指定します。制御文字以外の文字で指定します。最大32文字まで指定できます。 filecategoryIDの指定がない場合，この設定項目は無視されます。filecategoryIDの指定がある場合，この設定項目の指定がないときは，filecategoryIDの値が設定されます。
updateaction	可	定義ファイルを更新した場合に実行すべき操作（コマンドライン）を記載します。詳細については，「■updateactionの記載について」を参照してください。

■updateactionの記載について

定義ファイルの更新後に実行するコマンドを記載できます。記載できるコマンドラインの長さは4,096バイトまでです。

実行先ホストが64ビット版のWindowsで，%WINDIR%\System32フォルダ以下に配置されているコマンドを指定する場合は，WOW64のリダイレクト機能に留意してください。

コマンドのオプションは指定できません。指定する場合は，コマンドのオプションを指定したバッチファイル（Windowsの場合），シェルスクリプト（Linuxの場合）を作成し，そのバッチファイル，シェルスクリプトをupdateactionに指定してください。

実行できるコマンドの種類を次に示します。

コマンドを実行するホストがWindowsの場合

実行形式ファイル（.com，.exe）
バッチファイル（.bat）
JP1/Scriptのスクリプトファイル（.spt）（ただし，.sptファイルが実行できるよう関連づけが設定されていること）

コマンドを実行するホストがLinuxの場合

Linuxのコマンド
シェルスクリプト

なお，次のようなコマンドは実行できません。

対話操作を必要とするコマンド
画面を表示するコマンド
エスケープシーケンスや制御コードを伴うコマンド
デーモンなどの，終了しないコマンド
Windows メッセージ機構やDDEなど，デスクトップとの対話が必要なコマンド（Windowsの場合）
shutdownやhaltなど，OSをシャットダウンするコマンド

■ユーザー作成定義ファイルリスト定義ファイルに指定できるファイルについて

ユーザー作成定義ファイルリスト定義ファイルに記載できるファイルを，次に示します。

ユーザーが作成する提案定義ファイル（imdd_suggestion_任意のファイル名.conf）
相関イベント発行定義ファイル
相関イベント発行環境定義ファイル
イベント拡張属性定義ファイル
イベント拡張属性定義ファイル（拡張ファイル）
共通除外条件拡張定義ファイル
モニター画面呼び出し定義ファイル
ユーザー独自のメトリック定義ファイル（metrics_任意のPrometheusトレンド名.conf）

論理ホスト環境のJP1/IM3 - Managerの定義ファイルの更新のために，updateactionにjco_spmd_reloadコマンドを指定する場合，-hオプションの指定は不要です。

■ユーザーが作成する定義ファイルの格納先が任意のファイルについて

ユーザーが作成する定義ファイルについて，格納先に任意の場所を指定できるファイルの場合，定義ファイル操作機能を利用するときは，定義ファイルの格納先を次の場所にする必要があります。

Windowsの場合

物理ホストのとき: Managerパス\conf\imdd\user\
論理ホストのとき: 共有フォルダ\jp1imm\conf\imdd\user\

UNIXの場合

物理ホストのとき: /etc/opt/jp1imm/conf/imdd/user/
論理ホストのとき: 共有ディレクトリ/jp1imm/conf/imdd/user/

ページの先頭へ

定義例

{
  "filelist":[
    {
      "filename": "file_def.conf",
      "filepath": "C:\\Program Files (x86)\\Hitachi\\JP1IMM\\conf\\imdd\\user",
      "filecategoryID": "user_def",
      "filecategoryName": "user_def",
      "updateaction": "JP1Cons\\bin\\jco_spmd_reload.exe "
    }
  ]
}

ページの先頭へ