mfwkadm コマンド

この節の内容は、マニュアルページのセクション 1M にある、保守コマンド mfwkadm のマニュアルページの内容を再構成したものです。このコマンドは、ノードエージェントの内容を管理するために使用します。管理する内容には、監視対象となっているコンポーネントのすべてのモジュールや、監視ジョブと呼ばれるこのノード上で定義した監視ルールが含まれます。マニュアルページの一部の用語や説明については、このガイドで使用されている用語や説明と一致するように変更が加えられています。

機能説明

パフォーマンス監視

運用ステータス監視

しきい値監視

説明

mfwkadm ユーティリティーは、ノードエージェントとも呼ばれる Monitoring Framework エージェントを管理するためのコマンド行インタフェースです。ノードエージェントは共通エージェントコンテナの内部で実行されます。mfwkadm ユーティリティーを使用して、ノードエージェントを停止および再起動したり、エージェントが実行する監視ジョブを管理したりできます。このコマンドは、ノードエージェントが動作しているホストと同じホストから実行することをお勧めします。このコマンドの引数は、ここで示されている順序どおりに指定する必要があります。

出力メッセージの言語を変更するには、使用する言語のロケールに対応した値を LC_MESSAGE 環境変数に設定します。mfwkadm コマンドは、lib/resources ディレクトリ内の JesmfMessages_locale.pm という名前のファイルに格納されているメッセージを使用します。指定されたロケールに対応するメッセージファイルが存在しないか、ロケールを指定しない場合、mfwkadm コマンドは JesmfMessages.pm ファイル内のデフォルトのメッセージセットを使用します。

mfwkadm ユーティリティーのサブコマンドを次に示します。アスタリスク (*) の付いたコマンドを使用するには、共通エージェントコンテナが実行中でノードエージェントがロードされている必要があります。

• start

• stop

• restart

• list-params (*)

• list-modules (*)

• info (*)

• pm-job (*)

• opstat-job (*)

• thrsh-job (*)

ノードエージェントが起動してから mfwkadm ユーティリティーが使用可能になるまでの間には、ロードする共通エージェントコンテナモジュールの数に応じて数秒から数分の遅延が発生します。この期間中は、コマンドを実行しようとしても明示的なメッセージを出して失敗します。

オプション

次のオプションがサポートされています。

--help

使用方法の要約を表示します。

サブコマンド

start

共通エージェントコンテナを停止せずに、Monitoring Framework ノードエージェントとその関連コンポーネント製品モジュールを起動します。

この動作では、まずノードエージェントが配備されてから、関連するコンポーネント製品モジュールが共通エージェントコンテナに配備されます。この機能は、cacaoadm ユーティリティーの lock および undeploy サブコマンドのラッパーです。

start サブコマンドでは、ノードエージェントと、Monitoring Framework に関連付けられた Java ES コンポーネントモジュールのみが起動されます。コンポーネントモジュールには com.sun.cmm というプレフィックスが付きます。

セキュリティー:start サブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。それ以外のユーザーが実行しようとした場合、次のようなエラーメッセージが表示されます。

Error occured in mfwkadm Problem running /usr/sbin/cacaoadm unlock com.sun.mfwk 2>&1. Stdout/Stderr: This command must be run by user: [root].

stop

Monitoring Framework ノードエージェントと、それに関連付けられた共通エージェントコンテナ内の Java ES コンポーネントモジュールを停止します。

この動作ではまず、共通エージェントコンテナに配備されているすべての Java ES コンポーネントのモジュールが停止され、続いてノードエージェントが停止されます。この機能は、cacaoadm ユーティリティーの lock および unlock サブコマンドのラッパーです。

stop サブコマンドは、Monitoring Framework と関連付けられている Java ES コンポーネントモジュールのみを停止し、続いてノードエージェント自体を停止します。コンポーネントモジュールには com.sun.cmm というプレフィックスが付きます。

セキュリティー:stop サブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。それ以外のユーザーが実行しようとした場合、次のようなエラーメッセージが表示されます。

Error occured in mfwkadm Problem running /usr/sbin/cacaoadm unlock com.sun.mfwk 2>&1. Stdout/Stderr: This command must be run by user: [root].

restart

Monitoring Framework ノードエージェントと、それに関連付けられた共通エージェントコンテナ内の Java ES コンポーネントモジュールを再起動します。

この動作は、stop および start サブコマンドと同じように、ノードエージェントと、それに関連付けられた共通エージェントコンテナ内のモジュールの停止および起動を試みます。

セキュリティー:restart サブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。それ以外のユーザーが実行しようとした場合、次のようなエラーメッセージが表示されます。

Error occured in mfwkadm Problem running //usr/sbin/cacaoadm unlock com.sun.mfwk 2>&1. Stdout/Stderr: This command must be run by user: [root].

