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

目次

FipSnoopingApp サービス

FipSnoopingApp サービスについて

disableFipSnooping

disableFipSnoopingOnVlans

enableFipSnooping

enableFipSnoopingOnVlans

fetchActiveFipSnoopingSessionsInNetworkElements

getActiveFcoeNodesInInterfaces

getActiveFcoeNodesInNetworkElements

getActiveFcoeNodesInVlans

getFipSnoopingEnabledVlansInNetworkElement

getFipSnoopingGlobalSetting

getFipSnoopingInterfaceSettingsForInterfaces

getFipSnoopingStateOfNetworkElements

getFipSnoopingVlanSettingsForVlans

modifyFipSnoopingInterfaceSettings

modifyFipSnoopingVlanSettings

validateVlansForFipSnooping

FipSnoopingApp サービス

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

FipSnoopingApp サービスについて

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

disableFipSnooping

1 つまたは複数のネットワーク要素で FIP スヌーピングをディセーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で FIP スヌーピング機能がディセーブルにされます。この API を使用し、FIP スヌーピングをサポートしている Nexus デバイスで、この機能をディセーブルにすることができます。

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

neIdCol がヌルの場合。

neIdCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションが空の場合。

指定されたネットワーク要素が 1 つも FIP スヌーピングをサポートしていない場合。

パラメータ

opContext:動作コンテキスト

neIdCol:FIP スヌーピングをイネーブルにすべきネットワーク要素の InstanceNameId のリスト

戻り値

void

disableFipSnoopingOnVlans

指定された InstanceNameId コレクションに対応する VLAN 上で FIP スヌーピングをディセーブルにします。

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

vlanIdCol がヌルの場合。

vlanIdCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションが空の場合。

FIP スヌーピングをディセーブルにする必要のある VLAN の属するネットワーク要素が FIP スヌーピングをまったくサポートしていない場合

パラメータ

opContext:動作コンテキスト

vlanIdCol:FIP スヌーピングをディセーブルにすべき VLAN の InstanceNameId オブジェクトのリスト。

戻り値

指定された VLAN に対応する FipSnoopingVlanSetting オブジェクトの InstanceNameId のリスト。

enableFipSnooping

1 つまたは複数のネットワーク要素で FIP スヌーピングをイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で FIP スヌーピング機能がイネーブルにされます。この API を使用し、FIP スヌーピングをサポートしている Nexus デバイスで、この機能をイネーブルにすることができます。

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

neIdCol がヌルの場合。

neIdCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションが空の場合。

指定されたネットワーク要素が 1 つも FIP スヌーピングをサポートしていない場合。

パラメータ

opContext:動作コンテキスト

neIdCol:FIP スヌーピングをイネーブルにすべきネットワーク要素の InstanceNameId のリスト

enableFipSnoopingOnVlans

指定された InstanceNameId コレクションに対応する VLAN 上で FIP スヌーピングをイネーブルにします。

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

vlanIdCol がヌルの場合。

vlanIdCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションが空の場合。

FIP スヌーピングをイネーブルにする必要のある VLAN の属するネットワーク要素が FIP スヌーピングをまったくサポートしていない場合

パラメータ

opContext:動作コンテキスト

vlanIdCol:FIP スヌーピングをイネーブルにすべき VLAN の InstanceNameId オブジェクトのリスト。

戻り値

指定された VLAN に対応する FipSnoopingVlanSetting オブジェクトの InstanceNameId のリスト。

fetchActiveFipSnoopingSessionsInNetworkElements

指定されたネットワーク要素によりスヌーピングされている FCF と ENode の間のアクティブな FIP セッションを取得します。ネットワーク要素の InstanceNameId オブジェクトのリストを指定すると、この API は ActiveFipSession オブジェクトの対応リストを同じ順序のリストとして戻します。

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

1. アクティブ FCF

2. アクティブ ENode

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

neIdCol がヌル、または空の場合

コレクションの要素のいずれかがヌルの場合、または 1 つも有効なネットワーク要素 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

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

戻り値

指定された InstanceNameId リストに対応する ActiveFipSession オブジェクト リストのリスト。指定されたネットワーク要素にアクティブな FIP セッションがない場合、戻されたリスト内の対応するエントリは空のリストになります。

