- はじめに
- 概要
- AaaApp サービス
- AclApp サービス
- ClusterApp サービス
- CollectorApp サービス
- CollectorExtendedApp サービス
- ConfigTemplateApp サービス
- ConfigArchiveApp サービス
- ConfigDeliveryApp サービス
- DaiApp サービス
- DataPurgingApp サービス
- DeviceGroupApp サービス
- DeviceListApp サービス
- DhcpSnoopingApp サービス
- Dot1xApp サービス
- EtherChannelApp サービス
- EventApp サービス
- FabricPathResourcesApp サービス
- FabricPathTopologyApp サービス
- FcApp サービス
- FcoeApp サービス
- FeatureSetApp サービス
- FexApp サービス
- FipSnoopingApp サービス
- GlbpApp サービス
- HsrpApp サービス
- IgmpSnoopingApp サービス
- ImageInstallApp サービス
- InterfacesApp サービス
- InventoryApp サービス
- IpSourceGuardApp サービス
- KeyChainApp サービス
- Interface L2IsisApp サービス
- LicensingApp サービス
- LogApp サービス
- LstApp サービス
- NacLpIpApp サービス
- ObjectGroupApp サービス
- ObjectTrackingApp サービス
- PollerApp サービス
- PortProfileApp サービス
- PortSecurityApp サービス
- RbacApp サービス
- RepositoryApp サービス
- SecurityApp サービス
- ServerAdminApp サービス
- ServerApp サービス
- SoftwareApp サービス
- SpanApp サービス
- StpApp サービス
- SvsConnectionApp サービス
- SvsDomainApp サービス
- ThresholdActionApp サービス
- TrafficStormControlApp サービス
- TunnelApp サービス
- UserApp サービス
- VdcApp サービス
- VlanApp サービス
- VpcApp サービス
- VrfApp サービス
Cisco DCNM Web サービス API ガイド リリース 5.1(1a)
偏向のない言語
この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
翻訳について
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
- Updated:
- 2017年8月2日
章のタイトル： 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 を作成します。
統計データの既存のコレクションを削除には、次の手順を実行します。
addStatisticalEntry
特定の統計エントリを既存のコレクション情報に関連付けます。特定の統計エントリは、コレクション情報内で複製できません。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
CollectorException は、次のいずれかの状況が発生した場合にスローされます。
• aStatisticalEntry が特定のコレクション情報にすでに存在している場合。
• aStatisticalEntry に、特定のコレクション情報とは異なるデバイスに属する configInstanceId がある場合。
collectionInfoId：特定の統計エントリを関連付けなければならない CollectionInfo のインスタンス名 ID
aStatisticalEntry：CollectionInfo StatisticalEntry に追加する必要がある StatisticalEntry のインスタンス
createCollector
コレクション情報を作成し、そのインスタンス名 ID を戻します。
特定のコレクション情報オブジェクトには、1 つまたは複数の統計エントリ、スケジュール、およびコレクタ アクションがある必要があります。コレクタは指定されたスケジュールに従ってポーリングを開始します。開始時間がスケジュールで指定されていない場合、コレクタはすぐにポーリングを開始します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
CollectorException は、次のいずれかの状況が発生した場合にスローされます。
• aCollectionInfo で名前が指定されていない場合。
• aCollectionInfo でコレクタ アクションが指定されていない場合。
• aCollectionInfo でスケジュールが指定されていない場合。
• aCollectionInfo で統計エントリが空の場合。
• aCollectionInfo で統計エントリが複製される場合。
– 統計クラス名がヌルか、configInstanceId がヌルまたは無効の場合。
– すべての configInstanceId が同じデバイスに属していない場合。
– 統計クラスと configInstanceId に関連がない場合。
deleteCollectionInfo
既存のコレクション情報、および特定のコレクション情報のために収集された統計データを削除します。
特定のコレクション情報に関して動作中の場合、コレクタを停止します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
IntegrityException は、デバイスに特定の collectionInfo が存在しない場合にスローされます。
deleteCollectionInfoCol
特定のコレクション情報 ID リストのために収集されたコレクション情報およびその統計データを削除します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
コレクタを停止します（特定のコレクション情報 ID リストに関して動作中の場合）。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
リスト内の collectionInfo がいずれも存在しない場合は、AppException がスローされます。
deleteStatisticalDataCol
特定のコレクション情報 ID リストのために収集された統計データを削除します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
リスト内の collectionInfo がいずれも存在しない場合は、AppException がスローされます。
deleteStatisticalData
特定のコレクション情報のために収集された統計データを削除します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
IntegrityException は、デバイスに特定の collectionInfo が存在しない場合にスローされます。
deleteStatisticalDataTillDate
特定のコレクション情報のために収集された統計データを削除します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
IntegrityException は、デバイスに特定の collectionInfo が存在しない場合にスローされます。
fetchCollectedData
既存のコレクション情報の最後にポーリングされた統計データを、次回ポーリング時間などの追加情報とともに戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
collectionInfoId：CollectionInfo のインスタンス名 ID。
最後にポーリングされる統計データである ExtendedCollectedData のインスタンスを戻します。この機能は、リアルタイム モニタリングに役立ちます。
getAllCollectionInfo
特定の statisticalClassName、configInstanceId、および間隔と一致するすべての既存のコレクション情報を戻します。指定されていない場合、すべての CollectionInfo を戻します。
getAllCollectionInfoByConfigIds
特定の statisticalClassName、configInstanceIds、および間隔と完全に一致するすべてのアクティブなコレクション情報を戻します。指定されていない場合、ヌルを戻します。
getAllCollectionInfoByStatus
特定の収集ステータスを持つすべての既存のコレクション情報を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
getAllCollectionInfoByUserId
ユーザによって作成されたすべての既存のコレクション情報を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
getAllCollectionInfoInDevice
ネットワーク要素にバインドされたすべての既存のコレクション情報を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
getAllCollectionInfoInDeviceByStatus
ネットワーク要素にバインドされ特定の収集ステータスを持つすべての既存のコレクション情報を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
aCollectionStatus：CollectionInfo のステータス
getAllStatisticalEntriesForDevice
ネットワーク要素にバインドされたすべての統計エントリを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
getCollectedData（非推奨）
既存のコレクション情報の最後にポーリングされた統計データを、次回ポーリング時間などの追加情報とともに戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
collectionInfoId：CollectionInfo のインスタンス ID
最後にポーリングされる統計データである ExtendedCollectedData のインスタンスを戻します。この機能は、リアルタイム モニタリングに役立ちます。
getCollectedStatisticalData
既存のコレクション情報の収集済み統計データをすべて戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
collectionInfoId：CollectionInfo のインスタンス ID
指定された collectionInfoId についてポーリングされたすべての統計データである CollectedData のコレクションを戻します。
getCollectionInfo
コレクション情報名 ID によって指定されたコレクション情報のインスタンスを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
getLatestCollectedStatisticalData
既存のコレクション情報の最後にポーリングされた統計データを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
collectionInfoId：CollectionInfo のインスタンス ID
最後にポーリングされる統計データである CollectedData のインスタンスを戻します。この機能は、リアルタイム モニタリングに役立ちます。
getValidConfigInstanceId
特定の設定インスタンス名 ID の有効な設定インスタンス名 ID を戻します。
インスタンス名 ID は次に示すケースによって異なります。1.再検出 2.タイプの変更（例： インターフェイスでのポート モードの変更）3.デバイスから除去されたデータ 4. ID は API によって変更されます（例：ACE は、ACL が API を通してアップデートされるときに再生成されます）。有効なインスタンス名 ID は、特定の古いインスタンス名 ID のデータベースからリロードすることによって戻されます。ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• configInstanceIdCol コレクションにヌルの要素が含まれているか、収集が空であるか、または収集がタイプ InstanceNameId ではない場合。
• 渡された引数がヌルであるか、または引数が有効な InstanceNameId ではない場合。
modifyCollectorAction
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
modifySchedule
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
removeStatisticalEntry
既存のコレクション情報から StatisticalEntry を削除します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
• statisticalEntryId が有効な統計エントリ InstanceNameId ではない場合。
CollectorException は、次のいずれかの状況が発生した場合にスローされます。
• 特定のコレクション情報に statisticalEntryId が存在しない場合。
• 特定のコレクション情報に統計エントリが 1 つしかない場合。
collectionInfoId：CollectionInfo のインスタンス名 ID
statisticalEntryId：CollectionInfo StatisticalEntry に追加する必要がある StatisticalEntry のインスタンス名
startCollector
スケジュールに従って、既存のコレクション情報のポーリングを開始します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
startCollectors
スケジュールに従って、既存のコレクション情報のポーリングを開始します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
AppException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
startCollectorBySchedule
指定されたスケジュールに従って、既存のコレクション情報のポーリングを開始します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
stopCollector
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
stopCollectors
既存のコレクション情報のポーリングを停止します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
AppException は、次のいずれかの状況が発生した場合にスローされます。
• collectionInfoId が有効なコレクション情報 InstanceNameId ではない場合。
フィードバック