list-params

Monitoring Framework ノードエージェントに関係するすべての設定パラメータを一覧表示します。

セキュリティー:このコマンドにはユーザー制限はありません。

list-modules

Common Monitoring Model (CMM) を実装し、共通エージェントコンテナにロードされるコンポーネント製品モジュールの一覧を表示します。このサブコマンドは、インストールされた各 Java ES コンポーネントのすべての実行中インスタンスも一覧表示します。各コンポーネントには、0 個、1 個、または 2 個以上の実行中インスタンスが存在する可能性があります。

セキュリティー:共通エージェントコンテナを起動したユーザー以外のユーザーが実行した場合、インストールされた Java ES コンポーネントの一覧にはコンポーネントインスタンスは含まれません。

info runningInstance

runningInstance で指定された実行中インスタンスについての情報を表示します。runningInstance は、list-modules サブコマンドの出力で表示された実行中インスタンスと一致する必要があります。

表示される情報には次のものが含まれます。

• 監視ジョブのタイプごとに、実行中のインスタンスと関連付けられたすべての監視可能オブジェクトがクラス名でソートされて表示されます。監視可能なオブジェクトとは、pm-job サブコマンドでパフォーマンス監視ジョブを、opstat-job サブコマンドで運用ステータスジョブを、または thrsh-job サブコマンドでしきい値監視ジョブを作成できるオブジェクトのことです。

• 監視可能オブジェクトのクラスごとに、各クラスの名前やタイプなど、クラスの監視可能属性のすべてが表示されます。

セキュリティー:共通エージェントコンテナを起動したユーザー以外によって実行された場合、情報は表示されません。

パフォーマンス監視

pm-job observable-classes

パフォーマンス監視ジョブを作成できるオブジェクトについて、現在監視可能なすべてのクラスの一覧を表示します。

pm-job observable-objects [class= objectC lass] [domain=objectDomain]

パフォーマンス監視ジョブを作成できる、現在監視可能なすべてのオブジェクトの一覧を表示します。デフォルトでは、すべての監視可能クラスの、またすべてのドメイン内のすべてのオブジェクトが一覧表示されます。オブジェクトの一覧はクラス名でソートされます。

class=objectClass

オプションの objectClass を指定すると、その特定クラスの監視可能オブジェクトのみに出力が限定されます。objectClass は、pm-job observable-classes サブコマンドによって一覧表示されるいずれかのクラスである必要があります。

domain=objectDomain

オプションの objectDomain を指定すると、そのドメイン内の監視可能オブジェクトのみに出力が限定されます。オブジェクトのドメインは、オブジェクトの名前のうちコロン (:) 記号よりも前の文字列の部分です。

pm-job observable-attributes class=objectClass

objectClass で指定されたオブジェクトクラスのすべての監視可能属性の一覧を表示します。属性はその名前および型とともに表示されます。objectClass は、pm-job observable-classes サブコマンドによって一覧表示されるパフォーマンス監視ジョブをサポートするクラスのいずれかである必要があります。

pm-job list

現在定義されているすべてのパフォーマンス監視ジョブの一覧を表示します。定義されているパフォーマンス監視ジョブが存在するオブジェクトごとにジョブが一覧表示され、オブジェクトはそのクラス名によってソートされます。各ジョブについて表示される情報は、pm-job info サブコマンドによって表示されるものと同じです。

セキュリティー:共通エージェントコンテナを起動したユーザー以外によって実行された場合、ジョブは表示されません。

pm-job info jobName

jobName で指定されたパフォーマンス監視ジョブについての詳細情報を表示します。jobName は、pm-job list サブコマンドによって表示されるジョブである必要があります。このサブコマンドは次の情報を表示します。

• パフォーマンス監視ジョブの名前。

• パフォーマンス監視ジョブのタイプ。「by object」(オブジェクト別) または「by class」(クラス別) のいずれか。オブジェクト別ジョブは、1 つ以上の名前付きオブジェクトインスタンスを監視します。クラス別ジョブは、オブジェクトクラスのすべてのインスタンスを監視します。mfwkadm ユーティリティーではクラス別ジョブを作成できないことに注意してください。

• パフォーマンス監視ジョブの状態。「active on-duty」(アクティブで監視中)、「active off-duty」(アクティブのみ)、または「suspended」(停止中) のいずれか。「アクティブで監視中」のジョブは、その時点でスケジュールに従って実行中であり、かつデータを収集中です。「アクティブのみ」のジョブは実行中ですが、その時点で作業スケジュール外であるためデータは収集していません。「停止中」のジョブは実行されておらず、データも収集していません。パフォーマンス監視ジョブの実行状態を変更するには、pm-job suspend および pm-job resume サブコマンドを使用します。

