Cisco DCNM Web Services API ガイド Release 4.0
VdcApp サービス
VdcApp サービス
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

VdcApp サービス

VdcApp サービスの概要

bindPortsToVdcs

bindVdcsWithResourceTemplate

createResourceTemplates

createVdcs

createVdcsWithResourceTemplate

deleteResourceTemplates

deleteVdcs

getAllVdcsWithChassis

getResourceTemplatesInNetworkElement

getVdcs

getVdcsInChassis

modifyResourceTemplates

modifyVdcs

unbindVdcsWithResourceTemplate

VdcApp サービス

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

VdcApp サービスの概要

Virtual Device Context(VDC; 仮想デバイス コンテキスト)と呼ばれる複数の仮想デバイスのように物理デバイスを設定できます。レイヤ 2、レイヤ 3、またはポート チャネル デバイス インターフェイスを唯一の 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

指定の ResourceTemplete からの VdcResourceLimit を作成し、指定の VDC にバインドします。

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

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

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

既存の VirtualNetworkElement(データベース内に存在)のみを修正できます。

パラメータ

opContext ― 動作可能なコンテキスト

resourceTemplateId ― VDC とともに設定されている resourceTemplate の InstanceNameId

vdcInstanceNameIdCol ― 指定のリソース テンプレートに適用される VDC の InstanceNameId のリスト

戻り値

指定のリソース制限により存続しているもののリスト。返される収集には、次のアソシエーションのみが含まれていて、それ以外はクリアされます。

VirtualNetworkElement に対応する VdcResourceLimit

VirtualNetworkElement に対応する VirtualNetworkElementStatus

VirtualNetwokrElement 内にある NetworkInterface

VirtualNetwokrElement 内にある AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

createResourceTemplates

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

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

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

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

neInstanceNameId ― デフォルト VirtualNetworkElement の InstanceNameId

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

戻り値

データベース内に存続する ResourceTemplates の InstanceNameIds のリスト

createVdcs

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

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

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

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

neInstanceNameId ― デフォルト VirtualNetworkElement の InstanceNameId

vdcCol ― 作成される VirtualNetworkElement のリスト

戻り値

データベース内に存続させようとしている VirtualNetworkElement の収集。返される収集には、次のアソシエーションのみが含まれていて、それ以外はクリアされます。

VirtualNetworkElement に対応する VdcResourceLimit

VirtualNetworkElement に対応する VirtualNetworkElementStatus

VirtualNetwokrElement 内にある NetworkInterface

VirtualNetwokrElement 内にある AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

createVdcsWithResourceTemplate

リソース制限と共に VDC を作成します。ResourceTemplate の InstanceNameId を指定すると、対応する VdcResourceLimit が VDC とともに作成されます。

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

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

resourceLimits を作成するために、既存の ResourceTemplates(データベース内に存在)のみを使用できます。

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

パラメータ

opContext ― 動作可能なコンテキスト

resourceTemplateId ― VDC とともに設定されている resourceTemplate の InstanceNameId

vdcCol ― 作成される VirtualNetworkElement のリスト

戻り値

データベース内に存続する VDC の InstanceNameIds のリスト

deleteResourceTemplates

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

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

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

既存の IpGResourceTemplates(データベース内に存在)のみを修正できます。

パラメータ

opContext ― 動作可能なコンテキスト

resourceTemplateCol ― 削除すべき ResourceTemplates の InstanceNameId

戻り値

void

deleteVdcs

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

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

vdcInstanceNameIdCol ― 削除される VirtualNetworkElement の InstanceNameId の リスト

戻り値

void

getAllVdcsWithChassis

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

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― シャーシ ID のリスト

戻り値

VirtualNetworkElement のリスト

getResourceTemplatesInNetworkElement

シャーシ内に設定されている ResourceTemplates を返します。デフォルト 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

VirtualNetwokrElement 内にある NetworkInterface

VirtualNetwokrElement 内にある AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

getVdcsInChassis

指定シャーシに対する VirtualNetworkElement の収集を返します。

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

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

chassisId が有効な シャーシ InstanceNameId ではない場合

パラメータ

opContext ― 動作可能なコンテキスト

neInstanceNameId ― シャーシの InstanceNameId

戻り値

VirtualNetworkElement のリスト。返された収集には、次のアソシエーションが含まれていて、それ以外はクリアされます。

VirtualNetworkElement に対応する VdcResourceLimit

VirtualNetworkElement に対応する VirtualNetworkElementStatus

VirtualNetwokrElement 内にある NetworkInterface

VirtualNetwokrElement 内にある AbstractNetworkElementStatus

VirtualNetworkElement に対応する SshServerSetting

modifyResourceTemplates

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

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

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

既存の ResourceTemplate(データベース内に存在)のみを修正できます。

パラメータ

opContext ― 動作可能なコンテキスト

resourceTemplateCol ― 修正済 ResourceTemplate オブジェクトのリスト

戻り値

void

modifyVdcs

設定された VDC のリストを修正します。

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

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

既存の VirtualNetworkElement(データベース内に存在)のみを修正できます。

パラメータ

opContext ― 動作可能なコンテキスト

vneCol ― 修正された VirtualNetworkElement オブジェクトのリスト

戻り値

void

unbindVdcsWithResourceTemplate

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

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

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

vdcResourceId ― VDC とともに設定されている VdcResourceLimit の InstanceNameId

vneId ― 対応する VdcResourceLimit を削除すべき VDC の InstanceNameId

戻り値

void