Cisco DCNM Web Services API ガイド Release 4.0
EtherChannelApp サービス
EtherChannelApp サービス
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

EtherChannelApp サービス

EtherChannelApp サービスの概要

addPortsToEtherChannelEndPoint

createEtherChannel

createEtherChannelForSpecifiedEndpoints

deleteEtherChannelEndPoints

deleteEtherChannels

disableLacp

enableLacp

getAllEtherChannels

getEtherChannelGlobalSettings

getEtherChannelLinks

getEtherChannelsInNetworkElement

getLacpStateOfNetworkElements

getNetworkCardsWithLoadBalanceSettings

modifyEtherChannelGlobalSetting

modifyEtherChannelInterfaces

modifyNetworkCardEtherChannelLoadBalanceSettings

modifyNetworkInterfaceLinks

removePortsFromEtherChannelEndPoint

EtherChannelApp サービス

この章では、DCNM Web サービスの EtherChannelApp サービスに対応する API メソッドについて説明します。

EtherChannelApp サービスの概要

ポートチャネル テクノロジーを使用すると、パラレル リンクを集約(バンドル)することによって、リンク帯域幅をスケール変更できます。ファスト イーサネット(FE)またはギガビット イーサネット(GE)ポートの 2 ~ 8 個のリンクを 1 つの論理リンクにバンドルできます。また、ポート チャネルは冗長性を提供します。ポート チャネルの 1 つのリンクがダウンしても、トラフィックは、ポート チャネル内で動作中のほかのリンク経由のポート チャネルを通って流れます。この状況ではポートチャネル インターフェイスがダウン状態になることはなく、ネットワーク内のルートの再計算は不要です。チャネル内のすべてのポートの帯域幅の合計によって、より高い集約帯域幅が得られます。データ トラフィックは、ハッシュ アルゴリズムに基づいて、メンバー リンクでロード バランスが行われます。

ポートチャネル インターフェイスは、デバイス内に一意のポート チャネル ID を持つ論理インターフェイス(ポート)です。ポートチャネル インターフェイスは、レイヤ 2 ポートチャネル インターフェイス(SwitchedEtherChannelNetworkInterface)またはレイヤ 3 ポートチャネル インターフェイス(RoutedEtherChannelNetworkInterface)のいずれかです。各ポートチャネル インターフェイスは、Catalyst 6500 シリーズ スイッチのメンバーとして 0 ~ 16 個の物理ポートを持つことができますが、これらのメンバー ポートは、共通の運用および設定パラメータを持つ必要があります。レイヤ 2 ポート チャネルはレイヤ 2 物理ポートにのみ関連付けることができ、レイヤ 3 ポート チャネルはレイヤ 3 物理ポートにのみ関連付けることができます。

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

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

Create API ― 新しいポート チャネルを作成します。

Modify API ― 既存のポートチャネル インターフェイスの基本アトリビュートを修正します。

Delete API ― 既存のポート チャネルを削除します。

Add and Remove API ― ポート チャネルとそのメンバー ポートのアソシエーションを追加または削除します。

Enable and Disable API ― デバイスの LACP サービスをイネーブルまたはディセーブルにします。

addPortsToEtherChannelEndPoint

特定のポートを特定のイーサネット チャネル エンド ポイントに関連付けます。特定のポートは、特定のイーサネット チャネル エンド ポイントと同じモード(スイッチドまたは経路選択済み)で動作する必要があります。

メンバー ポート モードは、次に示すように、イーサネット チャネル エンド ポイント プロトコルに基づいてアップデートされます。

ProtocolDefault モード

LACPActive

NONEOn

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

channelEpId がヌルの場合

channelEpId が有効なイーサネット チャネル エンド ポイント InstanceNameId でない場合

portIds 収集がヌル、収集が空、または収集に物理ポートの InstanceNameId 以外のオブジェクトが含まれる場合

ポート セキュリティが特定のメンバー ポート(802.1x ポート)のいずれかでイネーブルの場合

メンバー ポートが異なる Access Control List(ACL; アクセス コントロール リスト)で設定されている場合

いずれかのメンバー ポートが Switched Port Analyzer(SPAN; スイッチド ポート アナライザ)宛先の場合

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

特定のイーサネット チャネル エンド ポイントにすでに 16 個のメンバー ポートがある場合

特定のポートが特定のイーサネット チャネル エンド ポイント(経路選択済みなど)と異なるモード(スイッチド)で動作する場合

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

