Cisco DCNM Web サービス API ガイド リリース 5.1(1a)
ThresholdActionApp サービス
ThresholdActionApp サービス
発行日;2012/02/02 | 英語版ドキュメント(2011/07/18 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

ThresholdActionApp サービス

ThresholdActionApp サービスについて

createThresholdRuleBindings

createThresholdRules

deleteThresholdRuleBindings

deleteThresholdRules

getAllThresholdRules

getThresholdRuleBindingIds

getThresholdRuleBindings

modifyThresholdRules

ThresholdActionApp サービス

この章では、DCNM Web サービスの、ThresholdActionApp サービスに対応する API メソッドについて説明します。この API は、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

ThresholdActionApp サービスについて

DCNM を使用すると、収集された統計データに対してしきい値ルールを適用できます。DCNM では、ルール定義に基づいて一連のアクションを実行します。ユーザは、テンプレートとしてしきい値ルールを定義し、このしきい値ルール テンプレートを既存の収集された統計データに適用することができます。

上昇しきい値は、サンプリングされた変数の上限で、下限しきい値は下限です。サンプリングされた変数の現在値が指定されたしきい値以上の場合に、DCNM で一連のアクションを実行できます。サンプリングされた同じ変数に対して指定できる上昇しきい値および下限しきい値はそれぞれ 1 つだけです。しきい値ルールには、一連のプロパティ(しきい値設定)および一連のアクション(しきい値アクション)が含まれています。

しきい値設定の主なプロパティを次に示します。

Name:しきい値設定を識別する、わかりやすい名前。

Frequency:アクションがトリガーされるまでに、サンプリングされた変数がしきい値と交差する必要のある回数。このプロパティを使用すると、イベントの発生頻度が高すぎる場合にアクションの実行回数を抑えることができます。

Period:サンプリングされた変数の頻度をモニタする時間間隔。

Repeat:アクションをトリガーした後でタイマーを再設定しない時間間隔(間隔)。

Trend:上昇しきい値または下限しきい値。

主なしきい値アクションを次に示します。

電子メールまたは SMS の送信。

DCNM サーバでのスクリプトの実行。

現在の DCNM イベント チャネルに対するイベントの送信。

createThresholdRuleBindings

しきい値ルールが関連付けられた、しきい値ルール バインディングを作成します。

ParameterException は、次のいずれかの状況が発生した場合にスローされます。

aThresholdRuleBindings、aThresholdRuleIds、および aStatisticalEntryIds のコレクション サイズが等しくない場合。

パラメータ

opContext:動作コンテキスト

aThresholdRuleBindings:しきい値ルール バインディング。

aThresholdRuleIds:指定されたしきい値ルール バインディングに関連付けられているしきい値ルール。

aStatisticalEntryIds:ThresholdRuleBinding に関連する StatisticalEntry。

戻り値

しきい値ルール バインディングのリスト。

createThresholdRules

しきい値ルールを作成します。各 ThresholdRule は ThresholdSetting を 2 つまで含む必要があります(上昇しきい値用の 1 つおよび/または下限しきい値用に 1 つ)。各 ThresholdSetting は ThresholdAction を含む必要があります。

FeatureException は、次のいずれかの状況が発生した場合にスローされます。

aCollectionInfo がヌルの場合。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

上昇または下限のしきい値設定頻度が 0 の場合。

上昇または下限のしきい値設定期間が 60 未満の場合。

しきい値ルールに上昇と下限のいずれのしきい値設定も含まれていない場合。

上昇または下限のしきい値設定にしきい値アクションが 1 つも含まれていない場合。

パラメータ

opContext:動作コンテキスト。

aThresholdRules:しきい値ルールのリスト。

戻り値

しきい値ルールのインスタンス名のリスト。

deleteThresholdRuleBindings

しきい値ルール バインディングを削除します。

パラメータ

opContext:動作コンテキスト

aThresholdRuleBindingIds:削除するしきい値ルール バインディング インスタンス名のリスト。

戻り値

void

deleteThresholdRules

しきい値ルール インスタンス名で指定されたしきい値ルールを削除します。関連付けられているしきい値設定およびしきい値アクションは削除されます。

FeatureException は、次のいずれかの状況が発生した場合にスローされます。

* ThresholdRule に ThresholdRuleBinding が含まれている場合。

IntegrityException は、デバイスに特定の collectionInfo が存在しない場合にスローされます。

パラメータ

opContext:動作コンテキスト

aThresholdRuleIds:しきい値ルール インスタンス名。

戻り値

void

getAllThresholdRules

アプリケーションに存在しているすべてのしきい値ルールを戻します。

パラメータ

opContext:動作コンテキスト

戻り値

アプリケーション内のすべてのしきい値ルール。

getThresholdRuleBindingIds

指定されたしきい値ルール インスタンス名に関連付けられているすべてのしきい値ルール バインディング インスタンス名を戻します。

パラメータ

opContext:動作コンテキスト。

ThresholdRuleIds:しきい値ルール インスタンス名のリスト。

戻り値

しきい値ルール バインディング インスタンス名のリスト。

getThresholdRuleBindings

しきい値ルール バインディング インスタンス名に対応するしきい値ルール バインディングを戻します。

パラメータ

opContext:動作コンテキスト

aThresholdRuleBindingIds:しきい値ルール バインディング インスタンス名。

戻り値

しきい値ルール バインディングのリスト。

modifyThresholdRules

しきい値ルールを変更します。

ParameterException は、次のいずれかの状況が発生した場合にスローされます。

上昇または下限のしきい値設定頻度が 0 の場合。

上昇または下限のしきい値設定期間が 60 未満の場合。

しきい値ルールに上昇と下限のいずれのしきい値設定も含まれていない場合。

上昇または下限のしきい値設定にしきい値アクションが 1 つも含まれていない場合。

パラメータ

opContext:動作コンテキスト

aThresholdRules:変更するしきい値ルールのリスト。

戻り値

void