Cisco DCNM Web Services API ガイド Release 4.0
CollectorApp サービス
CollectorApp サービス
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

CollectorApp サービス

CollectorApp サービスの概要

addStatisticalEntry

createCollector

deleteCollectionInfo

deleteStatisticalData

deleteStatisticalDataTillDate

getAllCollectionInfo

getAllCollectionInfoByConfigIds

getAllCollectionInfoByStatus

getAllCollectionInfoByUserId

getAllCollectionInfoInDevice

getAllCollectionInfoInDeviceByStatus

getAllStatisticalEntriesForDevice

getCollectedData

getCollectedStatisticalData

getCollectionInfo

getLatestCollectedStatisticalData

getValidConfigInstanceId

modifyCollectorAction

modifySchedule

removeStatisticalEntry

startCollector

startCollectorBySchedule

stopCollector

CollectorApp サービス

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

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 でない場合

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

パラメータ

opContext ― 動作可能なコンテキスト

collectionInfoId ― CollectionInfo のインスタンス ID

戻り値

void

deleteStatisticalData

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

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

collectionInfoId がヌルの場合

collectionInfoId が有効な収集情報 InstanceNameId でない場合

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

パラメータ

opContext ― 動作可能なコンテキスト

collectionInfoId ― CollectionInfo のインスタンス ID

戻り値

void

deleteStatisticalDataTillDate

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

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

collectionInfoId がヌルの場合

collectionInfoId が有効な収集情報 InstanceNameId でない場合

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

パラメータ

opContext ― 動作可能なコンテキスト

collectionInfoId ― CollectionInfo のインスタンス ID

戻り値

void

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. 識別は API によって変更されます(たとえば、Access Control Entry [ACE; アクセス コントロール エントリ] は、Access Control List [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 ― 収集情報のインスタンス ID

戻り値

void

startCollectorBySchedule

与えられたスケジュールに従って、既存の収集情報のポーリングを開始します。

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

collectionInfoId がヌルの場合

collectionInfoId が有効な収集情報 InstanceNameId でない場合

schedule がヌルの場合

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

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

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

指定された間隔が 30 秒より短い場合

パラメータ

collectionInfoId ― 収集情報のインスタンス ID

戻り値

void

stopCollector

既存の収集情報のポーリングを停止します。

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

collectionInfoId がヌルの場合

collectionInfoId が有効な収集情報 InstanceNameId でない場合

schedule がヌルの場合

パラメータ

collectionInfoId ― 収集情報のインスタンス ID

戻り値

void