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

目次

DeviceListApp サービス

DeviceListApp サービスについて

addNetworkElements

bindNetworkElementsToGroup

createNetworkElementGroup

deleteAllNetworkElementGroups

deleteAllNetworkElements

deleteNetworkElementGroups

deleteNetworkElements

discover

discoverNetworkElements

getAllDiscoveryTasks

getAllNetworkElementGroups

getAllNetworkElements

getDiscoveryStatus

getIpAddressOfDiscoveringDevices

getNetworkElementGroups

incrementalDiscovery

modifyNetworkElementGroups

performDisovery

performIncrementalDiscovery

performNetworkElementsDiscovery

performNetworkElementsRediscovery

performNetworkElementsUnmanaged

rediscoverNetworkElements

unbindNetworkElementsToGroup

unmanageNetworkElements

DeviceListApp サービス

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

DeviceListApp サービスについて

DeviceListApp デバイス リストには、DCNM が管理するデバイスのリストが含まれています。この機能により、新しいデバイスをリストに追加したり、デバイスをリストから削除したりできます。デバイスの論理グループである NetworkElementGroup により、グループを作成したり、デバイスをグループに追加したり、グループをユーザに割り当てたりできます。DCNM ユーザは、管理者としてユーザに割り当てられているデバイスだけを管理できます。各ユーザは、ユーザが管理するデバイスにログインするための資格情報を指定できます。ユーザは、デバイス グループおよび個別のデバイスにデフォルトの資格情報を指定できます。デバイスに指定された資格情報はグループ資格情報を上書きし、グループに指定された資格情報はユーザのデフォルトの資格情報を上書きします。

addNetworkElements

新しいデバイスのリストをデバイス リストに追加します。指定された IP アドレスを持つデバイスがデバイス内にすでに存在する場合、このメソッドは AppException をスローします。

パラメータ

opContext:動作コンテキスト

neCol:デバイス リストに追加するデバイスに対応する識別子のリスト。

戻り値

AbstractNetworkElement およびその AbstractNetworkElementStatus のリスト

bindNetworkElementsToGroup

指定されたデバイス グループから指定されたデバイスを追加します。

パラメータ

opContext:動作コンテキスト

neGroupInstanceNameId:デバイス グループの InstanceNameId

neInstanceNameIdCol:デバイス グループに追加するデバイスの InstanceNameId のリスト

戻り値

void

createNetworkElementGroup

指定された名前で NetworkElementGroup を作成し、指定されたデバイスをグループに追加します。

パラメータ

opContext:動作コンテキスト

neGroupName:デバイス グループの名前

neInstanceNameIdCol:デバイス グループに追加するデバイスの InstanceNameId

戻り値

NetworkElementGroup

deleteAllNetworkElementGroups

すべてのデバイス グループを削除します。

パラメータ

opContext:動作コンテキスト

戻り値

void

deleteAllNetworkElements

DCNM で管理されているすべてのデバイスを削除します。デバイスおよびそれらに関連する管理情報が削除されます。

パラメータ

opContext:動作コンテキスト

戻り値

void

deleteNetworkElementGroups

指定されたデバイス グループを削除します。

パラメータ

opContext:動作コンテキスト

neGroupInstanceNameIdCol:削除するデバイス グループ名のリスト

戻り値

void

deleteNetworkElements

指定されたデバイスをデバイス リストから削除します。指定されたデバイスはすべてのグループから削除されます。AbstractNetworkElement およびそれに関連する情報は DB から削除されます。TODO デバイスに関連する統計情報とイベントをどうするか。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:デバイス リストから削除するデバイスに対応する InstanceNameId のリスト。

戻り値

void

discover

IP アドレスに基づいてネットワークを検出する検出 API

パラメータ

opContext:動作コンテキスト

seed:シード デバイスの IP アドレス

cred:ネットワークを検出するために使用する資格情報

hops:検出に使用するホップの数

incremental:増分検出であるかどうかを示すブール

戻り値

対応する検出タスクの DiscoveryTaskStatus

discoverNetworkElements

