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

目次

CollectorApp サービス

CollectorApp サービスについて

addStatisticalEntry

createCollector

deleteCollectionInfo

deleteCollectionInfoCol

deleteStatisticalDataCol

deleteStatisticalData

deleteStatisticalDataTillDate

fetchCollectedData

getAllCollectionInfo

getAllCollectionInfoByConfigIds

getAllCollectionInfoByStatus

getAllCollectionInfoByUserId

getAllCollectionInfoInDevice

getAllCollectionInfoInDeviceByStatus

getAllStatisticalEntriesForDevice

getCollectedData(非推奨)

getCollectedStatisticalData

getCollectionInfo

getLatestCollectedStatisticalData

getValidConfigInstanceId

modifyCollectorAction

modifySchedule

removeStatisticalEntry

startCollector

startCollectors

startCollectorBySchedule

stopCollector

stopCollectors

CollectorApp サービス

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

CollectorApp サービスについて

コレクタを使用すると、ネットワーク リソースのパフォーマンス管理に対処できます。コレクタで統計データを分析することにより、トラフィック スループット、使用率、エラー率、および応答時間を含む、データのリアルタイム モニタリングを実行できます。その結果、ネットワーク リソースを効率的に使用し、ネットワークの健全性に関する詳細な知識を得ることができます。

コレクタは、デバイスから統計情報を読み取り、データベースに格納できます。コレクタ API を使用し、データベースに保存されている情報を取得できます。

統計データのコレクションを行うには、次の手順を実行します。

1. コレクション情報名、統計データのリスト、スケジュール(simple または cron スタイル)、およびコレクション アクション(persist)を指定することによって、CollectionInfo を作成します。

2. コレクション情報のスケジューリングを開始します。

統計データの既存のコレクションを削除には、次の手順を実行します。

1. CollectionInfo を停止します(開始されている場合)。

2. コレクション情報を削除します。

addStatisticalEntry

特定の統計エントリを既存のコレクション情報に関連付けます。特定の統計エントリは、コレクション情報内で複製できません。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

aStatisticalEntry がヌルの場合。

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

aStatisticalEntry が特定のコレクション情報にすでに存在している場合。

aStatisticalEntry に、特定のコレクション情報とは異なるデバイスに属する configInstanceId がある場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:特定の統計エントリを関連付けなければならない CollectionInfo のインスタンス名 ID

aStatisticalEntry:CollectionInfo StatisticalEntry に追加する必要がある StatisticalEntry のインスタンス

戻り値

InstanceNameId(StatisticalEntry のインスタンス名 ID)

createCollector

コレクション情報を作成し、そのインスタンス名 ID を戻します。

特定のコレクション情報オブジェクトには、1 つまたは複数の統計エントリ、スケジュール、およびコレクタ アクションがある必要があります。コレクタは指定されたスケジュールに従ってポーリングを開始します。開始時間がスケジュールで指定されていない場合、コレクタはすぐにポーリングを開始します。

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

aCollectionInfo がヌルの場合。

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

aCollectionInfo で名前が指定されていない場合。

aCollectionInfo でコレクタ アクションが指定されていない場合。

aCollectionInfo でスケジュールが指定されていない場合。

aCollectionInfo で統計エントリが空の場合。

aCollectionInfo で統計エントリが複製される場合。

特定の統計エントリの場合

統計クラス名がヌルか、configInstanceId がヌルまたは無効の場合。

すべての configInstanceId が同じデバイスに属していない場合。

統計クラスと configInstanceId に関連がない場合。

特定のスケジュールの場合。

表現が Cron スケジュールで無効の場合。

指定された終了時間が開始時間よりも前に終了する場合。

指定された間隔が 30 秒未満の場合。

パラメータ

opContext:動作コンテキスト

aCollectionInfo:CollectionInfo のインスタンス

戻り値

InstanceNameId:CollectionInfo のインスタンス名 ID

deleteCollectionInfo

既存のコレクション情報、および特定のコレクション情報のために収集された統計データを削除します。

特定のコレクション情報に関して動作中の場合、コレクタを停止します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

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

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID。

