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

目次

EtherChannelApp サービス

EtherChannelApp サービスについて

addPortsToEtherChannelEndPoint

addPortsToEtherChannelEndPointWithForce

createEtherChannel

createEtherChannelForSpecifiedEndpoints

deleteEtherChannelEndPoints

deleteEtherChannels

disableLacp

enableLacp

getAllEtherChannels

getAllEtherChannelsForTopology

getEtherChannelGlobalSettings

getEtherChannelLinks

getEtherChannelsInNetworkElement

getEtherChannelsInNetworkElements

getEtherChannelsWithMemberPorts

getLacpStateOfNetworkElements

getNetworkCardsWithLoadBalanceSettings

modifyEtherChannelGlobalSetting

modifyEtherChannelInterfaces

modifyNetworkCardEtherChannelLoadBalanceSettings

modifyNetworkInterfaceLinks

removePortsFromEtherChannelEndPoint

EtherChannelApp サービス

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

EtherChannelApp サービスについて

ポートチャネル テクノロジーを使用すると、パラレル リンクを集約(バンドル)することによって、リンク帯域幅をスケール変更できます。Fast Ethernet(FE; ファスト イーサネット)ポートまたは Gigabit Ethernet(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 および Remove API:ポート チャネルとそのメンバー ポート間のアソシエーションを追加または削除します。

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

addPortsToEtherChannelEndPoint

指定したポートを、指定したイーサネット チャネル エンドポイントに関連付けます。指定したポートは、指定したイーサネット チャネル エンドポイントと同じモード(スイッチドまたはルーテッド)で動作している必要があります。

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

プロトコル デフォルト モード

LACP Active

NONE On

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

channelEpId がヌルの場合。

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

portIds コレクションがヌルまたは空の場合、あるいはこのコレクションに、物理ポートの InstanceNameId 以外のオブジェクトが含まれる場合。

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

メンバー ポートに異なる ACL が設定されている場合。

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

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

指定したイーサネット チャネル エンドポイントに 16 のメンバー ポートがすでに含まれる場合。

指定したポートが、指定したイーサネット チャネル エンドポイントと異なるモードで動作する場合(たとえば、ポートがスイッチド モードで、イーサネット チャネル エンドポイントがルーテッド モードの場合)。

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

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

指定したポートがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

channelEpId:指定したポートを関連付ける先の SwitchedEtherChannelNetworkInterface または RoutedEtherChannelNetworkInterface の InstanceNameId

portIds:追加するポート(SwitchedNetworkInterface または RoutedNetworkInterface)の InstanceNameId のリスト

戻り値

void

addPortsToEtherChannelEndPointWithForce

指定したポートを、指定した EtherChannel エンドポイントに関連付けます。指定したポートを、指定した EtherChannel エンドポイントとは異なるモード(スイッチドまたはルーテッド)で動作させることができます。この場合、EtherChannel エンドポイントごとに、指定したポートのポート モードを変更します。

Cisco Nexus 5000 シリーズ スイッチの場合、この API を呼び出すと、PortChannel からポートの不一致のコンフィギュレーションがコピーされます。これは、vPC ウィザード対応の Cisco Nexus 5000 シリーズ スイッチで force オプションをサポートするために実行されます。Cisco Nexus 5000 シリーズ スイッチは、ルーテッド インターフェイスをサポートしていないため、ここで説明した動作は、スイッチド インターフェイスおよび Cisco Nexus 5000 シリーズ スイッチ プラットフォームに対してのみ想定されます。

次の設定が EtherChannel エンドポイントからキャプチャされ、メンバー ポートでアップデートされます。

ポート設定(速度、全二重など)

フロー制御送信側

フロー制御受信側

トラフィック ストーム制御

スイッチ ポート モード(アクセスまたはトランク)

スイッチポート アクセス VLAN(存在する場合)

スイッチポート トランク ネイティブ VLAN(存在する場合)

スイッチポート トランク許可 VLAN(存在する場合)

メンバー ポート モードは、EtherChannel エンドポイント プロトコルに基づき、次のようにアップデートされます。

 

プロトコル
デフォルト モード

LACP

Active

NONE

On

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

channelEpId がヌルの場合。

channelEpId が EtherChannel エンドポイントの有効な InstanceNameId ではない場合。

portIds コレクションがヌルまたは空の場合、あるいはこのコレクションに、物理ポートの InstanceNameId 以外のオブジェクトが含まれる場合。

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

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

指定した EtherChannel エンドポイントに 16 のメンバー ポートがすでに含まれる場合。

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

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

指定したポートがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト。

channelEpId:指定したポートを関連付ける先の SwitchedEtherChannelNetworkInterface または RoutedEtherChannelNetworkInterface の InstanceNameId。

portIds:追加するポート(SwitchedNetworkInterface または RoutedNetworkInterface)の InstanceNameId のリスト。

createEtherChannel

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

渡すイーサネット チャネル オブジェクトには、イーサネット チャネル ネットワーク インターフェイス エンドポイントと、チャネル メンバーを読み込んだ対応するアソシエーションの両方を含める必要があります。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行している Cisco Nexus 7000 シリーズ スイッチに対し使用できます。

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

newChannel がヌルの場合。

プロトコルが、メンバー ポートを持たないイーサネット チャネル エンドポイントに対し NONE に設定されている場合。

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

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

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

メンバー ポートに異なる ACL が設定されている場合。

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

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

newChannel が有効ではない場合。

例:

イーサネット チャネル ID は、Catalyst 6500 シリーズ スイッチの場合は 1 ~ 256 の範囲内にする必要があり、Nexus 7000 シリーズ スイッチの場合は 1 ~ 4096 の範囲内にする必要があります。

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

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

createEtherChannelForSpecifiedEndpoints

指定したポート間に、指定したチャネル ID を持つイーサネット チャネルを作成します。

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

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

sourceEpChannelId がヌルの場合。

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

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

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

sourceEpChannelId が有効なイーサネット チャネル ID ではない場合。

neighborEpChannelIds に有効なイーサネット チャネル ID が含まれない場合。

例:

イーサネット チャネル ID は、Catalyst 6500 シリーズ スイッチの場合は 1 ~ 256 の範囲内にする必要があり、Nexus 7000 シリーズ スイッチの場合は 1 ~ 4096 の範囲内にする必要があります。

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

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

sourceEpPortMemberIds コレクションに、データベースに存在しない NetworkInterface InstanceNameId が含まれる場合。

sourceEpPortMemberIds の NetworkInterface に重複する NetworkInterface オブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

sourceEpChannelId:発信元エンドポイントに使用するチャネル ID

sourceEpPortMemberIds:発信元エンドポイント ポート メンバー(SwitchedNetworkInterface または RoutedNetworkInterface)の InstanceNameId のリスト

neighborEpChannelIds:ネイバー エンドポイントに使用するチャネル ID(整数)のリスト

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

戻り値

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

deleteEtherChannelEndPoints

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

このメソッドは、SwitchedEtherChannelNetworkInterface エンドポイントまたは RoutedEtherChannelNetworkInterface エンドポイントの指定したすべてのインスタンス、およびそれらのポート メンバー アソシエーションを削除します。

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

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

endPointIds コレクションに、SwitchedEtherChannelNetworkInterface または RoutedEtherChannelNetworkInterface の InstanceNameId タイプではない要素が含まれる場合。

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

パラメータ

opContext:動作コンテキスト

endPointIds:エンドポイント(SwitchedEtherChannelNetworkInterface または RoutedEtherChannelNetworkInterface)の InstanceNameId の配列

戻り値

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:動作コンテキスト

戻り値

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

イーサネット チャネルに関する次のアソシエーションが示されます。

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

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

イーサネット チャネルの各エンドに関する次のアソシエーションが示されます。

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

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

インターフェイスの機能

インターフェイスの設定

getAllEtherChannelsForTopology

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

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

戻されるリストには、ネットワーク レベルのイーサチャネルごとに 1 つのイーサチャネル インスタンスのみ含まれますので注意してください。このインスタンスには、発信元エンドポイントとしていずれかのポートチャネル エンドポイントが含まれ、また、ネイバー エンドポイントとして他のポートチャネル エンドポイントが含まれます。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対し使用できます。

パラメータ

opContext:動作コンテキスト。

戻り値

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

イーサチャネルに関する次のアソシエーションが示されます。

1. イーサチャネルの発信元エンド

2. イーサチャネルのネイバー エンド

イーサチャネルの各エンドに関する次のアソシエーションが示されます。

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

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

2. インターフェイスの設定

getEtherChannelGlobalSettings

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

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

指定したネットワーク要素のイーサネット チャネル グローバル設定の順序付きリスト。

getEtherChannelLinks

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

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

SwitchedNetworkInterface リンクまたは RoutedNetworkInterface リンクのエンドごとに、次のアソシエーションが使用可能です。

SwitchedEtherChannelPortSetting または RoutedEtherChannelPortSetting

SwitchedEtherChannelPortStatus または RoutedEtherChannelPortStatus

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

パラメータ

opContext:動作コンテキスト

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

戻り値

指定したイーサチャネルに存在するイーサネット チャネル リンク。戻されるリストには、NetworkInterfaceLink インスタンスまたは NetworkInterfaceLink インスタンスを含むリスト オブジェクトが含まれます。

getEtherChannelsInNetworkElement

指定したネットワーク要素において少なくとも 1 つのエンドポイントを所有するすべてのイーサチャネルを戻します。

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

イーサネット チャネルに関する次のアソシエーションが示されます。

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

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

イーサネット チャネルの各エンドに関する次のアソシエーションが示されます。

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

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

インターフェイスの機能

インターフェイスの設定

getEtherChannelsInNetworkElements

指定したリスト内のネットワーク要素において少なくとも 1 つのエンドポイントを所有するすべてのイーサチャネルのリストを戻します。

このメソッドが戻すイーサチャネルには、発信元エンドポイントとネイバー エンドポイントの両方が含まれます。イーサチャネル ネットワーク インターフェイス エンドポイントには、ポート メンバー アソシエーション以外のすべてのアトリビュートが読み込まれるため、注意してください。これらのアソシエーションは、特定の API get メソッド、getEtherChannelLinks(OpContext, List) を使用して取得できます。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

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

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:イーサチャネルが必要なネットワーク要素の InstanceNameId のリスト

戻り値

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

イーサチャネルに関する次のアソシエーションが示されます。

1. イーサチャネルの発信元エンド

2. イーサチャネルのネイバー エンド

イーサチャネルの各エンドに関する次のアソシエーションが示されます。

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

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

2. インターフェイスの機能

3. インターフェイスの設定

getEtherChannelsWithMemberPorts

指定したネットワーク要素において少なくとも 1 つのエンドポイントを所有するすべてのイーサチャネルを戻します。

このメソッドが戻すイーサチャネルには、発信元エンドポイントとネイバー エンドポイントの両方が含まれます。イーサチャネル ネットワーク インターフェイス エンドポイントには、すべてのアトリビュートが読み込まれ、ポート メンバー アソシエーションも含まれます。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

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

パラメータ

opContext:動作コンテキスト。

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

isSwitched:Boolean.True の場合、戻されるリストには、スイッチド イーサチャネルのみ含まれます。Boolean.False の場合、戻されるリストには、ルーテッド イーサチャネルのみ含まれます。ヌルの場合、戻されるリストには、スイッチド イーサチャネルとルーテッド イーサチャネルの両方が含まれます。

戻り値

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

イーサチャネルに関する次のアソシエーションが示されます。

1. イーサチャネルの発信元エンド

2. イーサチャネルのネイバー エンド

3. 各イーサチャネル エンドポイントには、メンバー ポートおよびそのリンク アソシエーションが読み込まれます。

イーサチャネルの各エンドに関する次のアソシエーションが示されます。

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

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

2. インターフェイスの機能

3. インターフェイスの設定

4. SwitchedEtherChannelPortSetting または RoutedEtherChannelPortSetting

5. SwitchedEtherChannelPortStatus または RoutedEtherChannelPortStatus

getLacpStateOfNetworkElements

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

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

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

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

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

getNetworkCardsWithLoadBalanceSettings

イーサネット チャネル ロード バランス設定コンフィギュレーションを読み込んだ、指定したネットワーク要素のすべてのネットワーク カードを戻します。

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

modifyEtherChannelGlobalSetting

指定したネットワーク要素のイーサネット チャネル グローバル設定を、指定したグローバル設定オブジェクトを使用して変更します。

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

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

networkCardSlotNos コレクションに、ヌルの要素または整数タイプではない要素が含まれる場合

設定コレクションに、ヌルの要素または NetworkCardEtherChannelLoadBalanceSetting タイプではない要素が含まれる場合

パラメータ

opContext:動作コンテキスト

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

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

戻り値

void

modifyEtherChannelInterfaces

既存のイーサネット チャネル エンドポイントの基本アトリビュート(たとえば、速度、全二重など)を、指定したイーサネット チャネル エンドポイント リストの変更を使用して変更します。

このメソッドは、イーサネット チャネル エンドポイントの基本アトリビュートの変更のみを使用して、サーバをアップデートします。指定したイーサネット チャネル エンドポイントにおいて、ポート メンバー アソシエーションの変更は実行されません。

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 コレクションにヌルまたは空の要素が含まれる場合。

設定コレクションに、ヌルまたは空の要素が含まれる場合。

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

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

指定したスロットにモジュールが存在しない場合。

パラメータ

opContext:動作コンテキスト

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

networkCardSlotNos:ロード バランス設定を変更するネットワーク カードのスロット番号。リストに、Integer のインスタンスを含める必要があります。

settings:適用するロード バランス設定。リストに、NetworkCardEtherChannelLoadBalanceSetting のインスタンスを含める必要があります。

戻り値

void

modifyNetworkInterfaceLinks

指定したネットワーク インターフェイス リンクの既存のポートおよびチャネル アソシエーション アトリビュートを変更します。

このメソッドは、メンバー ポート アソシエーションではないポートとチャネルの間のアソシエーションのアトリビュート(たとえば、モード)のみをアップデートします。

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

プロトコル デフォルト モード

LACP Active

NONE On

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

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

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

パラメータ

opContext:動作コンテキスト

networkInterfaceLinks:イーサネット チャネル リンクのリスト。値として NetworkInterfaceLink インスタンスまたは NetworkInterfaceLink インスタンスを使用できます。

戻り値

void

removePortsFromEtherChannelEndPoint

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

指定したポート メンバーが削除された後、指定したイーサネット チャネル エンドポイントにメンバー ポートがない場合、プロトコルは 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