• パフォーマンス監視ジョブの粒度 (秒数)。これは、このジョブによるデータ収集の間隔です。

• 監視ジョブのレポート期間。レポート期間と粒度の積により、通知頻度が算出されます。たとえば、粒度が 10 秒でレポート期間が 6 の場合、イベント別のジョブレポートは 10 秒おきにデータを収集し、6 つのレポートを含む通知を 60 秒 (10*6) おきに送信します。ジョブがファイル別のレポートも行っている場合、このジョブは 6 つの生成されたファイルの場所を含むイベントを 60 秒おきに送信します。

• パフォーマンス監視ジョブがイベント別のレポートを行っているかどうか。これは、パフォーマンス監視ジョブの結果が、登録済みクライアントに通知として送信されることを意味します。

• パフォーマンス監視ジョブがファイル別のレポートを行っているかどうか。これは、パフォーマンス監視ジョブのレポートがローカルファイルに書き込まれ、ファイル名を含む通知が登録済みクライアントに送信されることを意味します。

• パフォーマンス監視ジョブのレポート形式。これは常に XML です。

• パフォーマンス監視ジョブのスケジュール。スケジュールは、ジョブが「アクティブで監視中」(データを収集する) または「アクティブのみ」(データは収集しない) の状態になる日時を指定します。

オブジェクト別ジョブについては、次の情報が表示されます。

• 名前でソートされた監視対象オブジェクトの一覧。

• 監視可能属性のうち一部のみが指定されている場合、監視対象オブジェクトの監視対象属性が名前および型別に一覧表示されます。

クラス別ジョブについては、次の情報が表示されます。

• 名前でソートされた監視対象クラスの一覧。

• 監視可能属性のうち一部のみが指定されている場合、監視対象クラスの監視対象属性が名前および型別に一覧表示されます。これらの属性はすべてのクラスに共通です。

セキュリティー:共通エージェントコンテナを起動したユーザー以外によって実行された場合、情報は表示されません。

pm-job create jobName granularity= integerValue object=objectName [object= objectName ...]

1 つ以上のオブジェクトを対象とした新しいパフォーマンス監視ジョブを作成します。mfwkadm コマンドでは、クラス別ジョブは作成できません。パフォーマンス監視ジョブを作成するとき、次のパラメータを設定できます。

jobName

パフォーマンス監視ジョブを一意に識別する文字列。jobName には、ほかのパフォーマンス監視ジョブによってすでに使用されている文字列は指定できません。

granularity=integerValue

ジョブが「アクティブで監視中」のときに、2 回の連続する測定データ収集の開始間隔を秒数で指定します。粒度期間の指定例は、300 秒 (5 分)、900 秒 (15 分)、1800 秒 (30 分おき)、3600 秒 (1 時間おき) などです。ほとんどの場合、300 秒の粒度期間で十分です。一部の測定値については、より大きな粒度期間でデータを収集すると効果的な場合があります。

object=objectName [object= objectName ...]

パフォーマンス監視ジョブがデータを収集してレポートする、1 つ以上の監視対象オブジェクト。objectName は、pm-job list または pm-job observable-objects サブコマンドによって表示されるオブジェクトである必要があります。「object=objectName」パラメータを複数指定すると、複数のオブジェクトを監視する 1 つのパフォーマンス監視ジョブが作成されます。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

pm-job delete jobName

jobName で指定されたパフォーマンス監視ジョブを削除します。jobName は、pm-job list サブコマンドによって表示されるジョブである必要があります。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

pm-job suspend jobName

jobName で指定されたパフォーマンス監視ジョブを停止します。停止されたジョブは、そのスケジュールに関係なく、実行されずデータも収集しません。ただし、ジョブの定義は残り、pm-job resume サブコマンドによってそのジョブを再びアクティブにすることができます。jobName は、pm-job list サブコマンドによって表示されるジョブである必要があります。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

pm-job resume jobName

jobName で指定されたパフォーマンス監視ジョブを再開します。再開されたジョブは、そのスケジュールに従ったデータ収集およびレポート送信を開始します。jobName は、pm-job list サブコマンドによって表示されるジョブである必要があります。これは、pm-job suspend サブコマンドとペアで機能するコマンドです。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

運用ステータス監視

opstat-job observable-classes

運用ステータス監視ジョブを作成できるオブジェクトについて、現在監視可能なすべてのクラスの一覧を表示します。

opstat-job observable-objects [class= objectClass] [domain=objectDomain]

運用ステータス監視ジョブを作成できる、現在監視可能なすべてのオブジェクトの一覧を表示します。デフォルトでは、すべての監視可能クラスの、またすべてのドメイン内のすべてのオブジェクトが一覧表示されます。オブジェクトの一覧はクラス名でソートされます。

class=objectClass

