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

目次

VdcApp サービス

VdcApp サービスについて

bindPortsToVdcs

bindVdcsWithResourceTemplate

createResourceTemplates

createVdcs

createVdcsWithResourceTemplate

deleteResourceTemplates

deleteVdcs

getAllVpcIds

getAllVpcsForTopology

getVpcCapabilityOfNetworkElements

getAllVdcsWithChassis

getResourceTemplatesInNetworkElement

getVdcs

getVdcsInChassis

getVdcsInChassises

modifyResourceTemplates

modifyVdcs

unbindVdcsWithResourceTemplate

validateVdcCreation

VdcApp サービス

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

VdcApp サービスについて

Virtual Device Context(VDC; 仮想デバイス コンテキスト)と呼ばれる複数の仮想デバイスと見なされるように物理デバイスを設定できます。レイヤ 2、レイヤ 3、またはポート チャネル デバイスのインターフェイスは、1 つの VDC だけに割り当てることができます。VDC では、相互接続されているインターフェイスでプロトコルを実行することによって互いに対話します。各 VDC では、物理デバイスのすべての機能を実行します。API カテゴリは次のとおりです。

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

Modify API:既存の VDC およびリソース テンプレートを変更します。

Delete API:VDC またはデバイス内のリソース テンプレートを削除します。

bindPortsToVdcs

ポートのリストを指定された VirtualNetworkElement にバインドします。

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

networkInterfaceInstanceNameIdCol がヌルまたは空か、タイプ InstanceNameId ではない場合。

vdcInstanceNameId がヌルまたは空か、タイプ InstanceNameId ではない場合。

既存の VirtualNetworkElement および NetworkInterface(データベース内に存在)だけを変更できる場合。

パラメータ

opContext:動作コンテキスト

vdcInstanceNameId:対応する NetworkInterface オブジェクトを設定する必要がある VDC の InstanceNameId。

networkInterfaceInstanceNameIdCol:指定した VDC に設定される NetworkInterface の InstanceNameId のリスト。

戻り値

データベースで保持されている変更された NetworkInterface オブジェクトのリスト。

bindVdcsWithResourceTemplate

指定された ResourceTemplate から VdcResourceLimit を作成し、指定された VDC とバインドします。

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

vdcInstanceNameIdCol がヌルまたは空か、タイプ InstanceNameId ではない場合。

resourceTemplateId がヌルまたは空か、タイプ InstanceNameId ではない場合。

既存の VirtualNetworkElement(データベース内に存在)だけを変更できます。

パラメータ

opContext:動作コンテキスト

resourceTemplateId:VDC とともに設定する resourceTemplate の InstanceNameId。

vdcInstanceNameIdCol:指定したリソース テンプレートとともに適用される VDC の InstanceNameId のリスト。

戻り値

指定したリソース制限付きで保持されるリスト。戻されるコレクションには次のアソシエーションだけが含まれ、これ以外のアソシエーションはクリアされています。

VirtualNetworkElement に対応する VdcResourceLimit

VirtualNetworkElement に対応する VirtualNetworkElementStatus

VirtualNetworkElement で保持される NetworkInterface

VirtualNetworkElement で保持される AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

createResourceTemplates

指定されたデバイスにリソース テンプレートを作成します。

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

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

resourceTemplateCol がヌルまたは空か、タイプ ResourceTemplate ではない場合。

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

neInstanceNameId がデフォルト VDC の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:デフォルト VirtualNetworkElement の InstanceNameId

resourceTemplateCol:新規 ResourceTemplate オブジェクトのリスト。

戻り値

データベースで保持されている ResourceTemplates の InstanceNameId のリスト。

createVdcs

指定されたデバイスに VDC を作成します。

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

neInstanceNameId がデフォルト VDC の InstanceNameId ではない場合。

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

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

neInstanceNameId が有効な VirtualNetworkElement InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:デフォルト VirtualNetworkElement の InstanceNameId

vdcCol:作成する VirtualNetworkElement のリスト

戻り値

データベースで保持されることになる VirtualNetworkElement のコレクション。戻されるコレクションは次のアソシエーションを持ち、これ以外のアソシエーションはクリアされます。