指定されたデバイスの設定とステータスの情報を検出するタスクを開始します。検出の開始時に、デバイスのステータスが DISCOVERY に設定されます。検出が正常に実行されると、ステータスは MANAGED に設定されます。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:検出されるデバイスに対応する InstanceNameId のリスト

戻り値

検出タスクを識別するタスク ID

getAllDiscoveryTasks

検出タスクのリストのステータスを戻す API

パラメータ

opContext:動作コンテキスト

戻り値

すべての検出タスクの DiscoveryTaskStatus のリスト

getAllNetworkElementGroups

グループに属する AbstractNetworkElement を持つすべてのデバイス グループを戻します。AbstractNetworkElement の AbstractNetworkElementStatus は初期化されます。

パラメータ

opContext:動作コンテキスト

戻り値

NetworkElementGroup のリスト

getAllNetworkElements

デバイス リストで使用可能なすべてのネットワーク要素を戻します。

パラメータ

opContext:動作コンテキスト

戻り値

AbstractNetworkElement およびその AbstractNetworkElementStatus のリスト

getDiscoveryStatus

検出ステータスを取得します。

パラメータ

opContext:動作コンテキスト

戻り値

検出ステータスのリスト

getIpAddressOfDiscoveringDevices

現在検出されたタスクに含まれているすべての IP アドレスを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

戻り値

IP アドレスのリスト。

getNetworkElementGroups

グループに属する AbstractNetworkElement を持つ、指定したデバイス グループを戻します。AbstractNetworkElement の AbstractNetworkElementStatus は初期化されます。

パラメータ

opContext:動作コンテキスト

戻り値

NetworkElementGroup のリスト

incrementalDiscovery

増分検出を実行します。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:検出されるデバイスに対応する InstanceNameId のリスト

userCredentials:userName/password/enableUserName/enablePassword

戻り値

検出タスクを識別するタスク ID

modifyNetworkElementGroups

デバイス グループのリストのデバイス メンバーシップを変更します。

パラメータ

opContext:動作コンテキスト

neGroupCol:NetworkElementGroup のリスト

戻り値

void

performDisovery

IP アドレスに基づいてネットワークを検出する検出 API

パラメータ

opContext:動作コンテキスト

seed:シード デバイスの IP アドレス

cred:ネットワークを検出するために使用する資格情報

hops:検出に使用するホップの数

incremental:増分検出であるかどうかを示すブール

戻り値

対応する検出タスクの DiscoveryTaskStatus

performIncrementalDiscovery

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:検出されるデバイスに対応する InstanceNameId のリスト

userCredentials:userName/password/enableUserName/enablePassword

戻り値

検出タスクを識別するタスク ID

performNetworkElementsDiscovery

指定されたデバイスの設定とステータスの情報を検出するタスクを開始します。検出の開始時に、デバイスのステータスが DISCOVERY に設定されます。検出が正常に実行されると、ステータスは MANAGED に設定されます。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:検出されるデバイスに対応する InstanceNameId のリスト

戻り値

検出タスクを識別するタスク ID

performNetworkElementsRediscovery

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:

userCredentials:

戻り値

performNetworkElementsUnmanaged

指定されたデバイスに関連する情報を削除します。デバイス ステータスは UNMANAGED とマーキングされます。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:管理を解除するデバイスに対応する InstanceNameId のリスト。

戻り値

void

rediscoverNetworkElements

ネットワーク要素を再検出します。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:

userCredentials:

戻り値

unbindNetworkElementsToGroup

指定されたデバイスを指定されたデバイス グループから削除します。

パラメータ

opContext:動作コンテキスト

neGroupInstanceNameId:デバイス グループの InstanceNameId

neInstanceNameIdCol:デバイス グループに追加するデバイスの InstanceNameId のリスト

戻り値

void

unmanageNetworkElements

指定されたデバイスに関連する情報を削除します。デバイス ステータスは UNMANAGED とマーキングされます。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:管理を解除するデバイスに対応する InstanceNameId のリスト。

戻り値

void