オプションの objectClass を指定すると、その特定クラスの監視可能オブジェクトのみに出力が限定されます。objectClass は、opstat-job observable-classes サブコマンドによって一覧表示されるいずれかのクラスである必要があります。

domain=objectDomain

オプションの objectDomain を指定すると、そのドメイン内の監視可能オブジェクトのみに出力が限定されます。オブジェクトのドメインは、オブジェクトの名前のうちコロン (:) 記号よりも前の文字列の部分です。

opstat-job observable-attributes class= objectClass

objectClass で指定されたオブジェクトクラスのすべての監視可能属性の一覧を表示します。属性はその名前および型とともに表示されます。objectClass は、opstat-job observable-classes サブコマンドによって一覧表示されるいずれかのクラスである必要があります。

opstat-job list

現在定義されているすべての運用ステータス監視ジョブの一覧を表示します。定義されている運用ステータス監視ジョブが存在するオブジェクトごとにジョブが一覧表示され、オブジェクトはそのクラス名によってソートされます。各ジョブについて表示される情報は、opstat-job info サブコマンドによって表示されるものと同じです。

セキュリティー:共通エージェントコンテナを起動したユーザー以外によって実行された場合、ジョブは表示されません。

opstat-job info jobName

jobName で指定された運用ステータス監視ジョブについての詳細情報を表示します。jobName は、opstat-job list サブコマンドによって表示されるジョブである必要があります。このサブコマンドは次の情報を表示します。

• 運用ステータス監視ジョブの名前。

• 運用ステータス監視ジョブのタイプ。「by object」(オブジェクト別) または「by class」(クラス別) のいずれか。オブジェクト別ジョブは、1 つの名前付きオブジェクトインスタンスを監視します。クラス別ジョブは、オブジェクトクラスのすべてのインスタンスを監視します。mfwkadm ユーティリティーではクラス別ジョブを作成できないことに注意してください。

• 運用ステータス監視ジョブの状態。「active on-duty」(アクティブで監視中)、「active off-duty」(アクティブのみ)、または「suspended」(停止中) のいずれか。「アクティブで監視中」のジョブは、その時点でスケジュールに従って実行中であり、かつデータを収集中です。「アクティブのみ」のジョブは実行中ですが、その時点で作業スケジュール外であるためデータは収集していません。「停止中」のジョブは実行されておらず、データも収集していません。運用ステータス監視ジョブの実行状態を変更するには、opstat-job suspend および opstat-job resume サブコマンドを使用します。

• 運用ステータス監視ジョブの粒度 (秒数)。これは、このジョブによるデータ収集の間隔です。

• 運用ステータス監視ジョブがイベント別のレポートを行っているかどうか。これは、運用ステータス監視ジョブの結果が、登録済みクライアントに通知として送信されることを意味します。

• 運用ステータス監視ジョブがファイル別のレポートを行っているかどうか。これは、運用ステータス監視ジョブのレポートがローカルファイルに書き込まれ、ファイル名を含む通知が登録済みクライアントに送信されることを意味します。

• 運用ステータス監視ジョブのレポート形式。これは常に XML です。

• 運用ステータス監視ジョブのスケジュール。スケジュールは、ジョブが「アクティブで監視中」(データを収集する) または「アクティブのみ」(データは収集しない) の状態になる日時を指定します。

• オブジェクト別ジョブの場合、名前でソートされた監視対象オブジェクトの一覧。

• クラス別ジョブの場合、名前でソートされた監視対象クラスの一覧。

セキュリティー:共通エージェントコンテナを起動したユーザー以外によって実行された場合、情報は表示されません。

opstat-job create jobName granularity= integerValue object=objectName [object= objectName ...]

1 つ以上のオブジェクトを対象とした新しい運用ステータス監視ジョブを作成します。mfwkadm コマンドでは、クラス別ジョブは作成できません。パフォーマンス監視ジョブを作成するとき、次のパラメータを設定できます。

jobName

運用ステータス監視ジョブを一意に識別する文字列。jobName には、ほかの運用ステータス監視ジョブによってすでに使用されている文字列は指定できません。

granularity=integerValue

ジョブが「アクティブで監視中」のときに、2 回の連続する測定データ収集の開始間隔を秒数で指定します。

object=objectName [object= objectName ...]

運用ステータス監視ジョブがデータを収集してレポートする、1 つ以上の監視対象オブジェクト。objectName は、opstat-job list または opstat-job observable-objects サブコマンドによって表示されるオブジェクトである必要があります。「object=objectName」パラメータを複数指定すると、複数のオブジェクトを監視する 1 つの運用ステータス監視ジョブが作成されます。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

opstat-job delete jobName

jobName で指定された運用ステータス監視ジョブを削除します。jobName は、opstat-job list サブコマンドによって表示されるジョブである必要があります。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

opstat-job suspend jobName

