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

SvsConnectionApp サービス

---

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

SvsConnectionApp サービスについて

SvsConnectionApp サービスは VSM と vCenter の間の接続を確立するために役立ちます。各 VSM は自動生成された固有の XML 拡張ファイルを持ちます。

API カテゴリは次のとおりです。

• Query/Get API：永続的なデータベースからデータを照会します。

• Create API：新しい SVS CONNECTION を作成します。

• Modify API：既存の SVS CONNECTION を変更します。

• Delete API：既存の SVS CONNECTION を削除します。

createSvsConnectionInNetworkElements

指定されたネットワーク要素用の SvsConnection 設定を作成します。

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

• SvsConnectionSettingCol の値がヌルか SvsConnectionSetting がヌルの場合。

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

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

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

パラメータ

opContext：動作コンテキスト。

neIds：SVS 接続設定パラメータを作成するネットワーク要素の InstanceNameId。

svsConnectionSettingCol：設定するコレクション アトリビュートを含む SVS 接続設定コレクション。

戻り値

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

deleteSvsConnectionSettingInNetworkElements

ネットワーク要素の SvsConnection 設定を削除します。

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

• svsConnInstanceNameIds の要素が SvsConnectionSetting の有効な InstanceNameId ではない場合。

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

• neNameIds の InstanceNameId に対応する AbstractNetworkElement オブジェクトが存在しない場合。

パラメータ

opContext：動作コンテキスト。

svsConnInstanceNameIds：削除する必要のあるデバイスに設定されている SVS 接続の InstanceNameIds のリスト。

戻り値

void

disableSvsConnections

指定されたデバイス ID の SvsConnection をディセーブルにします。

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

• 渡された引数がヌルの場合。

• neIds コレクションが空か、コレクションに有効なネットワーク要素 InstanceNameId でないオブジェクトが含まれている場合。

パラメータ

opContext：動作コンテキスト。

svsConnInstanceNameIds：削除する必要のあるデバイスに設定されている SVS 接続の InstanceNameIds のリスト。

戻り値

void

enableSvsConnections

指定されたデバイス ID の SVS 接続をイネーブルにします。

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

• 渡された引数がヌルの場合。

• neIds コレクションが空か、コレクションに有効なネットワーク要素 InstanceNameId でないオブジェクトが含まれている場合。

パラメータ

opContext：動作コンテキスト。

neIds：ネットワーク要素に対応する InstanceNameId

戻り値

UnicastRoutes のリスト。

getSvsConnectionsInNetworkElements

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

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

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

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

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

パラメータ

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

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

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

戻り値

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

戻されたリストには、次のインスタンスのリストが含まれています。

• SVS 接続の動作ステータス同期ステータスを示している SvsConnectionStatusRef SvsConnectionStatus。

modifySvsConnections

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

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

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

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

• SvsConnectionSetting オブジェクト modifiedSvsConnectionSettingCol のいずれかのアトリビュートが有効でないか、プラットフォーム タイプでサポートされていないアトリビュートの場合。

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

• modifiedSvsConnectionSettingCol SvsConnectionSetting コレクションのオブジェクトに対応するオブジェクトが存在しない。

パラメータ

opContext：動作コンテキスト。

modifiedSvsConnectionSettingCol：変更済み SvsConnectionSetting オブジェクトのリスト。

戻り値

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

戻されたリストには、次のインスタンスのリストが含まれています。

• SVS 接続の動作ステータス同期ステータスを示している SvsConnectionStatusRef SvsConnectionStatus。