特定のチャネル エンド ポイントがデバイスに存在しない場合

特定のポートがデバイスに存在しない場合

パラメータ

opContext ― 動作可能なコンテキスト

channelEpId ― 特定のポートを関連付ける必要がある SwitchedEtherChannelNetworkInterface および RoutedEtherChannelNetworkInterface の InstanceNameId

portIds ― 追加するポート(SwitchedNetworkInterface と RoutedNetworkInterface)の InstanceNameId のリスト

戻り値

void

createEtherChannel

特定の新しいイーサネット チャネルを作成し、新しく作成されたイーサネット チャネル エンドポイントのインスタンス名 ID のリストを戻します。

渡されたイーサネット チャネル オブジェクトは、両方のイーサネット チャネル ネットワーク インターフェイス エンドポイントおよびチャネル メンバーが読み込まれた対応するアソシエーションを持つ必要があります。

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

newChannel がヌルの場合

Protocol がメンバー ポートをもたないいずれかのイーサネット チャネル エンド ポイントに対して NONE に設定されている場合

Protocol がいずれかのイーサネット チャネル エンド ポイントに対して PAgP に設定されている場合

いずれかのメンバー ポート モードが AUTO または DESIRABLE のときに Protocol が LACP に設定されている場合

いずれかのメンバー ポートがポート セキュリティ(802.1x ポート)イネーブルである場合

メンバー ポートが異なる Access Control List(ACL; アクセス コントロール リスト)で設定されている場合

いずれかのメンバー ポートが SPAN 宛先ポートの場合

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

newChannel が有効でない場合

イーサネット Channel ID(CID; チャネル ID)は、Catalyst 6500 シリーズ スイッチでは 1 ~ 256、Nexus 7000 シリーズ スイッチでは 1 ~ 4096 の範囲になければなりません。

イーサネット チャネル エンド ポイントにメンバーとして追加できるポートは 16 個のみです。

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

特定のイーサネット CID を持つイーサネット チャネル エンド ポイントがすでにデバイスに存在している場合

パラメータ

opContext ― 動作可能なコンテキスト

newChannel ― 追加する新しいチャネル

戻り値

新しいチャネル エンドポイントの InstanceNameId のリスト

createEtherChannelForSpecifiedEndpoints

特定の CID を持つ特定のポート間にイーサネット チャネルを作成します。

この方式では、特定の CID と特定のポートのリストを使用してエンド ポイントを作成します。作成された新しいイーサネット チャネルのモード(スイッチドまたは経路選択済み)は、特定のポートのモードに基づいて決定されます。すべての特定のポートは、スイッチドまたは経路選択済みと同じモードにする必要があります。イーサネット チャネル ネットワーク インターフェイス エンドポイントおよびそのアソシエーション パラメータのすべてのアトリビュートは、デフォルト値に設定されます。特定のメンバー ポート リストが空の場合、プロトコルが NONE に設定されるか、またはプロトコルとモードがデフォルト値(LACP と ACTIVE)に設定されます。

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

sourceEpChannelId がヌルの場合

sourceEpPortMemberIds が有効なネットワーク インターフェイス InstanceNameId でない場合

neighborEpChannelIds に 1 つまたは複数のヌル要素が含まれるか空の場合

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

sourceEpChannelId が有効なイーサネット CID でない場合

neighborEpChannelIds に有効なイーサネット CID が含まれない場合

イーサネット CID は、Catalyst 6500 シリーズ スイッチでは 1 ~ 256、Nexus 7000 シリーズ スイッチでは 1 ~ 4096 の範囲になければなりません。

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

特定のイーサネット CID を持つイーサネット チャネル ネットワーク インターフェイスがすでにデータベースに存在している場合

sourceEpPortMemberIds 収集に、データベースに存在しない NetworkInterface InstanceNameId が含まれる場合

sourceEpPortMemberIds 内の NetworkInterface に、複製 NetworkInterface オブジェクトが含まれる場合

パラメータ

opContext ― 動作可能なコンテキスト

sourceEpChannelId ― 発信元エンドポイントに使用する CID

sourceEpPortMemberIds ― 発信元エンドポイント ポート メンバーの InstanceNameId のリスト(SwitchedNetworkInterface と RoutedNetworkInterface)

neighborEpChannelIds ― ネイバー エンドポイントに使用する CID(整数)のリスト