jobName で指定された運用ステータス監視ジョブを停止します。停止されたジョブは、そのスケジュールに関係なく、実行されずデータも収集しません。ただし、ジョブの定義は残り、opstat-job resume サブコマンドによってそのジョブを再びアクティブにすることができます。jobName は、opstat-job list サブコマンドによって表示されるジョブである必要があります。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

opstat-job resume jobName

jobName で指定された運用ステータス監視ジョブを再開します。再開されたジョブは、そのスケジュールに従ったデータ収集およびレポート送信を開始します。jobName は、opstat-job list サブコマンドによって表示されるジョブである必要があります。これは、opstat-job suspend サブコマンドとペアで機能するコマンドです。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

しきい値監視

thrsh-job observable-classes

しきい値監視ジョブを作成できるオブジェクトについて、現在監視可能なすべてのクラスの一覧を表示します。

thrsh-job observable-objects [class= objectClass] [domain=objectDomain]

しきい値監視ジョブを作成できる、現在監視可能なすべてのオブジェクトの一覧を表示します。デフォルトでは、すべての監視可能クラスの、またすべてのドメイン内のすべてのオブジェクトが一覧表示されます。オブジェクトの一覧はクラス名でソートされます。

class=objectClass

オプションの objectClass を指定すると、その特定クラスの監視可能オブジェクトのみに出力が限定されます。objectClass は、thrsh-job observable-classes サブコマンドによって一覧表示されるいずれかのクラスである必要があります。

domain=objectDomain

オプションの objectDomain を指定すると、そのドメイン内の監視可能オブジェクトのみに出力が限定されます。オブジェクトのドメインは、オブジェクトの名前のうちコロン (:) 記号よりも前の文字列の部分です。

thrsh-job observable-attributes class=objectClass

objectClass で指定されたオブジェクトクラスのすべての監視可能属性の一覧を表示します。属性はその名前および型とともに表示されます。objectClass は、thrsh-job observable-classes サブコマンドによって一覧表示されるいずれかのクラスである必要があります。

thrsh-job list

現在定義されているすべてのしきい値監視ジョブの一覧を表示します。定義されているしきい値監視ジョブが存在するオブジェクトごとにジョブが一覧表示され、オブジェクトはそのクラス名によってソートされます。各ジョブについて表示される情報は、thrsh-job info サブコマンドによって表示されるものと同じです。

セキュリティー:共通エージェントコンテナを起動したユーザー以外によって実行された場合、ジョブは表示されません。

thrsh-job info jobName

jobName で指定されたしきい値監視ジョブについての詳細情報を表示します。jobName は、thrsh-job list サブコマンドによって表示されるジョブである必要があります。このサブコマンドは次の情報を表示します。

• しきい値監視ジョブの名前。

• しきい値監視ジョブの多重度。このリリースでは、1 つのオブジェクトの 1 つの属性を監視する単純なしきい値監視ジョブのみを使用できます。

• しきい値監視ジョブの状態。「active on-duty」(アクティブで監視中)、「active off-duty」(アクティブのみ)、または「suspended」(停止中) のいずれか。「アクティブで監視中」のジョブは、その時点でスケジュールに従って実行中であり、かつデータを収集中です。「アクティブのみ」のジョブは実行中ですが、その時点で作業スケジュール外であるためデータは収集していません。「停止中」のジョブは実行されておらず、データも収集していません。しきい値監視ジョブの実行状態を変更するには、thrsh-job suspend および thrsh-job resume サブコマンドを使用します。

• しきい値監視ジョブの粒度 (秒数)。これは、このジョブによるデータ収集の間隔です。

• しきい値監視ジョブのスケジュール。スケジュールは、ジョブが「アクティブで監視中」(データを収集する) または「アクティブのみ」(データは収集しない) の状態になる日時を指定します。

• しきい値監視ジョブのアラーム設定。これは、監視対象属性の監視対象値が、定義されたしきい値を超えたときに生成されるアラームです。表示にはアラームの種類および重大度が含まれます。

• しきい値監視ジョブの監視対象オブジェクト。

• しきい値が適用される属性名。

• アラームを生成するしきい値の値。

• しきい値に達したときにアラームを生成する値の進行方向。RISING (上昇) または FALLING (下降)。

• しきい値の許容範囲オフセット。方向が RISING の場合、監視対象属性の値が thresholdValue-offsetValue を下回るまでアラームは再生成されません。方向が FALLING の場合、監視対象属性の値が thresholdValue+offsetValue を上回るまでアラームは再生成されません。この動作は、オフセットがゼロの場合でも適用されます。

セキュリティー:共通エージェントコンテナを起動したユーザー以外によって実行された場合、情報は表示されません。