VirtualNetworkElement に対応する VdcResourceLimit

VirtualNetworkElement に対応する VirtualNetworkElementStatus

VirtualNetworkElement で保持される NetworkInterface

VirtualNetworkElement で保持される AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

createVdcsWithResourceTemplate

リソース制限付きで VDC を作成します。ResourceTemplate の InstanceNameId を指定すると、VDC および対応する VdcResourceLimit を作成します。

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

resourceTemplateId がヌルか、タイプ InstanceNameId ではない場合。

resourceLimit の作成に使用できるのは、既存の ResourceTemplate(データベースに存在)だけの場合。

vdcCol がヌルまたは空か、タイプ InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

resourceTemplateId:VDC とともに設定する resourceTemplate の InstanceNameId。

vdcCol:作成する VirtualNetworkElement のリスト。

戻り値

データベースで保持されている VDC の InstanceNameId のリスト。

deleteResourceTemplates

デバイスに設定されている 1 つまたは複数のリソース テンプレートを削除します。

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

resourceTemplateCol がヌルまたは空か、タイプ InstanceNameId ではない場合。

既存の ResourceTemplate(データベース内に存在)だけを変更できる場合。

パラメータ

opContext:動作コンテキスト

resourceTemplateCol:削除する ResourceTemplate の InstanceNameId。

戻り値

void

deleteVdcs

デバイスから 1 つまたは複数の VDC を削除します。

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

vdcInstanceNameIdCol がヌルまたは空か、タイプ InstanceNameId ではない場合。

既存の VirtualNetworkElement(データベース内に存在)だけを削除できる場合。

パラメータ

opContext:動作コンテキスト

vdcInstanceNameIdCol:削除する VirtualNetworkElement の InstanceNameId のリスト。

戻り値

void

getAllVpcIds

ネットワーク内のすべての vPC ID を戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

戻り値

ネットワーク内の vPC ID のリスト。

getAllVpcsForTopology

ネットワーク内のすべての vPC を戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

戻り値

ネットワーク内のすべての vPC。戻されるリストには、vPC インスタンスのリストが含まれています。

getVpcCapabilityOfNetworkElements

ネットワーク要素のリストに含まれているハードウェア検査に基づいて、vPC がイネーブルかディセーブルかを示す vPC サービスの状態および vPC 機能の機能情報を戻します。ネットワーク要素のインスタンス名 ID のリストを指定すると、ブール値のペアを含むリストを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:AAA 状態が必要な 1 つまたは複数のネットワーク要素の InstanceNameId

戻り値

戻されたリストには、ブール インスタンスのペアが含まれます。

最初のブール値が TRUE であれば、すべてのカードでハードウェア検査の結果が正常でした。

最初のブール値が FALSE であれば、いずれかのカードでハードウェア検査の結果が正常ではありませんでした。

2 番めのブール値が TRUE であれば、指定されたネットワーク要素で vPC はイネーブルです。

2 番めのブール値が FALSE であれば、指定されたネットワーク要素で vPC はディセーブルです。

getAllVdcsWithChassis

指定されたシャーシのリストに対応する仮想ネットワーク要素のリストを取得します。

パラメータ

opContext:動作コンテキスト

InstanceNameId:シャーシ ID のリスト

戻り値

VirtualNetworkElement のリスト

getResourceTemplatesInNetworkElement

シャーシに設定されている ResourceTemplate を戻します。デフォルト VDC の instanceNameId を指定します。この API は、デバイスに設定されているリソース テンプレートのコレクションを戻します。

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

neInstanceNameId がデフォルト VDC の InstanceNameId ではない場合。

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

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

neInstanceNameId が有効な VirtualNetworkElement neInstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:デフォルト VirtualNetworkElement の InstanceNameId

戻り値

デフォルト VDC に設定されている ResourceTemplate のリスト。戻されるコレクションは次のアソシエーションを含んでおり、これ以外のアソシエーションはクリアされています。

ResourceTemplate に対応する TemplateResourceLimit

ResourceTemplate に対応する VirtualNetworkElement

TemplateResourceLimit で保持される ResourceTemplate