neighborEpPortMemberIds ― ネイバー エンドポイント ポート メンバーの InstanceNameId を含むリスト オブジェクトのリスト(SwitchedNetworkInterface と RoutedNetworkInterface)

戻り値

新しいチャネル エンドポイントの InstanceNameId のリスト

deleteEtherChannelEndPoints

すべての特定のイーサネット チャネル エンドポイントを削除します。

この方式では、SwitchedEtherChannelNetworkInterface および RoutedEtherChannelNetworkInterface エンドポイントとそのポート メンバー アソシエーションのすべての特定のインスタンスを削除します。

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

endPointIds 収集がヌルまたは空の場合

endPointIds 収集に、タイプ SwitchedEtherChannelNetworkInterface および RoutedEtherChannelNetworkInterface InstanceNameId でない要素が含まれる場合

特定のポート チャネル エンド ポイントがデバイスに存在しない場合、IntegrityException がスローされます。

パラメータ

opContext ― 動作可能なコンテキスト

endPointIds ― エンドポイントの InstanceNameId の配列(SwitchedEtherChannelNetworkInterface と RoutedEtherChannelNetworkInterface)

戻り値

void

deleteEtherChannels

すべての特定の イーサチャネルを削除します。

この方式では、すべてのポート メンバーと特定のイーサチャネルのイーサネット チャネル エンドポイントを削除することによって、特定の各イーサネット チャネルを削除します。

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

channels 収集がヌルまたは空の場合

channels 収集に、タイプ イーサネット チャネル InstanceNameId でない要素が含まれる場合

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

パラメータ

opContext ― 動作可能なコンテキスト

channels ― 削除するイーサネット チャネルのリスト

戻り値

void

disableLacp

1 つまたは複数のネットワーク要素での LACP サービスをディセーブルにします。この API は Cisco NX-OS が動作しているデバイスでのみ適用できます。

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

neInstanceNameIdCol がヌルの場合

neInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれているか、収集が空であるか、または収集がタイプ InstanceNameId でない場合

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

void

enableLacp

1 つまたは複数のネットワーク要素での LACP サービスをイネーブルにします。この API は Cisco NX-OS が動作しているデバイスでのみ適用できます。

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

neInstanceNameIdCol がヌルの場合

neInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれているか、収集が空であるか、または収集がタイプ InstanceNameId でない場合

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

void

getAllEtherChannels

ネットワークにあるすべてのイーサチャネルを戻します。

この方式によって戻されるイーサチャネルには、発信元およびネイバー エンドポイントの両方が読み込まれます。イーサネット チャネル ネットワーク インターフェイス エンドポイントには、ポート メンバー アソシエーション以外のすべてのアトリビュートが読み込まれることに注意してください。これらのアソシエーションは、ほかの特定の get API、getEtherChannelLinks(OpContext、List)を使用して取得できます。

戻されたリストには、ネットワーク レベルのイーサネット チャネル単位で 1 つのイーサネット チャネルのみが含まれます。このインスタンスには、発信元エンドポイントとしていずれかのポートチャネル エンドポイント、ネイバー エンドポイントとしてほかのポートチャネル エンドポイントが含まれます。

パラメータ

opContext ― 動作可能なコンテキスト

戻り値

ネットワークのすべてのイーサチャネル。戻されたリストには、いずれかのイーサネット チャネル インスタンスのリストが含まれます。

イーサネット チャネルには次のアソシエーションがあります。

イーサネット チャネルの発信元エンド

イーサネット チャネルのネイバー エンド

イーサネット チャネルの各エンドには次のアソシエーションがあります。

(ほかのアソシエーションはクリアされます)

インターフェイス ステータス

インターフェイス機能

インターフェイス設定

getEtherChannelGlobalSettings

特定のネットワーク要素のイーサネット チャネル グローバル設定を戻します。

イーサネット チャネル グローバル設定オブジェクトは、特定のネットワーク要素インスタンス ID の順序に基づいて、戻されたリストで指示されます。

渡された引数がヌルであるか、または有効なネットワーク要素 InstanceNameIds でない場合、ValidationException がスローされます。

パラメータ

opContext ― 動作可能なコンテキスト

networkElementIds ― イーサネット チャネル グローバル設定情報が必要なネットワーク要素インスタンスの InstanceNameId

戻り値

特定のネットワーク要素のイーサネット チャネル グローバル設定の指示されたリスト

getEtherChannelLinks

特定のイーサネット チャネル エンドポイントにあるすべてのイーサネット チャネル リンクを戻します。