thrsh-job create jobName object= objectName granularity=integerValue attributeName= attributeName attributeType=attributeType thresholdValue= thresholdValue thresholdOffset=offsetValue thresholdDirection= [RISING|FALLING]

1 つのオブジェクトの 1 つの属性を監視する新しいしきい値監視ジョブを作成します。しきい値ジョブを作成するとき、次のパラメータを設定できます。

jobName

しきい値監視ジョブを一意に識別する文字列。jobName には、ほかのしきい値監視ジョブによってすでに使用されている文字列は指定できません。

object=objectName

しきい値監視ジョブが、しきい値との比較目的で属性値を収集する対象の監視可能オブジェクト。objectName は、thrsh-job list または thrsh-job observable-objects サブコマンドによって表示されるオブジェクトである必要があります。

granularity=integerValue

ジョブが「アクティブで監視中」のときに、2 回の連続する属性値監視の開始間隔を秒数で指定します。

attributeName=attributeName

しきい値監視ジョブがその値を収集し、しきい値と比較する対象の属性の名前。attributeName は、thrsh-job info または thrsh-job observable-attributes サブコマンドによって一覧表示される属性名である必要があります。

attributeType=attributeType

監視される監視可能属性の型。attributeType は、thrsh-job info または thrsh-job observable-attributes サブコマンドによって一覧表示される属性の型である必要があります。

thresholdValue=thresholdValue

thresholdDirection で指定された方向にしきい値を通過したときに、このしきい値監視ジョブがアラームを生成する監視対象属性の値。

thresholdOffset=offsetValue

offsetValue は、後続のアラームを生成する際のしきい値監視ジョブの許容範囲を決定します。offsetValue はゼロまたは正の値である必要があります。アラームイベントが生成されたあと、offsetValue および thresholdDirection によって定義された範囲を監視対象属性の値が超えるまで、新しいアラームイベントは生成されません。

thresholdDirection=[RISING|FALLING]

方向が RISING の場合、監視対象属性の値が thresholdValue-offsetValue を下回るまでアラームイベントは再生成されません。方向が FALLING の場合、監視対象属性の値が thresholdValue+offsetValue を上回るまでアラームイベントは再生成されません。この動作は、offsetValue がゼロの場合にも適用されます。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

thrsh-job delete jobName

jobName で指定されたしきい値監視ジョブを削除します。jobName は、thrsh-job list サブコマンドによって表示されるジョブである必要があります。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

thrsh-job suspend jobName

jobName で指定されたしきい値監視ジョブを停止します。停止されたジョブは、そのスケジュールに関係なく、実行されずデータも収集しません。ただし、ジョブの定義は残り、thrsh-job resume サブコマンドによってそのジョブを再びアクティブにすることができます。jobName は、thrsh-job list サブコマンドによって表示されるジョブである必要があります。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

thrsh-job resume jobName

jobName で指定されたしきい値監視ジョブを再開します。再開されたジョブは、そのスケジュールに従ったデータ収集およびレポート送信を開始します。jobName は、thrsh-job list サブコマンドによって表示されるジョブである必要があります。これは、thrsh-job suspend サブコマンドとペアで機能するコマンドです。

セキュリティー:このサブコマンドを実行できるのは、共通エージェントコンテナを起動したユーザーに限られます。

例

次の架空のシナリオは、mfwkadm ユーティリティーと、そのオプションおよびサブコマンドの使用方法の例を示します。

list-modules サブコマンドは、現在のホスト上の Java ES コンポーネントインスタンスと、それらに対応する共通エージェントコンテナ内のモジュールを示します。次の例は、2 つのインストール済みコンポーネントを一覧表示します。Directory Server には実行中のインスタンスがなく、Web Server には 1 つの実行中インスタンスがあります。

$ mfwkadm list-modules

Installed products and their running instances:
==============================================

Instances for installed product: com.sun.cmm.ds:collectionID=/opt/SUNWdsee/ds6,
name=Sun Java(TM) System Directory Server,type=CMM_InstalledProduct
-------------------------------

No instance.

Instances for installed product: com.sun.cmm.ws:collectionID=/var/opt/SUNWwbsvr7,
name=WebServer,type=CMM_InstalledProduct
-------------------------------

/wsPrefix/com.sun.cmm.ws:name=https-hostname.example.com,type=CMM_ApplicationSystem

次の info サブコマンドは、Web Server インスタンス内の監視可能オブジェクトと、それらのオブジェクトのクラスおよび属性をジョブのタイプ別に表示します。

$ mfwkadm info /wsPrefix/com.sun.cmm.ws:name=https-hostname.example.com,\\
type=CMM_ApplicationSystem

Information about running instance: /wsPrefix/com.sun.cmm.ws:
name=https-hostname.example.com,type=CMM_ApplicationSystem
==================================

Observable objects for performance jobs:
---------------------------------------

