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

目次

EventApp サービス

EventApp サービスについて

createUserAction

deleteEventsBeforeATimeStamp

deleteEventsBetweenTimestamps

getEventCountAfterATimestamp

getEventsAfterATimestamp

getEventsBeforeATimestamp

getEventsBetweenEventIds

getEventsBetweenTimestamps

getEventsBetweenTimestampsByEventClass

getEventsBetweenTimestampsByEventClass

getEventsBetweenTimestampsWithPerceivedSeverity

getEventsForEventType

getEventsForEventTypeByEventClass

getEventsForFeature

getEventsForFeatureByEventClass

getEventsForPerceivedSeverity

getEventsForPerceivedSeverityByEventClass

getLastEvent

getUserActions

modifyEventStatus

EventApp サービス

この章では、DCNM Web サービスの、EventApp サービスに対応する API メソッドについて説明します。

EventApp サービスについて

EventApp サービスは、データベース内の永続的なイベントを取得するさまざまなメソッドを提供します。

createUserAction

イベントのリストで行われる userActions を保持します。

パラメータ

opContext:動作コンテキスト

annotatedEvents:イベントのリストで行われる userActions のリスト

戻り値

void

deleteEventsBeforeATimeStamp

指定された Timestamp オブジェクトよりも前のタイムスタンプを持つイベントを削除します。

パラメータ

opContext:動作コンテキスト

timestamp:タイムスタンプを指定します。

戻り値

void

deleteEventsBetweenTimestamps

2 つの timeInstance(startTime と endTime)間のタイムスタンプを持つイベントを削除します。

パラメータ

opContext:動作コンテキスト

startTime:開始タイムスタンプ

endTime:終了タイムスタンプ

戻り値

void

getEventCountAfterATimestamp

指定された Timestamp オブジェクトよりも後のタイムスタンプを持つイベントの数を戻します。

指定されたタイムスタンプよりも後のイベントがデータベースにない場合、0 を戻します。

パラメータ

opContext:動作コンテキスト

timestamp:タイムスタンプを指定します。

戻り値

指定されたタイムスタンプよりも後のタイムスタンプを持つイベントの数

getEventsAfterATimestamp

指定された Timestamp オブジェクトよりも後のタイムスタンプを持つイベントのリストを戻します。

指定されたタイムスタンプよりも後のイベントがデータベースにない場合、空のリストを戻します。

パラメータ

opContext:動作コンテキスト

timestamp:タイムスタンプを指定します。

eventCount:データベースから取得するイベントの数を指定します。

戻り値

指定されたタイムスタンプよりも後のタイムスタンプを持つイベントのリスト

getEventsBeforeATimestamp

指定された Timestamp オブジェクトよりも前のタイムスタンプを持つイベントのリストを戻します。

指定されたタイムスタンプよりも前のイベントがデータベースにない場合、空のリストを戻します。

パラメータ

opContext:動作コンテキスト

timestamp:タイムスタンプを指定します。

eventCount:データベースから取得するイベントの数を指定します。

戻り値

指定されたタイムスタンプよりも前のタイムスタンプを持つイベントのリスト

getEventsBetweenEventIds

特定の 2 つの eventId 間の eventId を持つイベントのリストを戻します。startId が endId よりも大きい場合、IllegalArgumentException がスローされます。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

startId

endId

戻り値

特定の start および endId 間の eventId を持つイベントのリスト。

指定された startId がヌルの場合、endId よりも小さい eventId を持つイベントを戻します。

指定された endId がヌルの場合、startID よりも大きい eventId を持つイベントを戻します。

指定された startId および endId がヌルの場合、保持されたイベントをすべて戻します。

getEventsBetweenTimestamps

2 つの timeInstance(startTime と endTime)の間のタイムスタンプを持つイベントのリストを戻します。

パラメータ

opContext:動作コンテキスト

startTime:開始タイムスタンプ

endTime:終了タイムスタンプ

戻り値

2 つの timeInstance(startTime と endTime)の間のタイムスタンプを持つイベントのリスト

指定された startTime がヌルの場合、endTime よりも前のタイムスタンプを持つイベントを戻します。

指定された endTime がヌルの場合、startTime よりも後のタイムスタンプを持つイベントを戻します。

指定された startTime および endTime がヌルの場合、保持されたイベントをすべて戻します。

getEventsBetweenTimestampsByEventClass

指定された filterType を持つ 2 つの timeInstance(startTime と endTime)間のタイムスタンプを持つイベントのリストを戻します。

パラメータ

opContext:動作コンテキスト

startTime:開始タイムスタンプ

endTime:終了タイムスタンプ

filterType:データベースから取得するイベントのタイプを指定します。

次の filterType(定数)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

