jpctool alarm list

〈このページの構成〉

形式
機能
コマンドを実行できるホスト
実行権限
格納先ディレクトリ
引数
注意事項
戻り値
表示情報
使用例1
使用例2
使用例3

形式

jpctool alarm list    {-key サービスキー
                      [-table アラームテーブル名]| -id サービスID}
                      [-wait 秒数]

ページの先頭へ

機能

jpctool alarm listコマンドは，アラームテーブルやアラームの定義情報またはバインド情報を表示するコマンドです。

-keyオプションと-tableオプションの指定の組み合わせと，表示される情報の関係を，次の表に示します。

表2‒84　オプション指定の組み合わせと，表示される情報の関係
オプションの指定			表示される情報
-key	-table	-id	表示される情報
○	×	×	`-key`オプションで指定したPFM - AgentまたはPFM - RMで定義されているアラームテーブル名の一覧が表示される。個々のアラーム名は表示されない。
○	○	×	`-table`オプションで指定したアラームテーブルに定義されているアラーム名，アラームが有効か無効か，アラームテーブルがバインドされているエージェントの一覧が表示される。
×	×	○	エージェントがバインドしているアラームテーブルの一覧が表示される。

（凡例）

○：指定あり

×：指定なし

ページの先頭へ

コマンドを実行できるホスト

PFM - Manager

ページの先頭へ

実行権限

Windowsの場合: Administrators権限を持つユーザー
UNIXの場合: rootユーザー権限を持つユーザー

ページの先頭へ

格納先ディレクトリ

Windowsの場合: インストール先フォルダ\tools\
UNIXの場合: /opt/jp1pc/tools/

ページの先頭へ

引数

-key サービスキー

アラーム定義情報を表示したいPFM - AgentまたはPFM - RMのサービスキーを指定します。プロダクト名表示機能が有効な場合はプロダクト名でも指定できます。ここで指定できるサービスキーは，PFM - AgentまたはPFM - RMのサービスキーだけです。PFM - AgentまたはPFM - RMのサービスキーについては，マニュアル「JP1/Performance Management 設計・構築ガイド」の付録の，命名規則について説明している個所を参照してください。

-table アラームテーブル名

アラーム定義情報を表示するアラームテーブル名を指定します。

1〜64バイトの全角文字，半角英数字，半角空白文字，または次に示す半角記号を指定できます。

　% - ( ) _ . / @ [ ]

ただし，半角空白文字を含む場合は「"」（ダブルクォーテーション）で囲んでください。また，半角記号を指定する場合は，必要に応じてエスケープ表記をしてください。

ワイルドカード文字は使用できません。

-id サービスID

Agent Collectorサービス，Remote Monitor Collectorサービス，リモートエージェントまたはグループエージェントのサービスIDを指定します。ワイルドカード文字（"*"(アスタリスク)および"?"(クエスチョンマーク)）は使用できません。指定できる文字数は1〜258（単位：バイト）です。指定したサービスIDがない場合は，エラーになります。

-wait 秒数

同時に実行できないコマンドが実行中の場合の，最大待機秒数を指定します。この引数は，起動情報ファイル（jpccomm.ini）でアラームコマンドの実行を待機する設定（Alarm Command Wait Mode）を有効にしている場合で，jpccomm.iniファイルでの設定とは異なる秒数を指定したいときに使用します。1〜3600の数字で指定します。

指定を省略した場合，jpccomm.iniファイルでの設定秒数で動作します。

同時に実行できないコマンドについては，「アラームコマンドが同時に実行できないコマンド」を，jpccomm.iniファイルおよびAlarm Command Wait Modeについては，「起動情報ファイル（jpccomm.ini）」を参照してください。

ページの先頭へ

注意事項

このコマンドは多重実行できません。
Name Serverサービス，Master Managerサービス，View Serverサービスのうち，1つ以上のサービスが停止している場合，このコマンドは実行できません。
引数で指定する文字列に全角文字が含まれる場合，jpctool alarmコマンドを実行するシェルの文字環境が日本語（Shift JIS コード，EUC コードまたはUTF-8）または中国語簡体字（GB18030コードまたはUTF-8）であり，PFM - Manager起動時の文字環境と一致している必要があります。このコマンドを実行する前に，シェルの文字環境と，PFM - Manager起動時の文字環境を確認してください。
表示するアラーム定義情報に全角文字が含まれる場合，jpctool alarmコマンドを実行するシェルの文字環境が日本語（Shift JIS コード，EUC コードまたはUTF-8）または中国語簡体字（GB18030コードまたはUTF-8）であり，PFM - Manager起動時の文字環境と一致している必要があります。このコマンドを実行する前に，シェルの文字環境と，PFM - Manager起動時の文字環境を確認してください。

