4.10.9 アラーム定義ファイルのエクスポート(JP1/PFM)
機能
この部品は，JP1/PFMのアラーム定義をエクスポートします。
この部品では，次のサーバを前提とします。
・PFM管理サーバ(実行対象サーバ)
この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。
この部品は，出力する内容によって指定が必要なプロパティが異なります。指定したプロパティに応じた次のいずれかのアラーム定義ファイルの内容を，JP1PFM.alarmDefinitionFileNameプロパティに指定したファイルに出力します。
(1) アラーム定義ファイルのテンプレートを出力する場合
JP1PFM.exportTemplateプロパティにtrueを指定してください。
(2) 実行対象サーバのJP1/PFM - Managerに登録されているアラームのうち，指定したサービスキーに合致するJP1/PFM - Agent(またはJP1/PFM - RM)のアラーム定義情報を出力する場合
JP1PFM.serviceKeyプロパティを指定してください。
(3) 指定したアラームテーブルに含まれる，すべてのアラームの定義情報をアラーム定義ファイルに出力する場合
JP1PFM.serviceKeyプロパティ，JP1PFM.alarmTableNameプロパティを指定してください。
(4) 特定のアラームテーブル内の，指定したアラームの定義情報だけをアラーム定義ファイルに出力する場合
JP1PFM.serviceKeyプロパティ，JP1PFM.alarmTableNameプロパティ，JP1PFM.alarmNameプロパティを指定してください。
JP1PFM.exportTemplateプロパティとJP1PFM.serviceKeyプロパティの両方を指定した場合，JP1PFM.exportTemplateプロパティを無視します。どちらのプロパティも指定しない場合，この部品は戻り値41を返し異常終了します。
なおJP1PFM.alarmDefinitionFileNameプロパティに指定したパスにすでにファイルが存在する場合は，ファイルを上書きします。
利用場面
JP1/PFMにより性能監視を行っているシステムで，アラーム定義の情報を更新する場合に使用できます。
次の部品もあわせて使用することで，JP1/PFMの監視条件を自動的に変更できます。
・jp1pfmImportAlarmDef
・osReplaceString
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
(1)JP1/PFM - Manager
【実行対象サーバ内前提製品の稼働OS】
(1) Windows Server 2016 Standard/Datacenter
(2) Windows Server 2019 Standard/Datacenter
(3) Windows Server 2022 Standard/Datacenter
(4) Red Hat Enterprise Linux Server 7
(5) Red Hat Enterprise Linux Server 8
【実行対象サーバ内前提製品の使用条件】
(1) プロパティ「JP1/PFMプロダクトのサービスキー」を指定する場合，JP1/Performance Management - Managerの次のサービスが起動している必要があります。
・Name Serverサービス
・Master Managerサービス
・View Serverサービス
(2) JP1/PFMのjpctool alarm exportコマンドの使用条件を満たしていること。
注意事項
(1)この部品を同一の実行対象サーバに対して多重実行しないでください。
(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードで部品を実行してください。
バージョン
04.00.00
部品のタグ
Configure JP1,PFM,Windows,Linux
タスクログに表示される部品の名称
jp1pfmExportAlarmDef
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
13 |
異常(ユーザーミス) 認証不可 |
|
14 |
異常(ユーザーミス) ファイルアクセス不可 |
|
20 |
異常(ユーザーミス) その他ユーザーエラー |
|
21 |
異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知) |
|
22 |
異常(環境不正) メモリ/ディスク容量不足 |
|
23 |
異常(環境不正) 前提環境不正 |
|
24 |
異常(環境不正) 起動状態不正 |
|
25 |
異常(環境不正) 通信エラー |
|
26 |
異常(連携製品トラブル) 内部エラー |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
JP1PFM.alarmDefinitionFileName |
アラーム定義ファイル名 |
JP1/PFMのアラーム定義情報をエクスポートするファイルのパスをフルパスで指定します。 |
− |
入力 |
○ |
|
JP1PFM.serviceKey |
JP1/PFMプロダクトのサービスキー |
JP1/PFM - Agent(またはJP1/PFM - RM)のサービスキーを指定します。プロダクト名表示機能が有効の場合，プロダクト名も指定できます。このプロパティはJP1PFM.exportTemplateと同時に指定できません。 |
− |
入力 |
△ |
|
JP1PFM.alarmTableName |
アラームテーブル名 |
JP1/PFMのアラームテーブル名を指定します。このプロパティは，JP1PFM.serviceKeyと同時に指定します。 |
− |
入力 |
△ |
|
JP1PFM.alarmName |
アラーム名 |
アラーム名を指定します。このプロパティは，JP1PFM.serviceKeyおよびJP1PFM.alarmTableNameと同時に指定します。 |
− |
入力 |
△ |
|
JP1PFM.exportTemplate |
テンプレートの出力要否 |
アラーム定義ファイルのテンプレートを出力する場合にtrueを指定します。このプロパティはJP1PFM.serviceKeyと同時に指定できません。 |
− |
入力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |