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

目次

FabricPathTopologyApp サービス

FabricPathTopologyApp サービスについて

bindInterfacesToFabricPathTopologySetting

createFabricPathTopologyInNetworkElements

createFpTopologyInNetworkElementsWithVlans

deleteFabricPathTopologySettings

getFabricPathNetworkInterfacesummaryObjects

getFabricPathTopologySettingForInterfaces

getFabricPathTopologySettingForTopoId

getFabricPathTopologySettingForVlanRange

getFabricPathTopologySettings

getFpTopologySettingInNetworkElements

getFptopologySettingWithInterfaceAssociation

getFabricPathNetworkInterfacesummaryObjects

getSniBelongsToTopologyStatuses

modifyFabricPathTopologySettings

modifySniBelongsToFpTopologySettings

unbindInterfaceFromFabricPathTopologySetting

FabricPathTopologyApp サービス

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

FabricPathTopologyApp サービスについて

Routing Topology Manager(RTM)により、FabricPath トポロジを作成、削除、および管理できます。特定のデバイスに複数の FabricPath トポロジを設定できます。各 FabricPathTopology は、1 つまたは複数の VLAN のマッピングを表します。デバイスのポートは複数のレイヤ 2 トポロジに関連付けることができます。VLAN が 1 つの場合は複数のレイヤ 2 トポロジに参加できません。

このインターフェイスでは、RTM 機能サービスの外観に公開されるすべての API を定義します。API は次のカテゴリで定義されます。

Query/Get API:永続的なデータベースからデータを照会するために使用されます。

Create API:新しい FabricPath トポロジを作成するために使用されます。

Modify API:既存の FabricPath トポロジの基本アトリビュートを変更するために使用されます。

Delete API:既存の FabricPath トポロジを削除するために使用されます。

bindInterfacesToFabricPathTopologySetting

同じデバイスに存在する 1 つまたは複数のインスタンスにインスタンスを関連付けます。

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

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

fpTopologySettingInstanceNameIdCol に無効な FabricPathTopologySetting InstanceNameId またはヌル値が含まれている場合。

fpTopologySettingInstanceNameIdCol に、特定の InstanceNameId を持つ同等の FabricPathTopologySetting オブジェクトがない場合。

niInstanceNameId が無効な NetworkInterface InstanceNameId またはヌル値の場合。

niInstanceNameId に、特定の InstanceNameId を持つ同等の NetworkInterface オブジェクトがない場合。

NetworkInterface インスタンスの InstanceNameId および fpTopologySettingInstanceNameIdCol にある任意の FabricPathTopologySetting インスタンスに対応する InstanceNameId が同じデバイスに属していない場合。

パラメータ

opContext:動作コンテキスト。

sniInstanceNameIds:複数のトポロジに関連付ける必要があるネットワーク インターフェイスの InstanceNameIds。

fpTopologySettingInstanceNameIdCol:インスタンスの InstanceNameId のリスト。

戻り値

FabricPathTopologySetting を持つ各 NetworkInterface に対応する、新しく作成された SniBelongsToTopologySetting インスタンスのリスト。

createFabricPathTopologyInNetworkElements

neInstanceNameIdCol にあるすべてのネットワーク要素にインスタンスを作成します。

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

FabricPathTopologySetting がデータベースにすでに存在する場合。

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

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

neInstanceNameIdCol に無効な NetworkElement InstanceNameId 値が含まれている場合。

neInstanceNameIdCol に、特定の InstanceNameId を持つ同等の NetworkElement オブジェクトがない場合。

topoName がヌルの場合。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のリスト。

topoName:作成される名前。

戻り値

FabricPathTopologySetting 名を topologyId として持つ各ネットワーク要素に対応する、新しく作成された FabricPathTopologySetting インスタンスのリスト。

createFpTopologyInNetworkElementsWithVlans

引数で渡された VLAN 範囲を持つ neInstanceNameIdCol にあるすべてのネットワーク要素にインスタンスを作成します。デバイスの topologySetting インスタンスがデータベースにある場合、このメソッドによって VLAN 範囲が変更され、トポロジ インスタンスのマッピングされている VLAN が渡された値に設定されます。オブジェクトがすでに存在する場合、nonUniqueElementCreation インスタンス例外はスローされません。

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

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

