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

目次

Interface L2IsisApp サービス

Interface L2IsisApp サービスについて

bindL2topologyToIsisProcess

createL2IsisProcesses

deleteL2GraphUserRequest

deleteL2IsisProcesses

disableL2Isis

enableL2Isis

fetchM2ribGraph

getAllL2GraphUserRequest

getM2ribGraph

getInterfaceWithL2IsisSettings

getL2IsisProcesForL2TopologySettings

getL2IsisProcesses

getL2IsisProcessesInNetworkElements

getL2IsisProcessWithL2TopologySetting

getL2IsisStateInNetworkElements

getM2ribGraph

getPortsWithL2IsisSettingsInModule

modifyL2IsisAuthenticationSettings

modifyL2IsisProcessSettings

modifyL2IsisSettingsForInterfaces

stopFetchingL2Graph

unbindL2topologyFromIsisProcess

Interface L2IsisApp サービス

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

Interface L2IsisApp サービスについて

FabricPath Intermediate System to Intermediate System(ISIS)は、ドメイン内ルーティング情報交換プロトコルです。L2ISIS は、ユニキャスト、マルチキャスト、ブロードキャストなど、あらゆる種類のデータ トラフィックのトポロジの構築および転送に使用されるコントロール プロトコルです。

このインターフェイスは、すべての API を定義して Fabricpath-ISIS を管理します。

API は次のカテゴリにまとめられます。

Query または Get API:永続的なデータベースからデータを照会します。

Create API:新しい Fabricpath-ISIS プロセスを作成します。

Modify API:Fabricpath-ISIS プロセス レベルおよびインターフェイス レベルの設定を変更します。

Delete API:既存の ISIS プロセスを削除します。

API のイネーブル化およびディセーブル化:スイッチの Fabricpath-ISIS サービスをイネーブルまたはディセーブルにします。

bindL2topologyToIsisProcess

L2 トポロジのセットを ISIS プロセスにバインドします。

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

isisProcessId がヌルの場合、または L2IsisProcess の有効な InstanceNameId ではない場合。

L2TopologySettingIdCol がヌルの場合、またはリストが空の場合。

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

isisProcessId の対応する L2 Isis プロセス オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

isisProcessId:L2 トポロジ設定がバインドされる L2IsisProcess の InstanceNameId。

L2TopologySettingIdCol:L2 isis プロセスにバインドされる L2 トポロジ設定の InstanceNameId のリスト。

戻り値

void

createL2IsisProcesses

1 つまたは複数の L2 isis プロセスを作成します。

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

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

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

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

newIsisProcess で、L2 isis 設定アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

newIsisProcesses:L2IsisProcess オブジェクトの変更されたリスト。

戻り値

InstanceNameId:CollectionInfo のインスタンス名 ID

deleteL2GraphUserRequest

このメソッドは、DceL2GraphUserRequests の削除に使用されます。これは、InstanceNameId の指定リストに対応するグラフ ユーザ要求オブジェクトを削除します。対応する DceL2GraphUserRequest および次に示すアソシエーションが削除されます。

DceL2Graph

DceL2GraphEntry

DceL2GraphNextHopInfo

M2ribGraph

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

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

graphRequestIdCol コレクションにタイプ DceL2GraphUserRequest InstanceNameId でない要素が含まれている場合。

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

パラメータ

opContext:動作コンテキスト

graphRequestIdCol:削除する必要がある graphRequests のリスト。

戻り値

void

deleteL2IsisProcesses

指定 L2 isis のすべてのプロセスを削除します。

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

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

isisProcessIdCol コレクションにタイプ L2IsisProcess InstanceNameId でない要素が含まれている場合。

IntegrityException は、指定 L2 isis プロセスがデバイスに存在しない場合にスローされます。

パラメータ

opContext:動作コンテキスト

isisProcessIdCol:L2 isis プロセスの InstanceNameId の配列。

戻り値

void

disableL2Isis

1 つまたは複数のネットワーク要素で fabricpath-isis サービスをディセーブルにします。このメソッドは、L2ISIS 機能をサポートする NX-OS を実行するデバイスだけで適用できます。

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

neInstanceNameIdCol がヌルの場合。

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

IntegrityException は、デバイスに特定の collectionInfo が存在しない場合にスローされます。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:L2isis をディセーブルにする必要があるネットワーク要素の InstanceNameId のリスト。

戻り値

void

enableL2Isis

1 つまたは複数のネットワーク要素で L2isis サービスをイネーブルにします。このメソッドは、L2isis 機能をサポートする DC-OS を実行するデバイスだけで適用できます。

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

# neInstanceNameIdCol がヌルの場合。

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

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:L2isis をイネーブルにする必要があるネットワーク要素の InstanceNameId のリスト。

