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

目次

ObjectTrackingApp サービス

ObjectTrackingApp サービスについて

createTrackedObjectsInNetworkElements

deleteTrackedObjects

getTrackedClients

getTrackedObjects

getTrackedObjectsInNetworkElement

modifyTrackedObjects

ObjectTrackingApp サービス

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

ObjectTrackingApp サービスについて

オブジェクト トラッキングを使用すると、HSRP または Gateway Local Balancing Protocol(GLBP)などのクライアント プロセスにより使用されるインターフェイスまたは IP ルートの状態をトラッキングできます。GLBP などのクライアント プロセスでは、オブジェクトのトラッキングへの関心を登録して、トラッキングされているオブジェクトがその状態を変更したときに通知を要求できます。この機能は、ルーティング システムのアベイラビリティを高め、復旧のスピードを早めるとともに、停止回数および停止期間を削減します。API カテゴリは次のとおりです。

Query/Get API:永続的なデータベースのデータを照会します。

Modify API:既存のネットワーク インターフェイス トラッキングおよびルート トラッキング設定を変更します。

Delete API:デバイスのトラッキング インスタンスを削除します。

createTrackedObjectsInNetworkElements

指定ネットワーク要素のリスト オブジェクト トラッキング設定を作成します。

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

objectTrackingCol がヌルまたは空の場合、またはタイプ ObjectTrackingSetting ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:AbstractNetworkElement の InstanceNameId

objectTrackingCol:ObjectTrackingSetting オブジェクトのリスト

戻り値

ObjectTrackingSetting の InstanceNameIds のリスト

deleteTrackedObjects

ObjectTrackingSetting の特定の instanceNameIds の場合、1 つまたは複数のオブジェクト トラッキング設定を削除します。

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

trackingObjInstanceNameIdsCol がヌルの場合、またはタイプ InstanceNameId ではない場合。

trackingObjInstanceNameIdsCol が有効なオブジェクト トラッキング InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

trackingObjInstanceNameIdsCol:1 つまたは複数の ObjectTrackingSetting の InstanceNameIds

戻り値

void

getTrackedClients

指定 trackingId を処理する GlbpGroupSetting Objects のリストを戻します。

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

trackingId がヌルの場合、またはタイプ InstanceNameId ではない場合。

trackingId が有効なオブジェクト トラッキング InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

trackingId:ObjectTrackingSetting の InstanceNameId

戻り値

GlbpGroupSetting オブジェクトのコレクション。戻されるオブジェクトには、対応する IpNetworkInterface リファレンスが含まれます。ただし、IpNetworkInterface に他のアソシエーションがある場合、NetworkInterfaceName を除くこれらのアソシエーションはクリアされます。

getTrackedObjects

1 つまたは複数の ObjectTrackingSetting 設定を戻します。1 つまたは複数の ObjectTrackingSetting の InstanceNameId を指定すると、対応するオブジェクト トラッキング設定を戻します。

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

trackingInstanceNameIdCol がヌルの場合、またはタイプ InstanceNameId ではない場合。

trackingInstanceNameIdCol が有効なオブジェクト トラッキング InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

trackingInstanceNameIdCol:1 つまたは複数の ObjectTrackingSetting の InstanceNameId

戻り値

ObjectTrackingSetting のリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

ObjectTrackingSetting の AbstractNetworkElement

NetworkInterfaceTrackingSetting の NetworkInterface アソシエーション

RouteTrackingSetting の Vrf アソシエーション

ObjectTrackingSetting の ObjectTrackingStatus アソシエーション

getTrackedObjectsInNetworkElement

指定ネットワーク要素で設定された ObjectTrackingSetting のコレクションを戻します。

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

neInstanceNameIdCol がヌルの場合、またはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が有効なオブジェクト トラッキング InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:1 つまたは複数の AbstractNetworkElement の InstanceNameId

戻り値

ObjectTrackingSetting のコレクション。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

ObjectTrackingSetting の AbstractNetworkElement

NetworkInterfaceTrackingSetting の NetworkInterface アソシエーション

RouteTrackingSetting の Vrf アソシエーション

ObjectTrackingSetting の ObjectTrackingStatus アソシエーション

modifyTrackedObjects

1 つまたは複数の既存のトラッキングされるオブジェクトを変更します。

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

trackedObjCol がヌルまたは空の場合、またはタイプ ObjectTrackingSetting ではない場合。

既存のオブジェクト トラッキング設定(データベース内に存在する)だけを変更できます。

パラメータ

opContext:動作コンテキスト

trackedObjCol:変更された ObjectTrackingSetting オブジェクトのリスト

戻り値

データベースで保持されている変更された ObjectTrackingSetting のリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

ObjectTrackingSetting の AbstractNetworkElement

NetworkInterfaceTrackingSetting の NetworkInterface アソシエーション

RouteTrackingSetting の Vrf アソシエーション

ObjectTrackingSetting の ObjectTrackingStatus アソシエーション