neInstanceNameIdCol に無効な NetworkElement InstanceNameId 値が含まれている場合。

neInstanceNameIdCol に、特定の InstanceNameId を持つ同等の NetworkElement オブジェクトがない場合。

topologyId がヌルの場合。

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

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

トポロジ ID が 0 に設定され、変更された VLAN 範囲のある FabricPathTopologySetting インスタンスが fpTopologySettingList に含まれている場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のリスト。

topoName:作成される名前。

戻り値

FabricPathTopologySetting 名を topologyId として持つ各ネットワーク要素に対応する、新しく作成された FabricPathTopologySetting インスタンスのリスト。

deleteFabricPathTopologySettings

FabricPathTopologySetting インスタンスを削除します。FabricPathTopologySetting インスタンスに対応する VLAN 範囲にあるすべての VLAN は、デフォルトの FabricPathTopologySetting インスタンスに割り当てられます。

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

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

fpTopologySettingInstanceNameIdCol のコレクションに、タイプ FabricPathTopologySetting の InstanceNameId ではない要素が含まれている場合。

fpTopologySettingInstanceNameIdCol のコレクションに、データベースに存在しない FabricPathTopologySetting が含まれている場合。

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

fpTopologySettingInstanceNameIdCol にトポロジ ID が 0 の FabricPathTopologySetting インスタンスが含まれている場合。

パラメータ

opContext:動作コンテキスト。

fpTopologySettingInstanceNameIdCol:削除されるインスタンスの InstanceNameId のリスト。

戻り値

void

getFabricPathNetworkInterfacesummaryObjects

次のアトリビュートが含まれる FabricPathNetworkInterfaceSummary オブジェクトが戻ります。

各 SNI に対応する SniBelongsToFpTopologySetting:ローカルおよびリモートのインターフェイスの SniBelongsToFpTopologyStatus からの sniBelongsToFpTopologyState。

ローカルおよびリモートのインターフェイスの NetworkInterfaceStatus からの NetworkInterfaceOperationStatus(該当する場合):ローカルおよびリモートのインターフェイスの L2IsisAdjacencyState からの隣接情報(該当する場合)。リストのリストの最初のインデックスは、topologyIdRange の各 topologyId に基づきます。2 つめのリストは、topologyId にある SNI の要約情報を戻します。

パラメータ

ctx:現在の動作コンテキスト。

sniInstanceNameIds:関連ステータスを検出する必要があるスイッチド ネットワーク インターフェイスの InstanceNameId。

topologyId:topoId 文字列。

戻り値

各 SNI に対応する L2mpNetworkInterfaceSummary

getFabricPathTopologySettingForInterfaces

特定の SwicthedNetworkInterface InstanceNameIds のリストに対応するリスト インスタンスのリストを戻します。

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

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

sniInstanceNameIds に、無効な SwitchedNetworkInterface InstanceNameId 値が含まれている場合。

sniInstanceNameIds に特定の InstanceNameId を持つ同等の SNI オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

sniInstanceNameIds:SwitchedNetworkInterface インスタンスに対応する InstanceNameId sniInstanceNameIds のリスト。

戻り値

照会された sniInstanceNameIds に対応する FabricPathTopologySetting インスタンスのリスト。

getFabricPathTopologySettingForTopoId

ANE のリストの特定のトポロジ ID に対応するインスタンスのリストを戻します。ANE instanceNameId リストがヌルまたは空の場合、ネットワーク内にあるすべてのデバイスの FabricPathTopologySetting オブジェクトを戻します。トポロジ ID に対応する場合、TopologySetting インスタンスは ANE にはなく、ヌルが戻されます。

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

topologyId がヌルの場合。

neInstanceNameIdCol に無効な NetworkElement InstanceNameId 値が含まれている場合。

neInstanceNameIdCol に、特定の InstanceNameId を持つ同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

topologyId:FabricPathTopologySetting インスタンスに対応する整数のトポロジ ID。

neInstanceNameIdCol:Layer2Topology が戻されるネットワーク要素のインスタンス名 ID。ヌルの場合、すべての管理対象ネットワーク要素の Layer2Topologies が戻されます。

戻り値

各 ANE に照会された topologyId に対応するインスタンスのリスト。