getActiveFcoeNodesInInterfaces

指定されたインターフェイスを経由したアクティブ FIP セッションを持つ FCoE フォワーダ(FCoE スイッチ)および ENode(ホスト/サーバ)を戻します。関係するインターフェイスの InstanceNameId オブジェクトのリストを指定すると、この API は ActiveFcoeNode オブジェクトの対応リストを同じ順序のリストとして戻します。

各 ActiveFcoeNode インスタンスでは、次のアソシエーションが使用できます。

VLAN リファレンス

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

ifIdCol がヌル、または空の場合

コレクションの要素のいずれかがヌルの場合、または 1 つも有効なネットワーク インターフェイス InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

ifIdCol:インターフェイスの InstanceNameId。

戻り値

指定された InstanceNameId リストに対応する ActiveFcoeNode オブジェクト リストのリスト。指定されたインターフェイスにアクティブな FCF または ENode がない場合、戻されたリスト内の対応するエントリは空のリストになります。

getActiveFcoeNodesInNetworkElements

指定されたネットワーク要素経由で接続された FCoE フォワーダ(FCoE スイッチ)および ENode(ホスト/サーバ)を戻します。関係するネットワーク要素の InstanceNameId オブジェクトのリストを指定すると、この API は ActiveFcoeNode オブジェクトの対応リストを同じ順序のリストとして戻します。

各 ActiveFcoeNode インスタンスでは、次のアソシエーションが使用できます。

1. ネットワーク インターフェイス リファレンス

2. VLAN リファレンス

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

neIdCol がヌル、または空の場合

コレクションの要素のいずれかがヌルの場合、または 1 つも有効なネットワーク要素 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

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

戻り値

指定された InstanceNameId リストに対応する ActiveFcoeNode オブジェクト リストのリスト。指定されたネットワーク要素にアクティブな FCoE ノード(ENode または FCF)がない場合、戻されたリスト内の対応するエントリは空のリストになります。

getActiveFcoeNodesInVlans

指定された VLAN にアクティブ FIP セッションを持つ FCoE フォワーダ(FCoE スイッチ)および ENode(ホスト/サーバ)を戻します。関係する VLAN の InstanceNameId オブジェクトのリストを指定すると、この API は ActiveFcoeNode オブジェクトの対応リストを同じ順序のリストとして戻します。

各 ActiveFcoeNode インスタンスでは、次のアソシエーションが使用できます。

ネットワーク インターフェイス リファレンス

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

vlanIdCol がヌル、または空の場合

コレクションの要素のいずれかがヌルの場合、または 1 つも有効な VLAN InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

vlanIdCol:VLAN の InstanceNameId。

戻り値

指定された InstanceNameId リストに対応する ActiveFcoeNode オブジェクト リストのリスト。指定された VLAN にアクティブな FCF または ENode がない場合、戻されたリスト内の対応するエントリは空のリストになります。

getFipSnoopingEnabledVlansInNetworkElement

指定された InstanceNameId リストに対応する各ネットワーク要素で FIP スヌーピングがイネーブルになっている VLAN オブジェクトを戻します。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、この API は、各ネット要素で FIP スヌーピングがイネーブルにされている VlanExternal オブジェクトのみを戻します。

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

1. VLAN ステータス

2. FIP スヌーピングの VLAN 設定

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

neIdCol がヌル、または空の場合

コレクションの要素のいずれかがヌルの場合、または 1 つも有効なネットワーク要素 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

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

戻り値

指定されたネットワーク要素の InstanceNameId それぞれに対する VlanExternal インスタンス リストのリストを同じ順序で戻します。

getFipSnoopingGlobalSetting

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

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

neIdCol にヌルの要素が含まれている場合、またはこのコレクションが空である場合。

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

パラメータ

opContext:動作コンテキスト

neIdCol:FIP スヌーピングのグローバル設定が必要なネットワーク要素の InstanceNameId のリスト

戻り値

指定されたネットワーク要素で設定されている FIP スヌーピングのグローバル設定。戻されたリストには、FipSnoopingGlobalSetting インスタンスのリストが含まれます。

getFipSnoopingInterfaceSettingsForInterfaces