+ Objects of class: com.sun.cmm.settings.CMM_ApplicationSystemSetting

        /wsPrefix/com.sun.cmm.ws:name=https-hostname.example.com-setting,
type=CMM_ApplicationSystemSetting

        Observable attributes:

        Caption [STRING]
        ConfigurationDirectory [STRING]
        CreationClassName [STRING]
        Description [STRING]
        DirectoryName [STRING]
        ElementName [STRING]
        InstanceID [STRING]
        Name [STRING]
        URL [STRING]

+ Objects of class: com.sun.cmm.settings.CMM_KeepAliveSetting

        /wsPrefix/com.sun.cmm.ws:name=process-1-keepalive-setting,
type=CMM_KeepAliveSetting

        Observable attributes:

        AllocationUnit [STRING]
        Caption [STRING]
        ConnectionsUpperBound [LONG]
        CreationClassName [STRING]
        Description [STRING]
        ElementName [STRING]
        InputUnit [STRING]
        InstanceID [STRING]
        LowerAllocationLimit [LONG]
        LowerInputLimit [LONG]
        LowerOutputLimit [LONG]
        Name [STRING]
        OtherAllocationUnit [STRING]
        OtherInputUnit [STRING]
        OtherLowerAllocationLimit [LONG]
        OtherLowerInputLimit [LONG]
        OtherLowerOutputLimit [LONG]
        OtherOutputUnit [STRING]
        OtherUpperAllocationLimit [LONG]
        OtherUpperInputLimit [LONG]
        OtherUpperOutputLimit [LONG]
        OutputUnit [STRING]
        QueuedUpperBound [LONG]
        SecondsTimeout [LONG]
        TimeoutUpperBound [LONG]
        UpperAllocationLimit [LONG]
        UpperInputLimit [LONG]
        UpperOutputLimit [LONG]
        ...

次のコマンドは、定義済みのパフォーマンス監視ジョブの一覧を表示します。この例では、1 つのオブジェクトを監視する、myPerfJob という名前の 1 つのパフォーマンス監視ジョブが存在します。

$ mfwkadm pm-job list

BY_OBJECTS performance jobs:
===========================

Performance job information for: myPerfJob
-------------------------------

Type:                BY_OBJECTS
State:               ACTIVE_ON_DUTY
Granularity period:  30
Reporting period:    1
By event:            EVENT_SINGLE
By file:             EVENT_SINGLE
Report format:       XML
Schedule:           
        Global start time: Immediately
        Global stop time: Forever
        Weekly schedule: Everyday
        Daily schedule: All day
Observed objects:    
                /wsPrefix/com.sun.cmm.ws:name=virtualServer-hostname.example.com-
webApp-/-stats,type=CMM_VirtualServerWebModuleStats
Observed attributes: 
                All available

BY_CLASSES performance jobs:
===========================

No jobs found.

次のコマンドは、opstat-job info または opstat-job observable-objects サブコマンドで取得された 2 つの監視可能オブジェクトに関係する運用ステータス監視ジョブを作成します。

$ mfwkadm opstat-job create myOpStatJob granularity=60 \\
object=/wsPrefix/com.sun.cmm.ws:name=process-1,type=CMM_UnixProcess \\
object=/wsPrefix/com.sun.cmm.ws:name=process-1-DNSCache1,type=CMM_DnsCache

次のコマンドは、前の例で作成したジョブを停止します。

$ mfwkadm opstat-job suspend myOpStatJob

次のコマンドは、潜在的なしきい値監視ジョブの監視可能クラスを示します。

$ mfwkadm thrsh-job observable-classes

Threshold jobs observable classes:
=================================