戻り値

void

fetchM2ribGraph

取得メソッドに関連付けられた DceL2GraphUserRequest オブジェクトを戻します。この DceL2GraphUserRequest を使用すると、実際のグラフ オブジェクト呼び出しは、getM2ribGraph API を使用してクエリーされます。各グラフは、マルチキャスト トラフィックのソース、マルチキャストの IGMP グループ アドレスおよび VLAN の 3 つのパラメータで識別されます。

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

パラメータ

opContext:動作コンテキスト

anchorDeviceId:グラフ作成を開始するアンカー スイッチの InstanceNameId。

ftagId:転送タグ ID

vlanIds:受信者が加入している VLAN のリスト

sourceIp:マルチキャスト トラフィックのソースの IpAddress。このパラメータがヌルの場合、ソース入力はワイルドカード文字「*」として処理されます。これは、「任意のソース IP」を表します。

igmpAddress:マルチキャスト トラフィックが生成される IGMP アドレス IpAddress

topoId:トポロジの ID

getLatest:取得呼び出しが指定入力パラメータでグラフを再計算するか、データベースから既存の情報を戻すかを示すブール。

戻り値

グラフ計算に割り当てられる DceL2GraphUserRequest。

getAllL2GraphUserRequest

指定グラフ タイプの DceL2GraphUserRequest のリストを戻します。graphType がヌルの場合、L2GraphUserRequests のすべてのタイプ(ユニキャスト、マルチキャスト、ブロードキャスト)を戻します。

パラメータ

opContext:動作コンテキスト

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

graphType:ユーザが DceL2GraphUserRequest のリストを必要とするグラフのタイプ(ユニキャスト、マルチキャスト、ブロードキャスト)。graphType は、次のいずれかです。

L2GraphType.UNICAST は、すべてのユニキャスト DceL2GraphUserRequests を戻します。

L2GraphType.BROADCAST は、すべてのブロードキャスト DceL2GraphUserRequests を戻します。

L2GraphType.MULTICAST は、すべてのマルチキャスト DceL2GraphUserRequests を戻します。

戻り値

指定 graphType に対応する DceL2GraphUserRequest のリスト、またはすべてのユニキャスト、ブロードキャストまたはマルチキャスト DceL2GraphUserRequest のリスト。

getM2ribGraph

DceL2GraphUserRequest に関連付けられた M2ribGraph オブジェクトを戻します。

InstanceException は、渡された引数 graphRequestId がヌルの場合にスローされます。

パラメータ

opContext:動作コンテキスト

graphRequestId:DceL2GraphUserRequest の InstanceNameId

戻り値

要求オブジェクト計算に関連付けられた M2ribGraph。

getInterfaceWithL2IsisSettings

isis 設定アソシエーションが読み込まれたスイッチド ネットワーク インターフェイス オブジェクトのリストを戻します。

ValidationException は、渡された引数がヌルの場合、または有効なスイッチド ネットワーク インターフェイス InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

interfaceIdCol:SwitchedNetworkInterface に対応する InstanceNameId。

戻り値

SwitchedNetworkInterface のインスタンス。

次のアソシエーションが、SwitchedNetworkInterface に読み込まれます。

L2IsisProcess および L2IsisAuthenticationSetting を含む L2IsisSettingsForNetworkInterface。

getL2IsisProcesForL2TopologySettings

L2 トポロジ設定の指定リストの L2IsisProcess のリストを戻します。

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

L2TopologySettingIdCol がヌルの場合、あるいは無効な L2 トポロジ設定 InstanceNameId またはヌル値が含まれている場合。

L2TopologySettingIdCol の指定 InstanceNameId と同等の L2 トポロジ設定オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

L2TopologySettingIdCol:L2 トポロジ設定の InstanceNameId のリスト。

戻り値

指定 L2 トポロジ設定に対応する L2IsisProcess のリスト。

getL2IsisProcesses

L2IsisProcess ID の指定リストの L2IsisProcess のリストを戻します。

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

isisProcessIdCol がヌルの場合、あるいは無効な L2 Isis プロセス InstanceNameId またはヌル値が含まれている場合。

isisProcessIdCol の指定 InstanceNameId と同等の L2 isis プロセス オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

指定 L2 isis プロセス ID に対応する L2IsisProcess のリスト。

L2IsisProcess ごとに、次のアソシエーションが使用可能です。

L2IsisBasicSetting

L2IsisAuthenticationSetting

LspSetting

SpfInterval

getL2IsisProcessesInNetworkElements

ネットワーク要素の指定リストの L2IsisProcess のリストを戻します。

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

neInstanceNameIds がヌルの場合、あるいは無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

指定ネットワーク要素に対応する L2IsisProcess のリスト。

L2IsisProcess ごとに、次のアソシエーションが使用可能です。