指定されたインターフェイスに対する FIP スヌーピング設定を戻します。関係するインターフェイスに対応する InstanceNameId オブジェクトのリストを指定すると、この API は FipSnoopingInterfaceSettings オブジェクトの対応リストを同じ順序のリストとして戻します。

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

ifIdCol がヌル、または空の場合

コレクションの要素のいずれかがヌルの場合、または 1 つも有効なネットワーク インターフェイス InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

ifIdCol:インターフェイスの InstanceNameId。

戻り値

指定された InstanceNameId リストに対応する FipSnoopingInterfaceSettings オブジェクトのリスト。

getFipSnoopingStateOfNetworkElements

指定されたネットワーク要素リストに対応する FIP スヌーピング機能の状態を戻します。ネットワーク要素のインスタンス名 ID のリストを指定すると、ブール オブジェクトのリストを戻します。

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

neIdCol にヌルの要素が含まれている場合、またはこのコレクションが空である場合。

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

パラメータ

opContext:動作コンテキスト

neIdCol:FIP スヌーピングの状態が必要な 1 つまたは複数のネットワーク要素の InstanceNameId。

戻り値

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

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

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

getFipSnoopingVlanSettingsForVlans

指定された VLAN に対する FIP スヌーピング設定を戻します。関係する VLAN に対応する InstanceNameId オブジェクトのリストを指定すると、この API は FipSnoopingVlanSettings オブジェクトの対応リストを同じ順序のリストとして戻します。

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

vlanIdCol がヌル、または空の場合

コレクションの要素のいずれかがヌルの場合、または 1 つも有効な VLAN InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

vlanIdCol:VLAN の InstanceNameId。

戻り値

指定された InstanceNameId リストに対応する FipSnoopingVlanSettings オブジェクトのリスト。

modifyFipSnoopingInterfaceSettings

1 つまたは複数のネットワーク要素に属する、1 つまたは複数のインターフェイスの既存の FIP スヌーピング インターフェイス設定を変更します。この API を通じて変更できる FIP スヌーピング インターフェイス設定は次のとおりです。

FIP スヌーピング ポート モード

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

fipSnoopingIfSettings がヌルの場合。

fipSnoopingIfSettings に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションが空の場合。

FIP スヌーピングの変更対象となるインターフェイスの属するネットワーク要素が FIP スヌーピングをまったくサポートしていない場合。

FIP スヌーピングのグローバル設定の変更対象となるインターフェイスが FIP スヌーピングをまったくサポートしていない場合。

パラメータ

opContext:動作コンテキスト

fipSnoopingIfSettings:変更を必要とする FipSnoopingInterfaceSettings オブジェクトのリスト。

戻り値

void

modifyFipSnoopingVlanSettings

1 つまたは複数のネットワーク要素に属する、1 つまたは複数の VLAN の既存の FIP スヌーピング VLAN 設定を変更します。これ以降、この API を通じて変更できる FIP スヌーピング VLAN 設定は次のとおりです。

FIP スヌーピングの状態

FC MAP 値

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

fipSnoopingVlanSettings がヌルの場合。

fipSnoopingVlanSettings に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションが空の場合。

FIP スヌーピングが変更される VLAN の属するネットワーク要素が FIP スヌーピングをまったくサポートしていない場合。

パラメータ

opContext:動作コンテキスト

fipSnoopingVlanSettings:変更を必要とする FipSnoopingVlanSettings オブジェクトのリスト。

戻り値

void

validateVlansForFipSnooping

指定された InstanceNameId オブジェクトに対応するネットワーク要素それぞれから、指定された ID を持つ各 VLAN オブジェクトを取得し、VLAN オブジェクトが存在する場合は、次の条件をチェックします。条件が 1 つも満たされなかった場合は、ValidationException をスローします。

1. VLAN はプライベート VLAN ではない

2. VLAN は CIN VLAN ではない

3. VLAN は関連する VACL を 1 つも持たない

指定された ID を持つ VLAN オブジェクトがネットワーク要素に存在しない場合、この API は例外をスローしません。

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

neNameIdCol がヌル、または空の場合

vlanIds がヌル、または空の場合

コレクションの要素のいずれかがヌルの場合、または 1 つも有効なネットワーク要素 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

vlanIds:VLAN ID を示す整数のリスト。

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

戻り値

void