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

〈このページの構成〉

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

形式

定義ファイルの形式

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

モデルファイルの形式

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

ページの先頭へ

ファイル

jpc_user_deffile_list.json

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

ページの先頭へ

格納先ディレクトリ

■統合エージェントホスト

Windowsの場合

物理ホストのとき

Agentパス\conf\
論理ホストのとき

共有フォルダ\jp1ima\conf\

Linuxの場合

物理ホストのとき

/opt/jp1ima/conf/
論理ホストのとき

共有ディレクトリ/jp1ima/conf/

ページの先頭へ

説明

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

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

Windowsの場合：CR+LF

Linuxの場合：LF

ページの先頭へ

定義の反映時期

定義ファイルの更新機能，削除機能，一覧取得機能が動作したときに定義を読み込みます。

ページの先頭へ

記述内容

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

■updateactionの記載について

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

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

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

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

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

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

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

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

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

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

指定できる定義ファイル	定義ファイルを更新した場合に実行すべき操作		GUI上の表示カテゴリ
指定できる定義ファイル	コマンド実行	コマンドライン	GUI上の表示カテゴリ
Blackbox exporterの監視対象（ユーザー定義）のディスカバリ設定ファイル（file_sd_config_blackbox_任意の名前.yml）	Prometheus serverのリロード	■Windowsの場合物理ホストのとき `cmd.exe /c` Agentパス`\addon_management\prometheus\addon_jpc_service_reload.bat` 論理ホストのとき `cmd.exe /c` Agentパス`\addon_management\prometheus\addon_jpc_service_reload.bat -h`論理ホスト ■Linuxの場合物理ホストのとき `/bin/sh -c /opt/jp1ima/addon_management/prometheus/addon_jpc_service_reload` 論理ホストのとき `/bin/sh -c /opt/jp1ima/addon_management/prometheus/addon_jpc_service_reload -h` 論理ホスト	jp1_imexporter
ユーザー独自のディスカバリ設定ファイル（user_file_sd_config_任意の名前.yml）	Prometheus serverのリロード		jp1_imexporter
Fluentdのテキスト形式のログファイルの監視定義ファイル（fluentd_トラップ名_tail.conf）^※	Fluentdのサービスの再起動	■Windowsの場合物理ホストのとき `cmd.exe /c` Agentパス`\addon_management\fluentd\addon_jpc_service_reload.bat` 論理ホストのとき `cmd.exe /c` Agentパス`\addon_management\fluentd\addon_jpc_service_reload.bat -h` 論理ホスト ■Linuxの場合物理ホストのとき `/bin/sh -c /opt/jp1ima/addon_management/fluentd/addon_jpc_service_reload` 論理ホストのとき `/bin/sh -c /opt/jp1ima/addon_management/fluentd/addon_jpc_service_reload -h` 論理ホスト	jp1_imfluenntd
FluentdのWindowsイベントログの監視定義ファイル（fluentd_トラップ名_wevt.conf）^※	Fluentdのサービスの再起動		jp1_imfluenntd
CA証明書ファイル（Blackbox exporter用）^※	Blackbox exporterのリロード	Blackbox exporter設定ファイル（jpc_blackbox_exporter.yml）と同じです。	jp1_certificate
クライアント証明書ファイル（Blackbox exporter用）^※
クライアント証明書キーファイル（Blackbox exporter用）^※
パスワードファイル（Blackbox exporter用）^※
環境変数ファイル（任意のファイル名）^※	不要（環境変数ファイルは，コマンド実行を開始するときに参照されます）	−	−
ログメトリクス定義ファイル（fluentd_任意の名前_logmetrics.conf）	Fluentdのサービスの再起動	■Windowsの場合物理ホストのとき `cmd.exe /c` Agentパス`\addon_management\fluentd\addon_jpc_service_reload.bat` 論理ホストのとき `cmd.exe /c` Agentパス`\addon_management\fluentd\addon_jpc_service_reload.bat -h` 論理ホスト ■Linuxの場合物理ホストのとき `/bin/sh -c /opt/jp1ima/addon_management/fluentd/addon_jpc_service_reload` 論理ホストのとき `/bin/sh -c /opt/jp1ima/addon_management/fluentd/addon_jpc_service_reload -h` 論理ホスト	jp1_imfluentd

（凡例）: −：該当なし
注※: 定義ファイルを追加または削除する場合にも指定できます。

ページの先頭へ