getFabricPathTopologySettingForVlanRange

特定の VLAN 範囲に対応するインスタンスのリストを戻します。たとえば、渡された VLAN 範囲が 1 ~ 10 で、2 つのトポロジ設定オブジェクトを戻すとします。この場合、1 つのトポロジ設定オブジェクトは 1 ~ 3 にマッピングされ、もう 1 つは 4 ~ 9 にマッピングされます。特定の vlanRange を持つ同等の FabricPathTopologySetting オブジェクトがない場合、空のリストが戻されます。

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

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

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

vlanRange に無効な VLAN ID が含まれている場合。

パラメータ

opContext:動作コンテキスト。

vlanRange:FabricPathTopologySetting インスタンスのリストに対応する IntegerRange vlanRange。

戻り値

照会された vlanRange に対応するインスタンスのリスト。

getFabricPathTopologySettings

特定の InstanceNameIds に対応するインスタンスを戻します。

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

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

fpTopologySettingInstanceNameIdCol に無効な FabricPathTopologySetting InstanceNameId またはヌル値が含まれている場合。

fpTopologySettingInstanceNameIdCol に、特定の InstanceNameId を持つ同等の FabricPathTopologySetting オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

fpTopologySettingInstanceNameIdCol:FabricPathTopologySetting インスタンスに対応する InstanceNameId のリスト。

戻り値

照会された InstanceNameIds に対応するインスタンスのリスト。

getFpTopologySettingInNetworkElements

FabricPathTopologySetting オブジェクトのリストのリストを戻します。FabricPathTopologySetting の各リストはネットワーク要素に対応します。

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

neInstanceNameIdCol に無効な NetworkElement InstanceNameId 値が含まれている場合。

neInstanceNameIdCol に、特定の InstanceNameId を持つ同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:Layer2Topology が戻されるネットワーク要素のインスタンス名 ID。ヌルの場合、すべての管理対象ネットワーク要素の Layer2Topologies が戻されます。

戻り値

FabricPathTopologySetting のリストのリスト。

getFptopologySettingWithInterfaceAssociation

FabricPathTopologySetting オブジェクトのリストを戻します。各 FabricPathTopologySetting インスタンスは SniBelongsToTopologySettingCol および SniBelongsToTopologyStatusCol によって読み込まれます。

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

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

foTopologySettingInstanceNameIdCol に無効な FabricPathTopologySetting InstanceNameId 値が含まれている場合。

fpTopologySettingInstanceNameIdCol に、特定の InstanceNameId を持つ同等の FabricPathTopologySetting オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

fpTopologySettingInstanceNameIdCol:FabricPathTopologySetting インスタンスに対応する InstanceNameId のリスト。

戻り値

照会された InstanceNameIds に対応するインスタンスのリスト。

戻された各 FabricPathTopologySetting には、次のアソシエーションが使用可能です。

SniBelongsToTopologySettingCol

SniBelongsToTopologyStatusCol

getFabricPathNetworkInterfacesummaryObjects

この API は、次のアトリビュートが含まれる FabricPathNetworkInterfaceSummary オブジェクトを戻す要約 API です:各 SNI に対応する SniBelongsToFpTopologySetting、ローカルおよびリモートのインターフェイスの SniBelongsToFpTopologyStatus からの sniBelongsToFpTopologyState(該当する場合)、ローカルおよびリモートのインターフェイスの NetworkInterfaceStatus からの NetworkInterfaceOperationStatus(該当する場合)、ローカルおよびリモートのインターフェイスの L2IsisAdjacencyState からの隣接情報(該当する場合)、リストのリストの最初のインデックスは、topologyIdRange の各 topologyId に基づきます。2 つめのリストは、topologyId にある SNI の要約情報を戻します。

パラメータ

ctx:現在の動作コンテキスト。

sniInstanceNameIds:関連ステータスを検出する必要があるスイッチド ネットワーク インターフェイスの InstanceNameId。

topologyId:topoId 文字列。

戻り値

リスト <@L2mpNetworkInterfaceSummary> は各 SNI に対応します。

getSniBelongsToTopologyStatuses

SniBelongsToTopologyStatus オブジェクトのリストのリストを戻します。SniBelongsToTopologyStatus の各リストは、FabricPathTopologySetting インスタンスに対応します。

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

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

