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

目次

FexApp サービス

SoftwareApp サービスについて

bindPortsToFex

bindPortsToFexWithForce

createFabricExtenders

deleteFabricExtenders

disableFex

disableLocatorLedFex

enableFex

enableLocatorLedFex

fexPinningRedistribute

getFabricExtenderGlobalSetting

getFabricExtenders

getFabricExtendersInNetworkElement

getManagedEnesInNetworkElements

getPortsInFabricExtender

getVpcStateOfExtendedNetworkElements

isHostInterfacePortChannelCapable

modifyFabricExtenders

unbindPortsFromFex

FexApp サービス

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

SoftwareApp サービスについて

この章では、DCNM サーバの FEX に関する情報の取得に使用できる API を定義します。

bindPortsToFex

fex-fabric(インターフェイス)ポートを指定された FexId にバインドします。

指定された FabricExtender オブジェクトが存在しない場合、IntegrityException がスローされます。FeatureException は、次のいずれかの状況が発生した場合にスローされます。

ユーザが FabricExtender をポートチャネルのメンバー ポートに関連付けた場合。

ユーザが同じ FabricExtender を複数のポートチャネルと関連付けた場合。

ユーザが、複数の最大ピンニング リンクを持つポートチャネルに関連付けられる場合。

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

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

パラメータ

opContext:

portNameIdCol:

fexId:

戻り値

void

bindPortsToFexWithForce

fex-fabric(インターフェイス)ポートを指定された FexId にバインドします。

指定された FabricExtender がすでにポートチャネルに関連付けられている場合、API は既存のアソシエーションをアンバインドし、指定された SwitchedEtherChannelNetworkInterface との間にアソシエーションを作成します。

DB の更新中、FabricExtender リファレンスは sni に設定、保存され、InstanceState は UNMODIFIED に設定されます。指定された FabricExtender オブジェクトが存在しない場合、IntegrityException がスローされます。FeatureException は、次のいずれかの状況が発生した場合にスローされます。

ユーザが FabricExtender をポートチャネルのメンバー ポートに関連付けた場合。

ユーザが同じ FabricExtender を複数のポートチャネルと関連付けた場合。

ユーザが、複数の最大ピンニング リンクを持つポートチャネルに関連付けられる場合。

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

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

パラメータ

opContext:

portNameIdCol:

fexId:

戻り値

void

createFabricExtenders

ネットワーク要素内に 1 つまたは複数の FabricExtender オブジェクトを作成します。ネットワーク要素の InstanceNameId および FabricExtender オブジェクトのリストを指定すると、サーバにオブジェクトを作成し、そのインスタンス名 ID を戻します。

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

neInstanceNameId がヌルの場合。

neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。

fabricExtenderCol コレクションがヌル、またはこのコレクションが空である場合。

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

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

fabricExtenderCol コレクションでは、FabricExtender のアトリビュートが 1 つも有効ではない場合。

1. FabricExtender の fexId が 100 ~ 199 の範囲に含まれていない。

2. FabricExtender の maxPinningLinks が 1 ~ 4 の範囲に含まれていない。

3. FabricExtender の description アトリビュート値に 21 文字以上が含まれている。

4. FabricExtender の serialNumber アトリビュート値に 21 文字以上が含まれている。

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

すでにデータベースに存在する FabricExtender が fabricExtenderCol に含まれている場合。

この API はインターフェイス アソシエーションを考慮しません。FabricExtender とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。FabricExtender をインターフェイスにバインドするには、別の API を呼び出す必要があります。

パラメータ

opContext:動作コンテキスト。

neInstanceNameId:ネットワーク要素の InstanceNameId。

fabricExtenderCol:作成が必要な FabricExtender オブジェクトのコレクション(1 つまたは複数)。

戻り値

新たに作成された FabricExtender オブジェクトのインスタンス名 ID。

deleteFabricExtenders

1 つまたは複数の FabricExtender オブジェクトを削除します。FabricExtender オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。

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

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

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

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

パラメータ

opContext:動作コンテキスト。

fabricExtenderInstanceNameIdCol:削除する必要のある 1 つまたは複数の FabricExtender オブジェクトの InstanceNameId を含むコレクション。

戻り値

void

disableFex

1 つまたは複数のネットワーク要素で FEX 条件機能をディセーブルにします。

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

neInstanceNameIdCol がヌルの場合。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:FEX 条件機能をディセーブルにすべきネットワーク要素の InstanceNameId のリスト

戻り値

void

disableLocatorLedFex

fabricExtender に対してロケータ主導の Fex を発行しません。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

戻り値

void

enableFex

1 つまたは複数のネットワーク要素で FEX 条件機能をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で FEX 条件機能がイネーブルにされます。

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

neInstanceNameIdCol がヌルの場合。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:FEX 条件機能をイネーブルにすべきネットワーク要素の InstanceNameId のリスト

戻り値

void

enableLocatorLedFex

fabricExtender に対してロケータ主導の Fex を発行します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

戻り値

void

fexPinningRedistribute

fabricExtenderCol に対して fex ピンニング再配布(fex ダウンリンク ポートの再配布)を発行します。

パラメータ

opContext:

fabricExtenderCol:

戻り値

void

getFabricExtenderGlobalSetting

