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

目次

LstApp サービス

LstApp サービスについて

bindLsgToSwitchedNetworkInterfaces

createLinkStateGroups

deleteAllLinkStateGroups

deleteLinkStateGroups

disableLst

enableLst

getDownstreamInterfacesForNetworkElement

getLinkStateGroupGlobalSetting

getLinkStateGroups

getLinkStateGroupsInNetworkElement

getLinkStateGroupsWithLsgToSniAssociations

getLsgToSniAssociationsInLinkStateGroups

getLsgToSniAssociationsInNetworkElement

getLstStateOfNetworkElements

getUpstreamInterfacesForNetworkElement

unbindLsgFromSwitchedNetworkInterfaces

LstApp サービス

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

LstApp サービスについて

Link State Tracking(LST)機能は、サーバ アダプタ NIC チーミング機能で使用されます。LST は、アップストリーム リンクの状態に基づいて、アップストリーム ポートを持つダウンストリーム ポートのセットとダウンストリーム ポートを自動的にバインドします。このアソシエーションは Link State Group(LSG)と呼ばれます。LST は各グループのステータスを追跡し、特定のアクションを実行します。API は次のカテゴリで定義されます。

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

Modify API:既存の LST グループ設定を修正します。または、LSG からスイッチド ネットワーク インターフェイスへのアソシエーションを作成します。

Remove API:デバイスの 1 つまたは複数のインターフェイスから LST グループ設定のアソシエーションを解除します。または、LST グループを削除します。

bindLsgToSwitchedNetworkInterfaces

LinkStateGroup(LSG)を、指定された方向の 1 つまたは複数のネットワーク インターフェイスに割り当てます。すでにアソシエーションが存在する場合は、これらのバインドを解除してから、ネットワーク インターフェイスを指定された LSG に、指定された方向で割り当てます。

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

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

lsgInstanceNameId が有効な LinkStateGroup ではない場合。

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

networkInterfaceInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに NetworkInterface の無効な InstanceNameId が含まれている場合。

direction がヌルの場合。

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

networkInterfaceInstanceNameIdCol コレクションに、LinkStateGroup への DOWNSTREAM ポートとして関連付けられるポートチャネル インターフェイスである NetworkInterface の InstanceNameId が含まれている場合。

パラメータ

opContext:動作コンテキスト。

networkInterfaceInstanceNameIdCol:NetworkInterface オブジェクトの InstanceNameId を 1 つまたは複数含むコレクション。

lsgInstanceNameId:LinkStateGroup オブジェクトの InstanceNameId。

direction:ネットワーク インターフェイスの方向。この方向に、LSG を適用する必要があります。方向はアップストリームまたはダウンストリームです。

戻り値

新たに作成された LinkStateGroupAppliesToSwitchedNetworkInterface オブジェクトのリスト。

createLinkStateGroups

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

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

neInstanceNameId がヌルの場合。

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

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

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

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

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

パラメータ

opContext:動作コンテキスト。

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

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

戻り値

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

deleteAllLinkStateGroups

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

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

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

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

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

パラメータ

opContext:動作コンテキスト。

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

deleteLinkStateGroups

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

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

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

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

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

パラメータ

opContext:動作コンテキスト。

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

disableLst

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

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

neInstanceNameIdCol がヌルの場合。

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

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:LST をディセーブルにすべきネットワーク要素の InstanceNameId のリスト。

enableLst

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

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

neInstanceNameIdCol がヌルの場合。

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

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:LST をイネーブルにすべきネットワーク要素の InstanceNameId のリスト。

getDownstreamInterfacesForNetworkElement

DOWNSTREAM 方向に LinkStateGroup(LSG) と関連付けることができる、ネットワーク要素内の SwitchedNetworkInterface オブジェクトをすべて戻します。1 つまたは複数のネットワーク要素の InstanceNameId を指定すると、SNI オブジェクトのコレクションのコレクションを戻します。

渡された引数 neInstanceNameIdCol がヌルまたは空の場合、もしくはコレクション内の要素が有効なネットワーク要素 InstanceNameId ではない場合には、InstanceException がスローされます。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のコレクション。

戻り値

SwitchedNetworkInterface のリストのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

ネットワーク インターフェイス名アソシエーション。

getLinkStateGroupGlobalSetting

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

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

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:LST 設定が必要なネットワーク要素の InstanceNameId のリスト。

戻り値

指定されたネットワーク要素でグローバルに設定された LST 設定。戻されたリストには、LinkStateGroupGlobalSetting インスタンスのリストが含まれます。

getLinkStateGroups

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

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

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

linkStateGroupInstanceNameIdCol に LinkStateGroup の無効な InstanceNameId が含まれる場合。

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

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

パラメータ

opContext:動作コンテキスト。

linkStateGroupInstanceNameIdCol:LinkStateGroup の InstanceNameId のコレクション。

戻り値

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

getLinkStateGroupsInNetworkElement