com.sun.cmm.cim.CIM_ScopedSettingData
com.sun.cmm.cim.CIM_SettingData
com.sun.cmm.cim.CIM_StatisticalData
com.sun.cmm.cim.statistics.CIM_EthernetPortStatistics
com.sun.cmm.cim.statistics.CIM_NetworkPortStatistics
com.sun.cmm.cim.statistics.j2ee.CIM_J2eeJVMStats
com.sun.cmm.cim.statistics.j2ee.CIM_J2eeStatistic
com.sun.cmm.settings.CMM_ApplicationSystemSetting
com.sun.cmm.settings.CMM_KeepAliveSetting
com.sun.cmm.settings.CMM_QueueTimeoutSetting
com.sun.cmm.settings.CMM_RFC2788ApplicationSystemSetting
com.sun.cmm.settings.CMM_ScopedSettingData
com.sun.cmm.settings.CMM_SoftwareResourceSetting
com.sun.cmm.settings.CMM_SWRBufferSetting
com.sun.cmm.settings.CMM_SWRLimitSetting
com.sun.cmm.settings.CMM_SWRQueueSetting
com.sun.cmm.settings.CMM_VirtualServerSetting
com.sun.cmm.statistics.CMM_ApplicationSystemStats
com.sun.cmm.statistics.CMM_ApplicationSystemWatchdogStats
com.sun.cmm.statistics.CMM_ConnectionQueueStats
com.sun.cmm.statistics.CMM_DnsCacheStats
com.sun.cmm.statistics.CMM_EthernetPortStats
com.sun.cmm.statistics.CMM_FileCacheStats
com.sun.cmm.statistics.CMM_HTTPResponsesStats
com.sun.cmm.statistics.CMM_JVMJSR174ExtStats
com.sun.cmm.statistics.CMM_JVMJSR174Stats
com.sun.cmm.statistics.CMM_JVMStats
com.sun.cmm.statistics.CMM_NetworkPortStats
com.sun.cmm.statistics.CMM_OperatingSystemStats
com.sun.cmm.statistics.CMM_ProcessorStats
com.sun.cmm.statistics.CMM_ProcessStats
com.sun.cmm.statistics.CMM_QueueTimeoutStats
com.sun.cmm.statistics.CMM_RFC2788ApplicationTableStats
com.sun.cmm.statistics.CMM_ServiceStats
com.sun.cmm.statistics.CMM_SoftwareResourceStats
com.sun.cmm.statistics.CMM_SolarisEthernetPortStats
com.sun.cmm.statistics.CMM_SolarisNetworkPortStats
com.sun.cmm.statistics.CMM_SolarisOperatingSystemStats
com.sun.cmm.statistics.CMM_SolarisProcessorStats
com.sun.cmm.statistics.CMM_SolarisProcessorSysinfoStats
com.sun.cmm.statistics.CMM_SolarisProcessorVmStats
com.sun.cmm.statistics.CMM_Statistic
com.sun.cmm.statistics.CMM_SWRBufferStats
com.sun.cmm.statistics.CMM_SWRCacheStats
com.sun.cmm.statistics.CMM_SWRLimitStats
com.sun.cmm.statistics.CMM_SWRQueueStats
com.sun.cmm.statistics.CMM_UnixOperatingSystemStats
com.sun.cmm.statistics.CMM_UnixProcessStats
com.sun.cmm.statistics.CMM_VirtualServerWebModuleStats
com.sun.cmm.statistics.CMM_WebModuleStats

次のコマンドは、前の例で見つかったクラス com.sun.cmm.statistics.CMM_SWRQueueStats のオブジェクトを監視するしきい値監視ジョブについて、監視可能属性を示します。

$ mfwkadm thrsh-job observable-attributes \\
class=com.sun.cmm.statistics.CMM_SWRQueueStats

Threshold jobs observable attributes:
====================================

Class: com.sun.cmm.statistics.CMM_SWRQueueStats

Attributes: 

BufferSize [LONG]
EntriesCount [LONG]
EntriesHighWaterMark [LONG]
EntriesLowWaterMark [LONG]
EntriesTotal [LONG]
ErrorCount [INTEGER]
FailedOperations [LONG]
LowerLimit [LONG]
OperationsCount [LONG]
OtherLowerLimit [LONG]
OtherUpperLimit [LONG]
OverflowsCount [LONG]
QueuedCount [LONG]
QueuedHighWater [LONG]
SampleInterval [LONG]
TotalQueuedCount [LONG]
UpperLimit [LONG]

次のコマンドは、ジョブ作成のもう 1 つの例です。ここではしきい値監視ジョブを作成します。

$ mfwkadm thrsh-job create myThreshJob granularity=30 \\
object=/wsPrefix/com.sun.cmm.ws:name=process-1-threadPool-NativePool-stats,\\
type=CMM_SWRQueueStats attributeName=EntriesCount attributeType=LONG \\
thresholdValue=1000 thresholdOffset=10 thresholdDirection=RISING

次の例は、前の例で作成したしきい値監視ジョブに対する thrsh-job info サブコマンドの出力を示します。

$ mfwkadm thrsh-job info myThreshJob

Threshold job information for: myThreshJob
-----------------------------

Type:                SIMPLE
State:               ACTIVE_ON_DUTY
Granularity period:  30
Schedule:           
        Global start time: Immediately
        Global stop time: Forever
        Weekly schedule: Everyday
        Daily schedule: All day
Alarm configuration:
                Type: QualityOfServiceAlarm
                Severity: INDETERMINATE
Threshold definition(s):
                Object: /wsPrefix/com.sun.cmm.ws:name=process-1-threadPool-
NativePool-stats,type=CMM_SWRQueueStats
                        Attribute: EntriesCount [LONG]
                        Value: 1000
                        Direction: RISING
                        Offset: 10

終了ステータス

次の終了値が返されます。

0

正常終了

1

エラーが発生した。

属性

関連項目

cacao.5、cacaoadm.1m