ページの先頭へ

戻り値

0	正常終了した。
1	引数の指定に誤りがある。
2	コマンドの実行権限がない。
3	Name Serverサービス，Master Managerサービス，View Serverサービスのうち，1つ以上のサービスが起動していない。
4	同一マシン上で起動停止コマンドまたはほかのセットアップコマンドが実行されている。
5	PFM - Managerホスト以外で実行された。または，定義を表示するアラームの対象となるエージェントがセットアップされていない。
6	指定されたアラームテーブルがない。
11	ユーザーによって処理が中止された。
100	Performance Managementの環境が不正である。
200	メモリーが不足している。
210	ディスク容量が不足している。
211	ファイルまたはディレクトリにアクセスできない。
222	通信処理でエラーが発生した。
223	通信処理でタイムアウトが発生した。
255	予期しないエラーが発生した。

ページの先頭へ

表示情報

jpctool alarm listコマンドを実行して表示される情報を，次の表に示します。

表2‒85　jpctool alarm listコマンドを実行して表示される情報
項番	表示情報	オプション指定による表示の有無			説明
項番	表示情報	-key	-key，-table	-id	説明
1	Product ID	○	○	×	PFM - AgentまたはPFM - RMの種類を示すプロダクトIDを示す。各PFM - AgentまたはPFM - RMのプロダクトIDについては，各PFM - AgentまたはPFM - RMマニュアルの，付録に記載されている識別子一覧を参照のこと。
2	DataModelVersion	×	○	×	データモデルのバージョンを示す。
3	Alarm Table Name	○	○	×	アラームテーブル名を示す。
4	Alarm Name	×	○	×	アラーム名およびアラームが有効か無効かを示す。 `active`：アラームが有効であることを示す。 `inactive`：アラームが無効であることを示す。
5	The Bound Agent	×	○	×	アラームテーブルがバインドされているエージェントのサービスIDを示す。
6	Service ID	×	×	○	サービスIDを示す。
7	Bound Alarm Table Name	×	×	○	バインドされているアラームテーブル名を示す。

（凡例）

-key：-keyオプションだけを指定した場合

-key，-table：-keyオプションと-tableオプションの両方を指定した場合

○：表示される

×：表示されない

ページの先頭へ

使用例1

PFM - Agent for Platform（UNIX）で，監視テンプレート以外のアラームテーブルalarmtable1が定義されていると仮定します。

このとき，PFM - Agent for Platform（UNIX）で定義されているアラームテーブルの一覧を表示する場合のコマンド実行例を次に示します。

jpctool alarm list -key UNIX

出力結果1

Product ID:U
Alarm Table Name:
  alarmtable1
  PFM UNIX Solution Alarms 7.50
  PFM UNIX Solution Alarms 8.00

ページの先頭へ

使用例2

PFM - Agent for Platform（UNIX）で，監視テンプレートPFM UNIX Solution Alarms 8.00がホストhostAとホストhostBにバインドされていると仮定します。

このとき，PFM - Agent for Platform（UNIX）の監視テンプレートPFM UNIX Solution Alarms 8.00に定義されているアラームの一覧およびバインドされているエージェントの一覧を表示する場合のコマンド実行例を次に示します。

jpctool alarm list -key UNIX -table "PFM UNIX Solution Alarms 8.00"

出力結果2

Product ID:U
DataModelVersion:6.0
Alarm Table Name:PFM UNIX Solution Alarms 8.00
Alarm Name: 
  Disk Service Time   [active]
  I/O Wait Time       [active]
  Kernel CPU          [active]
  Pagescans           [active]
  Run Queue           [active]
  Swap Outs           [active]
  User CPU            [active]
 
The Bound Agent:
  UA1hostA
  UA1hostB

ページの先頭へ

使用例3

PFM - Agent for Platform（UNIX）で，監視テンプレートPFM UNIX Solution Alarms 6.70とユーザー定義のアラームテーブルalarmtable1がホストhostAにバインドされていると仮定します。

このとき，hostAにバインドされているアラームテーブルの一覧を表示する場合のコマンド実行例を次に示します。

jpctool alarm list -id UA1hostA

出力結果3

Service ID:UA1hostA
Bound Alarm Table Name:
   alarmtable1
   PFM UNIX Solution Alarms 6.70

ページの先頭へ