各リンクには、物理インターフェイスの収集(両方のエンド)が含まれます。リンクが存在しない場合、収集にはリスト内の 1 つのエンドのみが含まれます。

リンク SwitchedNetworkInterface および RoutedNetworkInterface の各エンドでは、次のアソシエーションが使用できます。

SwitchedEtherChannelPortSetting と RoutedEtherChannelPortSetting

SwitchedEtherChannelPortStatus と RoutedEtherChannelPortStatus

渡された引数がヌルであるか、または有効なスイッチドおよび経路選択済みイーサネット チャネル インターフェイス InstanceNameIds でない場合、ValidationException がスローされます。

パラメータ

opContext ― 動作可能なコンテキスト

channelEndPointIds ― リンク情報が必要な SwitchedEtherChannelNetworkInterface および RoutedEtherChannelNetworkInterface インスタンスの InstanceNameId

戻り値

特定のイーサチャネルにあるイーサネット チャネル リンク。戻されたリストには、NetworkInterfaceLink インスタンスまたは NetworkInterfaceLink インスタンスのいずれかを含むリスト オブジェクトが含まれます。

getEtherChannelsInNetworkElement

特定のネットワーク要素内に少なくとも 1 つのエンド ポイントを持つすべてのイーサチャネルを戻します。

この方式によって戻されるイーサチャネルには、発信元およびネイバー エンドポイントの両方が読み込まれます。イーサネット チャネル ネットワーク インターフェイス エンドポイントには、ポート メンバー アソシエーション以外のすべてのアトリビュートが読み込まれることに注意してください。これらのアソシエーションは、ほかの特定の API get メソッドである getEtherChannelLinks(OpContext、List)を使用して取得できます。

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

パラメータ

opContext ― 動作可能なコンテキスト

networkElementId ― イーサチャネルが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素にあるイーサチャネル。戻されたリストには、いずれかのイーサネット チャネル インスタンスのリストが含まれます。

イーサネット チャネルには次のアソシエーションがあります。

イーサネット チャネルの発信元エンド

イーサネット チャネルのネイバー エンド

イーサネット チャネルの各エンドには次のアソシエーションがあります。

(ほかのアソシエーションはクリアされます)

インターフェイス ステータス

インターフェイス機能

インターフェイス設定

getLacpStateOfNetworkElements

ネットワーク要素のリストで LACP がイネーブルかディセーブルかなど、LACP サービスの状態を戻します。ネットワーク要素のインスタンス名 ID のリストが与えられると、ブール値のリストを戻します。

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

neInstanceNameIdCol 収集にヌルの要素が含まれているか、収集が空であるか、または収集がタイプ InstanceNameId でない場合

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

パラメータ

opContext ― 動作可能なコンテキスト

neInstanceNameIdCol ― AAA 状態が要求される 1 つまたは複数のネットワーク要素の InstanceNameId

戻り値

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

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

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

getNetworkCardsWithLoadBalanceSettings

イーサネット チャネル ロード バランス設定が読み込まれている特定のネットワーク要素のすべてのネットワーク カードを戻します。

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

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

パラメータ

opContext ― 動作可能なコンテキスト

neInstanceNameId ― モジュール レベルのロード バランス設定が必要なネットワーク要素の InstanceNameId

戻り値

NetworkCard インスタンスのリスト。戻されたオブジェクトのリストでは、ロード バランス設定アソシエーションのみが存在します。

modifyEtherChannelGlobalSetting

特定のグローバル設定オブジェクトを持つ特定のネットワーク要素のイーサネット チャネル グローバル設定を修正します。

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

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

networkCardSlotNos 収集にヌルの要素または Integer タイプでない要素が含まれる場合

setting 収集にヌルの要素またはタイプ NetworkCardEtherChannelLoadBalanceSetting でない要素が含まれる場合

パラメータ

opContext ― 動作可能なコンテキスト

networkElementId ― グローバル設定をアップデートする必要があるネットワーク要素の InstanceNameId

gSetting ― 設定する新しいグローバル設定オブジェクト

戻り値

void

modifyEtherChannelInterfaces

特定のイーサネット チャネル エンド ポイント リスト内に修正がある既存のイーサネット チャネル エンド ポイントの基本アトリビュート(Speed、duplex など)を修正します。

この方式では、イーサネット チャネル エンドポイントの基本アトリビュートに修正のあるサーバのみをアップデートします。ポート メンバー アソシエーション変更の修正は、特定のイーサネット チャネル エンド ポイントでは行われません。

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