getVdcs

instanceNameId に対応する VDC を戻します。

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

vdcInstanceNameIdCol がヌルまたは空か、タイプ InstanceNameId ではない場合。

vdcInstanceNameIdCol が AbstractNetworkElement オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

vdcInstanceNameIdCol:VirtualNetworkElement の InstanceNameId

戻り値

VirtualNetworkElement のリスト。戻されるコレクションは次のアソシエーションを持ち、これ以外のアソシエーションはクリアされます。

VirtualNetworkElement に対応する VdcResourceLimit

VirtualNetworkElement に対応する VirtualNetworkElementStatus

VirtualNetworkElement で保持される NetworkInterface

VirtualNetworkElement で保持される AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

getVdcsInChassis

指定されたシャーシの VirtualNetworkElement のコレクションを戻します。

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

chassisId がヌルか、タイプ InstanceNameId ではない場合。

chassisId が有効な Chassis InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:シャーシの InstanceNameId。

戻り値

VirtualNetworkElement のリスト。戻されるコレクションは次のアソシエーションを持ち、これ以外のアソシエーションはクリアされます。

VirtualNetworkElement に対応する VdcResourceLimit

VirtualNetworkElement に対応する VirtualNetworkElementStatus

VirtualNetworkElement で保持される NetworkInterface

VirtualNetworkElement で保持される AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

getVdcsInChassises

指定されたシャーシの VirtualNetworkElement のコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

chassisId がヌルか、タイプ InstanceNameId ではない場合。

chassisId が有効な Chassis InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:シャーシの InstanceNameId。

戻り値

VirtualNetworkElement のリスト。戻されるコレクションは次のアソシエーションを持ち、これ以外のアソシエーションはクリアされます。

VirtualNetworkElement に対応する VdcResourceLimit

VirtualNetworkElement に対応する VirtualNetworkElementStatus

VirtualNetworkElement で保持される NetworkInterface

VirtualNetworkElement で保持される AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

modifyResourceTemplates

デバイスに設定されているリソース テンプレートを変更します。

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

resourceTemplateCol がヌルまたは空か、タイプ ResourceTemplate ではない場合。

既存の ResourceTemplate(データベース内に存在)だけを変更できます。

パラメータ

opContext:動作コンテキスト

resourceTemplateCol:変更済み ResourceTemplate オブジェクトのリスト。

戻り値

void

modifyVdcs

リストされている設定済み VDC を変更します。

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

vneCol がヌルまたは空か、タイプ InstanceNameId ではない場合。

既存の VirtualNetworkElement(データベース内に存在)だけを変更できます。

パラメータ

opContext:動作コンテキスト

vneCol:変更済み VirtualNetworkElement オブジェクトのリスト

戻り値

void

unbindVdcsWithResourceTemplate

指定された VdcResourceLimit を VirtualNetworkElement から削除します。

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

vneId がヌルまたは空か、タイプ InstanceNameId ではない場合。

vdcResourceId がヌルまたは空か、タイプ InstanceNameId ではない場合。

既存の VdcResourceLimit(データベース内に存在)だけを削除できます。

パラメータ

opContext:動作コンテキスト

vdcResourceId:VDC とともに設定する VdcResourceLimit の InstanceNameId。

vneId:対応する VdcResourceLimit を削除する必要のある VDC の InstanceNameId。

戻り値

void

validateVdcCreation

ネットワーク要素に VDC をさらに作成できるかどうかを確認します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

neInstanceNameIdCol がヌル、または空の場合。

neInstanceNameIdCol に無効なネットワーク要素 InstanceNameId、またはヌル値が含まれている場合。

neInstanceNameIdCol に特定の InstanceNameId を持つ、同等のネットワーク要素オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のコレクション。

戻り値

ネットワーク要素の InstanceNameId に対応するデバイスに対して VDC をさらに作成できるのであれば、ヌルに設定されている文字列のリスト。

ネットワーク要素の InstanceNameId に対応するデバイスに対して VDC をこれ以上作成できないのであれば、デバイスから送信されたエラー メッセージが設定されている文字列のリスト。