2 つの timeInstance(startTime と endTime)の間のタイムスタンプと対応する filterType を持つイベントのリスト

指定された startTime がヌルの場合、endTime よりも前のタイムスタンプを持つイベントを戻します。

指定された endTime がヌルの場合、startTime よりも後のタイムスタンプを持つイベントを戻します。

指定された startTime および endTime がヌルの場合、データベース内の保持されたイベントをすべて戻します。

getEventsBetweenTimestampsByEventClass

指定された filterType を持つ 2 つの timeInstance(startTime と endTime)間のタイムスタンプを持つイベントのリストを戻します。このメソッドは、Cisco NX-OS Release 4.0 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

startTime:開始タイムスタンプ

endTime:終了タイムスタンプ

filterType:データベースから取得するイベントのタイプを指定します。

次の filterType(定数)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

2 つの timeInstance(startTime と endTime)の間のタイムスタンプと対応する filterType を持つイベントのリスト

指定された startTime がヌルの場合、endTime よりも前のタイムスタンプを持つイベントを戻します。

指定された endTime がヌルの場合、startTime よりも後のタイムスタンプを持つイベントを戻します。

指定された startTime および endTime がヌルの場合、データベース内の保持されたイベントをすべて戻します。

getEventsBetweenTimestampsWithPerceivedSeverity

指定された perceivedSeverity を持つ 2 つの timeInstance(startTime と endTime)間のタイムスタンプを持つイベントのリストを戻します。このメソッドは、Cisco NX-OS Release 4.0 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

startTime:開始タイムスタンプ

endTime:終了タイムスタンプ

perceivedSeverity:PerceivedSeverity を指定。

戻り値

指定された perceivedSeverity を持つ 2 つの timeInstance(startTime と endTime)の間のタイムスタンプを持つイベントのリスト。

指定された startTime がヌルの場合、endTime よりも前のタイムスタンプを持つイベントを戻します。

指定された endTime がヌルの場合、startTime よりも後のタイムスタンプを持つイベントを戻します。

指定された startTime および endTime がヌルの場合、データベース内の保持されたイベントをすべて戻します。

getEventsForEventType

指定された EventType を持つイベントのリストを戻します。

パラメータ

opContext:動作コンテキスト

eventType:EventType を指定します。

戻り値

リストは指定された eventType と filterType に対応するイベントのリストを戻します。

getEventsForEventTypeByEventClass

指定された EventType と filterType を持つイベントのリストを戻します。

パラメータ

opContext:動作コンテキスト

eventType:EventType を指定します。

filterType:データベースから取得するイベントのタイプを指定します。

次の filterType(定数)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

リストは指定された eventType と filterType に対応するイベントのリストを戻します。

getEventsForFeature

指定された FeatureType を持つイベントのリストを戻します。

パラメータ

opContext:動作コンテキスト

featureType:FeatureType を指定します。

戻り値

指定された featureType を持つ保持されたイベントのリスト

getEventsForFeatureByEventClass

指定された FeatureType と filterType を持つイベントのリストを戻します。

パラメータ

opContext:動作コンテキスト

featureType:FeatureType を指定します。

filterType:データベースから取得するイベントのタイプを指定します。

次の filterType(定数)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

指定された featureType と filterType を持つ保持されたイベントのリスト

getEventsForPerceivedSeverity

指定された PerceivedSeverity を持つイベントのリストを戻します。

パラメータ

opContext:動作コンテキスト

perceivedSeverity:PerceivedSeverity を指定。

戻り値

指定された perceivedSeverity を持つ保持されたイベントのリスト

getEventsForPerceivedSeverityByEventClass

指定された PerceivedSeverity と filterType を持つイベントのリストを戻します。

パラメータ

opContext:動作コンテキスト

perceivedSeverity:PerceivedSeverity を指定。

filterType:データベースから取得するイベントのタイプを指定します。

次の filterType(定数)を指定できます。

DcmNormalizedEvent

DcmThresholdEvent

DcmInformationalEvent

UnsupportedEvent

すべてのタイプのイベント

戻り値

指定された PerceivedSeverity と filterType を持つ保持されたイベントのリスト

getLastEvent

データベースに最後に保持されたイベントを戻します。

パラメータ

opContext:動作コンテキスト

戻り値

データベースに最後に保持されたイベント

getUserActions

指定された eventId を持つ AnnotatedEvents のリストを戻します。

パラメータ

opContext:動作コンテキスト

eventId:保持された EventId

戻り値

eventId を持つ AnnotatedEvents のリストを戻します。

modifyEventStatus

イベントのリストのデータベース内の EventStatus を更新します。

パラメータ

opContext:動作コンテキスト

eventIds:eventIds のリストが含まれます。

eventStatusList:修正された EventStatus のリストが含まれます。

戻り値

void