戻り値

void

deleteCollectionInfoCol

特定のコレクション情報 ID リストのために収集されたコレクション情報およびその統計データを削除します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

コレクタを停止します(特定のコレクション情報 ID リストに関して動作中の場合)。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

リスト内の collectionInfo がいずれも存在しない場合は、AppException がスローされます。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID。

戻り値

void

deleteStatisticalDataCol

特定のコレクション情報 ID リストのために収集された統計データを削除します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

リスト内の collectionInfo がいずれも存在しない場合は、AppException がスローされます。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID。

戻り値

void

deleteStatisticalData

特定のコレクション情報のために収集された統計データを削除します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

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

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID。

戻り値

void

deleteStatisticalDataTillDate

特定のコレクション情報のために収集された統計データを削除します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

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

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID。

戻り値

void

fetchCollectedData

既存のコレクション情報の最後にポーリングされた統計データを、次回ポーリング時間などの追加情報とともに戻します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

collectionInfoId:CollectionInfo のインスタンス名 ID。

戻り値

最後にポーリングされる統計データである ExtendedCollectedData のインスタンスを戻します。この機能は、リアルタイム モニタリングに役立ちます。

getAllCollectionInfo

特定の statisticalClassName、configInstanceId、および間隔と一致するすべての既存のコレクション情報を戻します。指定されていない場合、すべての CollectionInfo を戻します。

パラメータ

opContext:動作コンテキスト

statisticalClassName:統計情報クラス名

configInstanceId:設定インスタンスの InstanceNameId

interval:ポーリング間隔

戻り値

特定のパラメータと一致するすべての CollectionInfo

getAllCollectionInfoByConfigIds

特定の statisticalClassName、configInstanceIds、および間隔と完全に一致するすべてのアクティブなコレクション情報を戻します。指定されていない場合、ヌルを戻します。

パラメータ

opContext:動作コンテキスト

statisticalClassName:統計情報クラス名

configInstanceIds:設定インスタンスの InstanceNameId のリスト

interval:ポーリング間隔

戻り値

特定のパラメータと一致する唯一の CollectionInfo

getAllCollectionInfoByStatus

特定の収集ステータスを持つすべての既存のコレクション情報を戻します。

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

aCollectionStatus がヌルの場合。

パラメータ

opContext:動作コンテキスト

aCollectionStatus:CollectionInfo のステータス

戻り値

指定された CollectionStatus を持つすべての既存の CollectionInfo。

getAllCollectionInfoByUserId

ユーザによって作成されたすべての既存のコレクション情報を戻します。

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

userId がヌルの場合。

パラメータ

opContext:動作コンテキスト

username:CollectionInfo を作成したユーザの名前。

戻り値

指定された username によって作成されたすべての CollectionInfo。

getAllCollectionInfoInDevice

ネットワーク要素にバインドされたすべての既存のコレクション情報を戻します。

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

neInstanceNameId がヌルの場合。

neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

networkElementId:ネットワーク要素のインスタンス ID。

戻り値

指定された CollectionStatus を持つすべての CollectionInfo。

getAllCollectionInfoInDeviceByStatus

ネットワーク要素にバインドされ特定の収集ステータスを持つすべての既存のコレクション情報を戻します。

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

neInstanceNameId がヌルの場合。

neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。

aCollectionStatus がヌルの場合。

パラメータ

opContext:動作コンテキスト

aCollectionStatus:CollectionInfo のステータス

deviceId:CollectionInfo のインスタンス ID

戻り値

指定された CollectionStatus を持つすべての CollectionInfo。

getAllStatisticalEntriesForDevice

ネットワーク要素にバインドされたすべての統計エントリを戻します。

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

neInstanceNameId がヌルの場合。

neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

networkElementId:CollectionInfo のインスタンス ID

戻り値

指定された deviceID でポーリングされたすべての統計エントリ。

getCollectedData(非推奨)

既存のコレクション情報の最後にポーリングされた統計データを、次回ポーリング時間などの追加情報とともに戻します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

戻り値