fpTopologySettingInstanceNameIdCol に無効な FabricPathTopologySetting InstanceNameId 値が含まれている場合。

fpTopologySettingInstanceNameIdCol に、特定の InstanceNameId を持つ同等の FabricPathTopologySetting オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

fpTopologySettingInstanceNameIdCol:FabricPathTopologySetting インスタンスに対応する InstanceNameId のリスト。

戻り値

SniBelongsToTopologySetting のリストのリスト。

modifyFabricPathTopologySettings

FabricPathTopologySetting インスタンスを変更します。ユーザは FabricPathTopologySetting インスタンスの名前を変更できません。各 FabricPathTopologySetting インスタンスにマッピングされている VLAN 範囲を変更または設定できます。デフォルトでは、FabricPathTopologySetting インスタンスは 0 であり、すべての VLAN がマッピングされています。VLAN 範囲が FabricPathTopologySetting のインスタンスに割り当てられている場合、トポロジ 0 またはこの範囲がマッピングされている FabricPathTopologySetting の他のインスタンスのいずれかから VLAN を借用します。同様に、トポロジ ID 0 の VLAN 範囲を変更すると、機能例外がスローされます。

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

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

fpTopologySettingInstanceNameIdCol に無効な FabricPathTopologySetting InstanceNameId 値が含まれている場合。

fpTopologySettingInstanceNameIdCol に、特定の InstanceNameId を持つ同等の FabricPathTopologySetting オブジェクトがない場合。

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

トポロジ ID が 0 に設定され、変更された VLAN 範囲のある FabricPathTopologySetting インスタンスが fpTopologySettingList に含まれている場合。

パラメータ

opContext:動作コンテキスト。

fpTopologySettingList:変更された FabricPathTopologySetting のリスト。

戻り値

void

modifySniBelongsToFpTopologySettings

SniBelongsToFpTopologySetting インスタンスを変更します。ユーザは SniBelongsToFpTopologySetting インスタンスのメトリックを変更できます。

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

sniBelongsToFpTopologySettingList がヌルまたはコレクションが空の場合。

sniBelongsToFpTopologySettingList に、1 つまたは複数のヌル要素が含まれている場合。または、コレクションにタイプ SniBelongsToFpTopologySetting ではないオブジェクトが含まれている場合。

sniBelongsToFpTopologySettingList 内の SniBelongsToFpTopologySetting オブジェクトに、同等の永続的な SniBelongsToFpTopologySetting オブジェクトがない場合。

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

sniBelongsToFpTopologySettingList に、無効または範囲外のメトリック値を持つ SniBelongsToFpTopologySetting インスタンスが含まれている場合。

パラメータ

opContext:動作コンテキスト。

sniBelongsToFpTopologySettingList:変更された SniBelongsToFpTopologySetting のリスト。

戻り値

void

unbindInterfaceFromFabricPathTopologySetting

同じデバイスに存在する 1 つまたは複数のインスタンスへの関連付けをインスタンスから解除します。SNI および各トポロジ設定オブジェクトに対応する SniBelongsToTopologySetting インスタンスおよび SniBelongsToTopologyStatus インスタンスを削除します。

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

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

fpTopologySettingInstanceNameIdCol に無効な FabricPathTopologySetting InstanceNameId またはヌル値が含まれている場合。

fpTopologySettingInstanceNameIdCol に、特定の InstanceNameId を持つ同等の FabricPathTopologySetting オブジェクトがない場合。

niInstanceNameId が無効な NetworkInterface InstanceNameId またはヌル値の場合。

niInstanceNameId に、特定の InstanceNameId を持つ同等の NetworkInterface オブジェクトがない場合。

NetworkInterface インスタンスの InstanceNameId および fpTopologySettingInstanceNameIdCol にある任意の FabricPathTopologySetting インスタンスに対応する InstanceNameId が同じデバイスに属していない場合。

パラメータ

opContext:動作コンテキスト。

niInstanceNameId:複数のトポロジに関連付ける必要があるネットワーク インターフェイスの InstanceNameId。

fpTopologySettingInstanceNameIdCol:インスタンスの InstanceNameId のリスト。

戻り値

void