1 つまたは複数のネットワーク要素に対して、デバイス レベルの fabricExtenderGlobalsettings を戻します。1 つまたは複数のネットワーク要素の InstanceNameId を指定すると、これらのネットワーク要素に対して、対応する FabricExtenderGlobalSetting オブジェクトを戻します。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が AbstractNetworkElement オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:1 つまたは複数の AbstractNetworkElement オブジェクトの InstanceNameId。

戻り値

FabricExtenderGlobalSetting オブジェクトのコレクション。

getFabricExtenders

InstanceNameId から FabricExtender オブジェクトを戻します。FabricExtender の InstanceNameId のコレクションを指定すると、対応する FabricExtender オブジェクトを戻します。

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

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

fabricExtenderInstanceNameIdCol に FabricExtender の無効な InstanceNameId が含まれる場合。

fabricExtenderInstanceNameIdCol にヌル値が含まれる場合。

fabricExtenderInstanceNameIdCol に、特定の InstanceNameId を持つ同等の FabricExteder オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

fabricExtenderInstanceNameIdCol:FabricExtender の InstanceNameId のコレクション。

戻り値

指定された InstanceNameId のコレクションに対応する FabricExtender オブジェクトのリスト。戻された FabricExtender オブジェクト リストでは、その他のアソシエーションがクリアされます。

getFabricExtendersInNetworkElement

ネットワーク要素内で設定されたすべての Fex を戻します。このネットワーク要素の InstanceNameId を指定すると、FabricExtender オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト。

neInstanceNameId:ネットワーク要素の InstanceNameId。

戻り値

FabricExtender のリスト。戻されたオブジェクトのリストでは、その他のアソシエーションはすべてクリアされます。戻される fabricExtenders は、fabricExtender の fexId 順に並べられます。

getManagedEnesInNetworkElements

指定されたネットワーク要素リストに存在する ExtendedNetworkElements のコレクションを戻します。ネットワーク要素の InstanceNameId のリストを指定すると、ExtendedNetworkElement オブジェクトのコレクションを戻します。

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

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

有効だが、存在しないネットワーク要素 InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

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

戻り値

NetworkElement に対応する ExtendedNetworkElement オブジェクトのリストのリスト。

各 ExtendedNetworkElement オブジェクトでは、次のアソシエーションが使用できます。

シャーシ

getPortsInFabricExtender

FabricExtender に関連するポートのリストを戻します。FabricExtender に基づいて、SwitchedNetworkInterface(物理ポートおよびポートチャネル)のコレクションを戻します。

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

1. NetworkInterfaceName。

2. FabricPortStatus。

3. PhysicalPort。

4. SwitchedEtherChannelPortSetting。

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

fabricInstanceNameId がヌルである、または FabricExtender の有効な InstanceNameId ではない場合。

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

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

パラメータ

opContext:動作コンテキスト。

fabricExtenderId:ポートの問い合わせ元となる FabricExtender の InstanceNameId。

戻り値

指定された FabricExtenderInstanceNameId に関連付けられている SwitchedNetworkInterface ポートのリスト。

getVpcStateOfExtendedNetworkElements

指定された ExtendedNetworkElement InstanceNameId リストに対する vPC セットアップに FEX が参加しているかどうかに基づき、ブールのリストを戻します。

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

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

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:1 つまたは複数の拡張ネットワーク要素の InstanceNameId。

戻り値

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

ブール値 TRUE は、ExtendedNetworkElement が vPC セットアップに参加していることを表します。

ブール値 FALSE は、ExtendedNetworkElement が vPC セットアップに参加していないことを表します。

isHostInterfacePortChannelCapable

指定された ExtendedNetworkElement InstanceNameId リストについて、複数のホスト インターフェイスを単一のポートチャネルとしてグループ化できるかどうかに基づき、ブールのリストを戻します。

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

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

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

パラメータ

opContext:動作コンテキスト

eneInstanceNameIdCol:1 つまたは複数の拡張ネットワーク要素の InstanceNameId。

戻り値

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

ブール値 TRUE は、ExtendedNetworkElement が vPC セットアップに参加していることを表します。

ブール値 FALSE は、ExtendedNetworkElement が vPC セットアップに参加していないことを表します。

modifyFabricExtenders

既存の FabricExtender オブジェクトを 1 つまたは複数、変更します。

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

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

fabricExtenderCol コレクションに、FabricExtender タイプではないオブジェクトが含まれている場合。

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

fabricExtenderCol コレクションでは、FabricExtender のアトリビュートが 1 つも有効ではない場合。

1. FabricExtender の maxPinningLinks が 1 ~ 4 の範囲に含まれていない。

2. FabricExtender の description アトリビュート値に 21 文字以上が含まれている。

3. FabricExtender の serialNumber アトリビュート値に 21 文字以上が含まれている。

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

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

この API はインターフェイス アソシエーションを考慮しません。FabricExtender とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。FabricExtender をインターフェイスにバインドするには、別の API を呼び出す必要があります。

パラメータ

opContext:動作コンテキスト。

fabricExtenderCol:データベース内の既存の FabricExtender オブジェクトを置き換える FabricExtender オブジェクトのコレクション(1 つまたは複数)。

戻り値

void

unbindPortsFromFex

sni から fabricextender をアンバインドします。DB から sni をロードし、FabricExtenderRef に基づいて、関連する fabricExtender オブジェクトを取得します。fabricextender オブジェクトがヌルに設定されるのは、デバイスにコマンドを配信した後でのみです。

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

パラメータ

opContext:

portNameIdCol:

戻り値

void