最後にポーリングされる統計データである ExtendedCollectedData のインスタンスを戻します。この機能は、リアルタイム モニタリングに役立ちます。

getCollectedStatisticalData

非推奨。

既存のコレクション情報の収集済み統計データをすべて戻します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

戻り値

指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションを戻します。

getCollectionInfo

コレクション情報名 ID によって指定されたコレクション情報のインスタンスを戻します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス名 ID

戻り値

CollectionInfo CollectionInfo

getLatestCollectedStatisticalData

既存のコレクション情報の最後にポーリングされた統計データを戻します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

戻り値

最後にポーリングされる統計データである CollectedData のインスタンスを戻します。この機能は、リアルタイム モニタリングに役立ちます。

getValidConfigInstanceId

特定の設定インスタンス名 ID の有効な設定インスタンス名 ID を戻します。

インスタンス名 ID は次に示すケースによって異なります。1.再検出 2.タイプの変更(例: インターフェイスでのポート モードの変更)3.デバイスから除去されたデータ 4. ID は API によって変更されます(例:ACE は、ACL が API を通してアップデートされるときに再生成されます)。有効なインスタンス名 ID は、特定の古いインスタンス名 ID のデータベースからリロードすることによって戻されます。ValidationException は、次のいずれかの状況が発生した場合にスローされます。

configInstanceIdCol コレクションにヌルの要素が含まれているか、収集が空であるか、または収集がタイプ InstanceNameId ではない場合。

渡された引数がヌルであるか、または引数が有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

configInstanceIdCol:1 つまたは複数の設定エンティティの InstanceNameId。

戻り値

戻されたリストには、有効な InstanceNameId が含まれます。

modifyCollectorAction

既存のコレクション情報のコレクタ アクションを変更します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

aCollectorAction がヌルの場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID。

戻り値

void

modifySchedule

既存のコレクション情報のスケジュールを変更します。

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

collectionInfoId がヌルの場合。

aSchedule がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

特定のスケジュールの場合。

表現が Cron スケジュールで無効の場合。

指定された終了時間が開始時間よりも前に終了する場合。

指定された間隔が 30 秒未満の場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス ID

aSchedule:新しいジョブのスケジュール

戻り値

void

removeStatisticalEntry

既存のコレクション情報から StatisticalEntry を削除します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

statisticalEntryId がヌルの場合。

statisticalEntryId が有効な統計エントリ InstanceNameId ではない場合。

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

特定のコレクション情報に statisticalEntryId が存在しない場合。

特定のコレクション情報に統計エントリが 1 つしかない場合。

パラメータ

opContext:動作コンテキスト

collectionInfoId:CollectionInfo のインスタンス名 ID

statisticalEntryId:CollectionInfo StatisticalEntry に追加する必要がある StatisticalEntry のインスタンス名

戻り値

void

startCollector

スケジュールに従って、既存のコレクション情報のポーリングを開始します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

aCollectorAction がヌルの場合。

パラメータ

collectionInfoId:collectionInfo のインスタンス ID

戻り値

void

startCollectors

スケジュールに従って、既存のコレクション情報のポーリングを開始します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

aCollectorAction がヌルの場合。

パラメータ

collectionInfoId:collectionInfo のインスタンス ID

戻り値

void

startCollectorBySchedule

指定されたスケジュールに従って、既存のコレクション情報のポーリングを開始します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

schedule がヌルの場合。

特定のスケジュールの場合。

表現が Cron スケジュールで無効の場合。

指定された終了時間が開始時間よりも前に終了する場合。

指定された間隔が 30 秒未満の場合。

パラメータ

collectionInfoId:collectionInfo のインスタンス ID

戻り値

void

stopCollector

既存のコレクション情報のポーリングを停止します。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

schedule がヌルの場合。

パラメータ

collectionInfoId:collectionInfo のインスタンス ID

戻り値

void

stopCollectors

既存のコレクション情報のポーリングを停止します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

collectionInfoId がヌルの場合。

collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。

schedule がヌルの場合。

パラメータ

collectionInfoId:collectionInfo のインスタンス ID

戻り値

void