portChannelNetworkIinterfaces がヌルまたは空の場合

portChannelNetworkIinterfaces に 1 つまたは複数のヌル要素が含まれるか、または収集にタイプ SwitchedEtherChannelNetworkInterface または RoutedEtherChannelNetworkInterface でないオブジェクトが含まれる場合

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

特定のポート チャネル ネットワーク インターフェイスがデバイスに存在しない場合

ポート メンバー アソシエーションを修正するには、addPortsToEtherChannelEndPoint(OpContext, InstanceNameId, List) および #removePortsFromEtherChannelEndPoint(InstanceNameId, List)} を使用します。

ポート メンバーのすべてのアトリビュートを修正するには、modifyNetworkInterfaceLinks(OpContext, List) を使用します。

パラメータ

opContext ― 動作可能なコンテキスト

portChannelNetworkIinterfaces ― 修正されたイーサネット チャネル ネットワーク インターフェイスのリスト(SwitchedEtherChannelNetworkInterface と RoutedEtherChannelNetworkInterface)

戻り値

void

modifyNetworkCardEtherChannelLoadBalanceSettings

特定のネットワーク要素内の特定のネットワーク カードのイーサネット チャネル ロード バランス設定を修正します。

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

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

networkCardSlotNos 収集にヌルまたは空の要素が含まれる場合

settings 収集にヌルまたは空の要素が含まれる場合

スロット番号のサイズと設定が一致していない場合

カードがロード バランシングをサポートしていない場合

特定のスロットにモジュールが存在しない場合

パラメータ

opContext ― 動作可能なコンテキスト

networkElementId ― ネットワーク カード イーサネット チャネル ロード バランス設定を変更する必要があるネットワーク要素の InstanceNameId

networkCardSlotNos ― ロード バランス設定を修正する必要があるネットワーク カードのスロット番号。リストには Integer のインスタンスが含まれている必要があります。

settings ― 適用するロード バランス設定。リストには NetworkCardEtherChannelLoadBalanceSetting のインスタンスが含まれている必要があります。

戻り値

void

modifyNetworkInterfaceLinks

特定のネットワーク インターフェイス リンクの既存のポートとチャネルのアソシエーション アトリビュートを修正します。

この方式では、メンバー ポート アソシエーションでないポートとチャネルのアソシエーションのアトリビュートのみ(mode など)をアップデートします。

メンバー ポート モードは、次に示すように、イーサネット チャネル エンド ポイント プロトコルに基づいてアップデートされます。

ProtocolDefault モード

LACPActive

NONEOn

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

networkInterfaceLinks がヌルまたは空の場合

networkInterfaceLinks に 1 つまたは複数のヌル要素が含まれるか、または収集にタイプ NetworkInterfaceLink でないオブジェクトが含まれる場合

パラメータ

opContext ― 動作可能なコンテキスト

networkInterfaceLinks ― イーサネット チャネル リンクのリスト。NetworkInterfaceLink インスタンスまたは NetworkInterfaceLink インスタンスのいずれかが値となります。

戻り値

void

removePortsFromEtherChannelEndPoint

特定のポート メンバーを特定のイーサネット チャネル エンド ポイントから削除します。

特定のポート メンバーの削除後、特定のイーサネット チャネル エンド ポイントにメンバー ポートがない場合、Protocol は NONE に設定されます。

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

channelEpId がヌルの場合

channelEpId が有効なイーサネット チャネル エンド ポイント InstanceNameId でない場合

portIds 収集がヌル、収集が空、または収集に物理ポートの InstanceNameId 以外のオブジェクトが含まれる場合

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

特定のポートが特定のイーサネット チャネル エンド ポイント(経路選択済みなど)と異なるモード(スイッチド)で動作する場合

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

channelEpId がデータベースに存在しない SwitchedEtherChannelNetworkInterface または RoutedEtherChannelNetworkInterface の InstanceNameId の場合

portIds 収集に、データベースに存在しない NetworkInterface InstanceNameId が含まれる場合

パラメータ

opContext ― 動作可能なコンテキスト

portIds ― 削除するポート(SwitchedNetworkInterface と RoutedNetworkInterface)の InstanceNameId のリスト

channelEpId ― 特定のポート メンバーを削除する必要がある SwitchedEtherChannelNetworkInterface および RoutedEtherChannelNetworkInterface の InstanceNameId

戻り値

void