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

目次

SvsDomainApp サービス

SvsDomainApp サービスについて

bindSvsDomainSettingToVlan

deleteSvsDomainSettingInNetworkElements

fetchCurrentSvsNeighborsInNetworkElements

getSvsDomainSettingInNetworkElements

getSvsNeighborsInNetworkElements

getSystemVlansInNetworkElements

modifySvsDomainSettings

unbindVlanFromSvsDomainSetting

SvsDomainApp サービス

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

SvsDomainApp サービスについて

SvsDomainApp サービスは、VSM でドメイン設定を設定するために役立ちます。Virtual Supervisor Module(VSM)および Virtual Ethernet Module(VEM)は、レイヤ 2 ドメイン内で分離されています。VSM と VEM のペアが同じレイヤ 2 ドメインで通信できるためには、各ペアが一意な識別子を持つ必要があります。

SVS ドメイン設定は、次のアトリビュートを含んでいます。

Domain ID:VSM に割り当てられる 1 ~ 4095 の範囲の一意な ID。この ID があるため、VEM は、不参加 VSM からのコマンドに決して応答しません。VSM と VEM の間の各パケットは、適切なドメイン ID でタグ付けされています。

Control Vlan:VSM と VEM の間のすべての制御トラフィックは、設定されている制御 VLAN 経由で伝送されます。

Packet Vlan:VSM と VEM の間のすべてのデータ トラフィックは、設定されているパケット VLAN 経由で伝送されます。

Svs Mode:接続のモードを表し、可能な値は Layer2 または Layer3 です。モードが Layer3 の場合は、制御インターフェイスの管理を設定する必要があります。

bindSvsDomainSettingToVlan

指定された SvsCtrlModeType の VLAN に SvsDomainSetting を関連付けます。

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

domainSettingInstanceNameId がヌルの場合。

domainSettingInstanceNameId が有効な InstanceNameId ではない場合。

vlanInstanceNameIdis がヌルか、無効な VLAN の InstanceNameId の場合。

systemVlanType がヌルの場合。

パラメータ

opContext:動作コンテキスト。

domainSettingInstanceNameId:SvsDomainSetting オブジェクトの InstanceNameId。

vlanId:VLAN オブジェクトの整数値。

systemVlanType:「CONTROL」または「PACKET」のいずれかを systemVlanType として使用可能。

戻り値

新規作成された SystemVlanForSvsDomain オブジェクトのリスト

deleteSvsDomainSettingInNetworkElements

ネットワークの SVS ドメイン設定を削除します。

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

neIds がヌルか、AbstractNetworkElement の InstanceNameId ではない場合。

次の状況が発生した場合、IntegrityException がスローされます。

neId に対応するオブジェクトが存在しない場合。

パラメータ

neInstanceNameId:VRF を問い合わせるネットワーク要素のインスタンス名 ID。

afi:ルートを問い合わせる AddressFamily。afi に指定できるのは「IPV4」または「IPV6」です。

戻り値

void

fetchCurrentSvsNeighborsInNetworkElements

デバイスに要求を送信することにより、ネットワーク要素に対応する SVS ネイバー情報を戻します。

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

neIds がヌルか、AbstractNetworkElement の InstanceNameId ではない場合。

次の状況が発生した場合、IntegrityException がスローされます。

neId に対応するオブジェクトが存在しない場合。

パラメータ

neInstanceNameId:VRF を問い合わせるネットワーク要素のインスタンス名 ID。

afi:ルートを問い合わせる AddressFamily。afi に指定できるのは「IPV4」または「IPV6」です。

戻り値

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

getSvsDomainSettingInNetworkElements

ネットワーク要素に対応する SVS ドメイン情報を戻します。

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

neIds がヌルか、AbstractNetworkElement の InstanceNameId ではない場合。

次の状況が発生した場合、IntegrityException がスローされます。

neId に対応するオブジェクトが存在しない場合。

パラメータ

neInstanceNameId:VRF を問い合わせるネットワーク要素のインスタンス名 ID。

afi:ルートを問い合わせる AddressFamily。afi に指定できるのは「IPV4」または「IPV6」です。

destinationPrefix:ルートを問い合わせる宛先。

戻り値

UnicastRoutes のリスト。

getSvsNeighborsInNetworkElements

ネットワーク要素に対応する SVS ネイバー情報を戻します。

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

neIds がヌルか、AbstractNetworkElement の InstanceNameId ではない場合。

次の状況が発生した場合、IntegrityException がスローされます。

neId に対応するオブジェクトが存在しない場合。

パラメータ

neInstanceNameId:VRF を問い合わせるネットワーク要素のインスタンス名 ID。

afi:ルートを問い合わせる AddressFamily。afi に指定できるのは「IPV4」または「IPV6」です。

ipNetworkInterfaceName:ルートを問い合わせる IpNetworkInterface。

戻り値

void

getSystemVlansInNetworkElements

指定されたネットワーク要素の SVS ドメイン設定に設定されているシステム VLAN を戻します。

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

neIds がヌルか、AbstractNetworkElement の InstanceNameId ではない場合。

次の状況が発生した場合、IntegrityException がスローされます。

neId に対応するオブジェクトが存在しない場合。

パラメータ

neInstanceNameId:VRF を問い合わせるネットワーク要素のインスタンス名 ID。

afi:ルートを問い合わせる AddressFamily。afi に指定できるのは「IPV4」または「IPV6」です。

nextHopAddress:ルートを問い合わせるネクストホップ アドレス。

戻り値

VLAN ID を含むペアのリスト。

ペアの第 1 要素は制御 VLAN ID を表し、第 2 要素は、ネットワーク要素の SvsDomainSetting に設定されているパケット VLAN ID を表します。SvsDomainSetting がネットワーク要素に設定されていない場合、リストには空のペアが含まれています。

modifySvsDomainSettings

SVS ドメイン設定オブジェクトのコレクションを変更します。

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

neIds がヌルか、AbstractNetworkElement の InstanceNameId ではない場合。

次の状況が発生した場合、IntegrityException がスローされます。

neId に対応するオブジェクトが存在しない場合。

パラメータ

neInstanceNameId:VRF を問い合わせるネットワーク要素のインスタンス名 ID。

afi:ルートを問い合わせる AddressFamily。afi に指定できるのは「IPV4」または「IPV6」です。

routeOrigin:ルートを問い合わせるルート オリジン。TBD:ルート オリジンは、列挙型 routeOriginType として IM に宣言されています({ direct, local,static,am, bgp,ospf,isis,rip,eigrp})。

戻り値

void

unbindVlanFromSvsDomainSetting

特定の SystemVlanType に対する SvsDomainSetting から VLAN アソシエーションをクリアし、デフォルト VLAN を指定された SystemVlanType にバインドします。

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

svsDomainSettingInstanceNameId がヌルか、SvsDomainSetting オブジェクトの有効な InstanceNameId ではない場合。

systemVlanType がヌルの場合。

パラメータ

vrfInstanceNameIdCol:URIB ステータスを問い合わせる VRF のインスタンス名 ID のリスト。

afi:ルートを問い合わせる AddressFamily。afi に指定できるのは「IPV4」または「IPV6」です。

戻り値

void