L2IsisBasicSetting

L2IsisAuthenticationSetting

LspSetting

SpfInterval

getL2IsisProcessWithL2TopologySetting

L2topologySetting アソシエーションが読み込まれた L2IsisProcess オブジェクトのリストを戻します。

ValidationException は、渡された引数がヌルの場合、または有効な L2 isis プロセス InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

isisProcessIdCol:L2IsisProcess に対応する InstanceNameId。

戻り値

L2IsisProcess のインスタンス。

次のアソシエーションが、L2IsisProcess に読み込まれます。

L2TopologySetting を含む L2IsisTopologySettings。

getL2IsisStateInNetworkElements

fabricpath-isis がネットワーク要素のリストでイネーブルまたはディセーブルにされているどうかを示す isis サービスの状態を戻します。ネットワーク要素のインスタンス名 ID リストを指定すると、ブール値のリストを戻します。

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

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

ブール値 TRUE は、fabricpath-isis が指定ネットワーク要素でイネーブルであることを示します。

ブール値 FALSE は、fabricpath-isis が指定ネットワーク要素でディセーブルであることを示します。

getM2ribGraph

DceL2GraphUserRequest に関連付けられた M2ribGraph オブジェクトを戻します。

InstanceException は、渡された引数 graphRequestId がヌルの場合にスローされます。

パラメータ

opContext:動作コンテキスト

graphRequestId:DceL2GraphUserRequest の InstanceNameId。

戻り値

要求オブジェクト計算に関連付けられた M2ribGraph。

getPortsWithL2IsisSettingsInModule

指定スロットのモジュールに存在する場合、すべての FabricPath 対応ポートと L2ISIS 設定を戻します。ネットワーク要素のインスタンス名 ID およびモジュールのスロット番号を指定すると、モジュールに対応する物理インターフェイス オブジェクトのコレクションと L2ISIS 設定を戻します。

ValidationException は、渡された引数がヌルの場合、または有効なルーテッド ポート InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId。

slotNo:ポートが必要なモジュールのスロット番号。たとえば、AIDA モジュール スロット番号をパラメータに指定すると、モジュールに存在するすべてのポートと L2ISIS 設定が戻されます。ポートに使用できる L2ISIS 設定がない場合、モジュールのすべての物理ポートが戻されます。

戻り値

モジュールに存在する SwitchedNetworkInterface インスタンスと RoutedNetworkInterface インスタンスのリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

ルーテッド ポートの場合、ルーテッド サブネットワーク インターフェイス

L2IsisProcess

FabricPathTopologySetting

L2IsisAuthenticationSetting

ルーテッド サブネットワーク インターフェイスの場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation

modifyL2IsisAuthenticationSettings

プロセスの 1 つまたは複数の既存の L2isisAuthentication 設定を変更します。

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

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

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

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

modifiedIsisAuthSettings で、L2IsisAuthenticationsettings アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

modifiedIsisAuthSettings:L2IsisAuthenticationSetting オブジェクトの変更されたリスト。

戻り値

void

modifyL2IsisProcessSettings

1 つまたは複数の既存の L2 isis プロセス設定を変更します。

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

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

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

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

modifiedIsisProcess で、L2 isis 設定アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

modifiedIsisProcesses:L2IsisProcess オブジェクトの変更されたリスト。

戻り値

void

modifyL2IsisSettingsForInterfaces

ネットワーク インターフェイス オブジェクトの L2 isis 設定を変更します。

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

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

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

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

modifiedInterface で、L2IsisSettingsForInterface アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト。

modifiedInterfaces:L2IsisProcess オブジェクトの変更されたリスト。

戻り値

void

stopFetchingL2Graph

このメソッドは、L2Graph ディスカバリの停止に使用されます。InstanceNameId ユーザ要求の指定リストのグラフ ディスカバリを停止します。対応する DceL2GraphUserRequest L2graph ディスカバリが停止されます。

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

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

graphRequestIdCol コレクションにタイプ DceL2GraphUserRequest InstanceNameId でない要素が含まれている場合。

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

パラメータ

opContext:動作コンテキスト

graphRequestIdCol:L2graph ディスカバリを停止する、graphRequests のリスト。

戻り値

void

unbindL2topologyFromIsisProcess

L2 トポロジのセットをその Isis プロセスからアンバインドします。

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

L2TopologySettingIdCol がヌルの場合、またはリストが空の場合。

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

L2TopologySettingId の対応する L2 トポロジ設定オブジェクトが存在しない場合。

パラメータ

collectionInfoId:コレクション情報の InstanceId。

L2TopologySettingIdCol:L2 isis プロセスからアンバインドされる L2 トポロジ設定の InstanceNameId のリスト。

戻り値

void