ネットワーク要素内で設定されたすべての Link State Group(LSG)を戻します。1 つまたは複数のネットワーク要素の InstanceNameId を指定すると、LSG オブジェクトのコレクションのコレクションを戻します。

渡された引数 neInstanceNameIdCol がヌルまたは空の場合、もしくはコレクション内の要素が有効なネットワーク要素 InstanceNameId ではない場合には、InstanceException がスローされます。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のコレクション。

戻り値

LinkStateGroup のリストのリスト。戻されたオブジェクト リストには、LinkStateGroup それぞれについて、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

戻された LSG オブジェクトのアソシエーションはすべてクリアされます。

戻される linkStateGroups は、LSG の lsgId 順に並べられます。

getLinkStateGroupsWithLsgToSniAssociations

LinkStateGroupAppliesToSwitchedNetworkInterface アソシエーションが読み込まれた Link State Group オブジェクトが戻されます。

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

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

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

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

パラメータ

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

lsgInstanceNameIdCol:LinkStateGroupAppliesToSwitchedNetworkInterface が必要な LinkStateGroup オブジェクトの InstanceNameId オブジェクトのリスト。

戻り値

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

各 LSG に対して、次のアソシエーションが読み込まれます。

LinkStateGroupAppliesToSwitchedNetworkInterface。

getLsgToSniAssociationsInLinkStateGroups

指定された Link State Group(LSG)リストに存在する LinkStateGroupAppliesToSwitchedNetworkInterfaces のコレクションを戻します。LSG の InstanceNameId のリストを指定すると、LinkStateGroupAppliesToSwitchedNetworkInterface オブジェクトのコレクションを戻します。

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

渡された引数がヌルの場合、または有効な LSG InstanceNameId ではない場合。

有効だが、存在しない LSG InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:Link State Group の InstanceNameId のリスト。

戻り値

LinkStateGroup に対応する LinkStateGroupAppliesToSwitchedNetworkInterface オブジェクトのリストのリスト。

LSG オブジェクトでは、LinkStateGroupAppliesToSwitchedNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。

NetworkInterface オブジェクト。NetworkInterface オブジェクトでは、LinkStateGroupAppliesToSwitchedNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。

getLsgToSniAssociationsInNetworkElement

すべての Link State Group(LSG)を、ネットワーク要素で設定されたネットワーク インターフェイス アソシエーションに戻します。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、ネットワーク インターフェイス アソシエーション オブジェクトに LSG オブジェクトのコレクションのコレクションを戻します。

渡された引数がヌルまたは空の場合、もしくはコレクション内の要素が有効な AbstractNetworkElement の InstanceNameId ではない場合には、ValidationException がスローされます。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のコレクション。

戻り値

LinkStateGroupAppliesToSwitchedNetworkInterface オブジェクトのリストのリスト。これは NetworkInterface との間のアソシエーションを表します。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

LinkStateGroup オブジェクト。LSG オブジェクトでは、linkStateGroupAppliesToSwitchedNetworkInterfaceCol アソシエーションを除き、すべてのアソシエーションがクリアされます。

NetworkInterface オブジェクト。NetworkInterface オブジェクトでは、linkStateGroupAppliesToSwitchedNetworkInterfaceCol アソシエーションを除き、すべてのアソシエーションがクリアされます。

getLstStateOfNetworkElements

LST の状態(ネットワーク要素のリストで LST がイネーブルかディセーブルか)を戻します。ネットワーク要素のインスタンス名 ID リストを指定すると、ブール値のリストを戻します。

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

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

ブール値 TRUE は、指定されたネットワーク要素で LST がイネーブルにされていることを示します。

ブール値 FALSE は、指定されたネットワーク要素で LST がディセーブルにされていることを示します。

getUpstreamInterfacesForNetworkElement

UPSTREAM 方向に LinkStateGroup(LSG) と関連付けることができる、ネットワーク要素内の SwitchedNetworkInterface オブジェクトをすべて戻します。1 つまたは複数のネットワーク要素の InstanceNameId を指定すると、SNI オブジェクトのコレクションのコレクションを戻します。

渡された引数 neInstanceNameIdCol がヌルまたは空の場合、もしくはコレクション内の要素が有効なネットワーク要素 InstanceNameId ではない場合には、InstanceException がスローされます。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のコレクション。

戻り値

SwitchedNetworkInterface のリストのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

ネットワーク インターフェイス名アソシエーション。

unbindLsgFromSwitchedNetworkInterfaces

ネットワーク インターフェイスから Link State Group(LSG)アソシエーションをクリアします。

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

networkInterfaceInstanceNameId がヌルである、またはこれが SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

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

lsgInstanceNameId が有効な LinkStateGroup ではない場合。

パラメータ

opContext:動作コンテキスト。

networkInterfaceInstanceNameId:削除する必要のある LSG が含まれている NetworkInterface オブジェクトの InstanceNameId。

lsgInstanceNameId:LinkStateGroup オブジェクトの InstanceNameId。

戻り値

void