Cisco DCNM Web サービス API ガイド リリース 5.1(1a)

DeviceGroupApp サービス

---

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

DeviceGroupApp サービスについて

DeviceGroup により、デバイス一式をグループ化できます。特定のデバイス一式でデバイス グループを作成して、アクティブ化できます。デバイス グループをアクティブ化した後、設定パネルには、アクティブ グループに属するそれらのデバイスだけが表示されます。このインターフェイスでは、デバイス グループを作成、変更、アクティブ化、削除する必要のあるすべての API を定義します。

createGroups

1 つまたは複数の DeviceGroup オブジェクトを作成します。作成する DeviceGroups のリストを指定すると、この API はデータベースにオブジェクトを作成し、作成されたオブジェクトを戻します。

パラメータ

opContext：動作コンテキスト。

deviceGroupCol：DeviceGroup オブジェクトのリスト。

戻り値

サーバに作成された DeviceGroup オブジェクトのリスト。

deleteGroups

1 つまたは複数の DeviceGroup オブジェクトを削除します。DeviceGroup オブジェクトの InstanceNameId を指定すると、これらのオブジェクトは削除されます。

パラメータ

opContext：動作コンテキスト。

groupInstanceNameIdCol：削除する必要のある 1 つまたは複数の DeviceGroup オブジェクトの InstanceNameId が含まれているコレクション。

戻り値

void

getAbstractNetworkElementCol

このメソッドはデバイス グループに属する AbstractNetworkElements のリストを戻します。

パラメータ

opContext：動作コンテキスト。

groupInstanceNameId：DeviceGroup の InstanceNameId。

戻り値

特定の InstanceNameId を持つデバイス グループに対応する AbstractNetworkElement オブジェクトのリスト。

getAbstractNetworkElementsMatchingCriteria

指定された基準に一致する理論ネットワーク要素のリストを取得して戻します。

パラメータ

opContext：動作コンテキスト。

deviceCriteria：基準では platform、seeddevice、hopCount を指定できます。

戻り値

基準に一致する理論ネットワーク要素のリスト基準を戻します。

getAllGroups

ユーザが所有するサーバにあるすべてのグループを戻します。

パラメータ

opContext：動作コンテキスト。

戻り値

DeviceGroup オブジェクトのリスト。

getAneInstanceNameIdCol

このメソッドは、デバイス グループのリストに属する AbstractNetworkElements の InstanceNameIds のリストのリストを戻します。

パラメータ

opContext：動作コンテキスト。

groupInstanceNameIdList：DeviceGroup の InstanceNameId のリスト。

戻り値

InstanceNameId の特定のリストを持つデバイス グループのリストに対応する AbstractNetworkElements の InstanceNameId のリストのリスト。

getGroups

デバイス グループをその InstanceNameIds から戻します。DeviceGroups の InstanceNameId のコレクションを指定すると、対応する DeviceGroup オブジェクトを戻します。

パラメータ

opContext：動作コンテキスト。

groupInstanceNameIdCol：DeviceGroups の InstanceNameId のコレクション。

戻り値

特定の InstanceNameId のコレクションに対応する DeviceGroup オブジェクトのリスト。

modifyCurrentUserDeviceGroup

現在のユーザの DeviceGroup をアクティブ化します。

パラメータ

opContext：動作コンテキスト。

groupinstanceNameId：現在のユーザに関連付ける必要のある DeviceGroup の InstanceNameId。

戻り値

void

modifyGroups

1 つまたは複数の既存の DeviceGroup オブジェクトを変更します。

パラメータ

opContext：動作コンテキスト。

deviceGroupCol：データベース内にある既存の DeviceGroup オブジェクトに置き換わる DeviceGroup オブジェクトの（1 つまたは複数の）コレクション。

戻り値

void