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

目次

DhcpSnoopingApp サービス

DhcpSnoopingApp サービスについて

addStaticBindings

clearRateLimitingConfigurationInInterfaces

deleteAllBindings

deleteAllBindingsInNetworkElements

deleteAllDynamicBindingsInInterfaces

deleteAllDynamicBindingsInNetworkElements

deleteAllDynamicBindingsInVlanOfAnInterface

deleteAllStaticBindingsInInterfaces

deleteAllStaticBindingsInNetworkElements

deleteAllStaticBindingsInVlanOfAnInterface

deleteDynamicBindings

deleteStaticAndDynamicBindings

deleteStaticBindings

disableDhcpSnoopingInNetworkElement

disableDhcpSnoopingOnVlans

disableDhcpSnoopingService

enableDhcpSnoopingOnVlans

enableDhcpSnoopingOnVlansByRange

enableDhcpSnoopingService

getDhcpSnoopingDisabledVlansInNetworkElement

getDhcpSnoopingEnabledVlansInNetworkElement

getDhcpSnoopingGlobalSettingOnNetworkElements

getDhcpSnoopingServiceStateInNetworkElements

getDhcpSnoopingSettingOnVlans

getDynamicBindingsInInterface

getInterfacesWithDhcpRateLimitingInNetworkElement

getInterfacesWithDynamicBindingsInNetworkElement

getInterfacesWithStaticBindingsInNetworkElement

getNumberOfDynamicBindingsInVlans

getNumberOfStaticBindingsInVlans

getStaticBindingsInInterface

getStaticBindingsInVlanOfAnInterface

getStaticDhcpSnoopingBindings

getTrustStateSettingOnInterfaces

getUntrustedInterfacesWithDefaultRateLimitInNetworkElement

getVlansWithDhcpSnoopingInNetworkElement

modifyDhcpSnoopingGlobalSetting

modifyStaticBindings

modifyTrustStateSettings

DhcpSnoopingApp サービス

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

DhcpSnoopingApp サービスについて

この章では、DHCP スヌーピング機能のサービスによって公開される API を定義します。

addStaticBindings

スタティック バインディング エントリ オブジェクトのリストを指定すると、スタティック バインディング エントリを作成します。

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

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

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

dhcpSnoopingBindings のコレクションにある DhcpSnoopingBinding に abstractNetworkElementRef の値が含まれない場合。

コレクション dhcpSnoopingBindings にある任意の DhcpSnoopingBinding オブジェクト内の abstractNetworkElementRef によって指定された AbstractNetworkElement がデータベースに存在しない場合。

dhcpSnoopingBindings のコレクションの DhcpSnoopingBinding に networkInterfaceRef の値が含まれない場合。

コレクション dhcpSnoopingBindings にある任意の DhcpSnoopingBinding オブジェクト内の networkInterfaceRef によって指定された NetworkInterface がデータベースに存在しない場合。

dhcpSnoopingBindings の DhcpSnoopingBinding に vlanRef の値が含まれない場合。

コレクション dhcpSnoopingBindings にある任意の DhcpSnoopingBinding オブジェクト内の vlanRef によって指定された (@link com.cisco.dcbu.dcm.model.VLAN.VlanExternal) がデータベースに存在しない場合。

dhcpSnoopingBindings のコレクションに任意の DhcpSnoopingBinding オブジェクトがすでに存在している場合、IntegrityException がスローされます。

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

コレクション dhcpSnoopingBindings に、DhcpSnoopingBinding オブジェクトの有効なアトリビュートがない場合。

dhcpSnoopingBindings のコレクションにある任意の DhcpSnoopingBinding オブジェクトに指定されたリース有効期限が期限切れになった場合。

パラメータ

opContext:動作コンテキスト

dhcpSnoopingBindings:タイプ DhcpSnoopingBinding のオブジェクトを持つコレクション。各オブジェクトは、デバイス内の DHCP スヌーピング バインディング テーブルのエントリを表します。

戻り値

新しいバインディング エントリの InstanceNameId のコレクション。

clearRateLimitingConfigurationInInterfaces

信頼されないインターフェイスのコレクション内で行われる DHCP レート制限設定をクリアします。また、この API は DHCP レート制限をデフォルト値に戻します。

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

渡された引数がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

コレクション interfaceNameIds の InstanceNameId によって指定されたインターフェイスがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameIds:インターフェイスの InstanceNameId のコレクション。

戻り値

void

deleteAllBindings

インターフェイスの InstanceNameId を指定すると、特定のインターフェイスのすべての VLAN に設定されているスタティック エントリとダイナミック エントリの両方を削除します。

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

渡された引数がヌルであるか、または有効なインターフェイス インスタンス名 ID ではない場合。

インターフェイスがデータベースに存在しない場合。

インターフェイスに、関連付けられた DhcpSnoopingBinding が含まれていない場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameIds:バインディングを削除するインターフェイスの InstanceNameId のコレクション。

戻り値

void

deleteAllBindingsInNetworkElements

ネットワーク要素の InstanceNameId を指定すると、ネットワーク要素に設定されているスタティック エントリとダイナミック エントリの両方を削除します。

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

渡された引数がヌルであるか、または有効なネットワーク要素インスタンス名 ID ではない場合。

ネットワーク要素がデータベースに存在しない場合。

ネットワーク要素に、関連付けられた DhcpSnoopingBinding が含まれない場合。

パラメータ

opContext:動作コンテキスト

networkElementIds:バインディングを削除するネットワーク要素の InstanceNameId のコレクション。

戻り値

void

deleteAllDynamicBindingsInInterfaces

インターフェイスの InstanceNameId を指定すると、バインディング テーブル内のインターフェイスのコレクションに対応するすべての動的に学習されたエントリを削除します。

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

渡された引数がヌルであるか、または有効なインターフェイス インスタンス名 ID ではない場合。

インターフェイスがデータベースに存在しない場合。

関連付けられた DhcpSnoopingBinding がインターフェイスに含まれない場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameIds:バインディングを削除するインターフェイスの InstanceNameId のコレクション。

戻り値

void

deleteAllDynamicBindingsInNetworkElements

ネットワーク要素の InstanceNameId を指定すると、ネットワーク要素の特定のコレクション内のすべてのダイナミック バインディング エントリを削除します。

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

渡された引数がヌルであるか、または有効なネットワーク要素インスタンス名 ID ではない場合。

ネットワーク要素がデータベースに存在しない場合。

ネットワーク要素に、関連付けられた DhcpSnoopingBinding が含まれない場合。

パラメータ

opContext:動作コンテキスト

networkElementIds:バインディングを削除するネットワーク要素の InstanceNameId のコレクション。

戻り値

void

deleteAllDynamicBindingsInVlanOfAnInterface

インターフェイスと VLAN の InstanceNameId を指定すると、インターフェイス内の特定の VLAN に設定されているすべてのダイナミック バインディング エントリを削除します。

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

渡された interfaceInstanceNameId 引数がヌルであるか、または有効なインターフェイス インスタンス名 ID ではない場合。

インターフェイスがデータベースに存在しない場合。

渡された vlanInstanceNameId 引数がヌルであるか、または有効な VLAN インスタンス名 ID ではない場合。

VLAN がデータベースに存在しない場合。

関連付けられた DhcpSnoopingBinding が VLAN に含まれない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameId:バインディングを削除する VLAN の InstanceNameId。

interfaceInstanceNameIds:特定の VLAN でバインディングを削除するインターフェイスの InstanceNameId のコレクション。

戻り値

void

deleteAllStaticBindingsInInterfaces

インターフェイスの InstanceNameId を指定すると、インターフェイスの特定のコレクションに設定されているすべてのスタティック バインディング エントリを削除します。

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

渡された引数がヌルであるか、または有効なインターフェイス インスタンス名 ID ではない場合。

インターフェイスがデータベースに存在しない場合。

関連付けられた DhcpSnoopingBinding がインターフェイスに含まれない場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameIds:バインディングを削除するインターフェイスの InstanceNameId のコレクション。

戻り値

void

deleteAllStaticBindingsInNetworkElements

ネットワーク要素の InstanceNameId を指定すると、ネットワーク要素の特定のコレクション内のすべてのスタティック バインディング エントリを削除します。

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

渡された引数がヌルであるか、または有効なネットワーク要素インスタンス名 ID ではない場合。

ネットワーク要素がデータベースに存在しない場合。

ネットワーク要素に、関連付けられた DhcpSnoopingBinding が含まれない場合。

パラメータ

opContext:動作コンテキスト

networkElementIds:バインディングを削除するネットワーク要素の InstanceNameId のコレクション。

戻り値

void

deleteAllStaticBindingsInVlanOfAnInterface

インターフェイスおよび VLAN の InstanceNameId を指定すると、インターフェイス内の特定の VLAN に設定されているすべてのスタティック バインディング エントリを削除します。

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

引数 interfaceInstanceNameId がヌルの場合、または有効なインターフェイス インスタンス名 ID ではない場合。

インターフェイスがデータベースに存在しない場合。

引数 vlanInstanceNameId がヌルの場合、または有効な VLAN インスタンス名 ID ではない場合。

VLAN がデータベースに存在しない場合。

関連付けられた DhcpSnoopingBinding が VLAN に含まれない場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameId:特定の VLAN でバインディングを削除するインターフェイスの InstanceNameId。

vlanInstanceNameId:バインディングを削除する VLAN の InstanceNameId。

戻り値

void

deleteDynamicBindings

DHCP スヌーピング バインディングの InstanceNameId を指定すると、バインディング テーブル内の動的に学習されたエントリを削除します。

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

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

コレクション dhcpSnoopingBindings 内のいずれかの要素がヌルであるか、または有効な DHCP スヌーピング バインディング インスタンス名 ID ではない場合。

DHCP スヌーピング バインディングがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

dhcpSnoopingBindings:削除する DHCP スヌーピング バインディングの InstanceNameId のコレクション。

戻り値

void

deleteStaticAndDynamicBindings

インターフェイスと VLAN の InstanceNameId を指定すると、インターフェイス内の特定の VLAN に設定されているスタティック エントリとダイナミック エントリの両方を削除します。

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

渡された interfaceInstanceNameId 引数がヌルであるか、または有効なインターフェイス インスタンス名 ID ではない場合。

インターフェイスがデータベースに存在しない場合。

渡された interfaceInstanceNameId 引数がヌルであるか、または有効な VLAN インスタンス名 ID ではない場合。

VLAN がデータベースに存在しない場合。

関連付けられた DhcpSnoopingBinding が VLAN に含まれない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameId:バインディングを削除する VLAN の InstanceNameId。

interfaceInstanceNameIds:特定の VLAN でバインディングを削除するインターフェイスの InstanceNameId のコレクション。

戻り値

void

deleteStaticBindings

DHCP スヌーピング バインディングの InstanceNameId を指定すると、DHCP スヌーピング バインディング テーブルからスタティック バインディング エントリを削除します。

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

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

コレクション dhcpSnoopingBindings 内のいずれかの要素がヌルであるか、または有効な DHCP スヌーピング バインディング インスタンス名 ID ではない場合。

DHCP スヌーピング バインディングがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

dhcpSnoopingBindings:削除する DHCP スヌーピング バインディングの InstanceNameId のコレクション。

戻り値

void

disableDhcpSnoopingInNetworkElement

インスタンス名 ID を指定すると、ネットワーク要素の DHCP スヌーピングをディセーブルにします。

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

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

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:DHCP スヌーピングをディセーブルにするネットワーク要素の InstanceNameId。

戻り値

void

disableDhcpSnoopingOnVlans

VLAN の InstanceNameId のリストを指定すると、VLAN の DHCP スヌーピングをディセーブルにします。

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

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

VLAN がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameId:DHCP スヌーピングをディセーブルにする VlanExternal の InstanceNameId のリスト。

戻り値

void

disableDhcpSnoopingService

InstanceNameId ネットワーク要素の DHCP スヌーピング サービスをディセーブルにします。サービスのイネーブル化とディセーブル化は、NX-OS プラットフォームでサポートされています。この API が Catalyst 6500 シリーズ スイッチのネットワーク要素によって呼び出されると、FeatureException がスローされます。

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

neInstanceNameIdCol がヌルの場合。

neInstanceNameIdCol に有効なネットワーク要素 InstanceNameId が含まれていない場合。

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

void

enableDhcpSnoopingOnVlans

VLAN の InstanceNameId のリストを指定すると、VLAN の DHCP スヌーピングをイネーブルにします。

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

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

VLAN がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameIds:DHCP スヌーピングをイネーブルにする VlanExternals の InstanceNameId のリスト。

戻り値

void

enableDhcpSnoopingOnVlansByRange

事前にプロビジョニングされた VLAN で DHCP スヌーピングをイネーブルにします。VLAN ID を使用するだけで DHCP スヌーピングをイネーブルにできます。DHCP スヌーピングをイネーブルにする必要がある VLAN が実際にデバイスに存在している必要はありません。この API は、この事前プロビジョニング設定を指定します。

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

neInstanceNameId がヌルの場合。

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

ネットワーク要素がデータベースに存在しない場合。

引数 vlanRange がヌルの場合。

パラメータ

opContext:動作コンテキスト

vlanRange:VLAN の範囲を表す文字列。この文字列の内容は、カンマ区切りおよびハイフンでつないだ VLAN のリストです。たとえば、vlanRange は 4,6,9,15-20,25 です。

戻り値

void

enableDhcpSnoopingService

InstanceNameId ネットワーク要素の DHCP スヌーピング サービスをイネーブルにします。サービスのイネーブル化とディセーブル化は、NX-OS プラットフォームでサポートされています。この API が Catalyst 6500 シリーズ スイッチのネットワーク要素によって呼び出されると、FeatureException がスローされます。

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

neInstanceNameIdCol がヌルの場合。

neInstanceNameIdCol に有効なネットワーク要素 InstanceNameId が含まれていない場合。

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

void

getDhcpSnoopingDisabledVlansInNetworkElement

ネットワーク要素の InstanceNameId を指定すると、特定のネットワーク要素内の DHCP スヌーピングがディセーブルになっている VLAN のコレクションを戻します。

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

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

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

DHCP スヌーピングがディセーブルになっている VlanExternal オブジェクトのリスト。戻されたリストでは、DhcpSnoopingSetting とのアソシエーションだけが存在し、他のアソシエーションはクリアされます。

getDhcpSnoopingEnabledVlansInNetworkElement

ネットワーク要素の InstanceNameId を指定すると、特定のネットワーク要素内の DHCP スヌーピングがイネーブルになっている VLAN のコレクションを戻します。

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

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

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

DHCP スヌーピングがイネーブルになっている VlanExternal オブジェクトのリスト。戻されたリストでは、DhcpSnoopingSetting とのアソシエーションだけが存在し、他のアソシエーションはクリアされます。

getDhcpSnoopingGlobalSettingOnNetworkElements

ネットワーク要素の InstanceNameId を指定すると、DHCP スヌーピング グローバル設定のコレクションを戻します。

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

渡された引数がヌルか空であるか、またはコレクション内のいずれかの要素が有効なネットワーク要素 InstanceNameId ではない場合。

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

ネットワーク要素の DhcpSnoopingGlobalSetting オブジェクトのコレクション。

getDhcpSnoopingServiceStateInNetworkElements

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

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

渡された引数がヌルの場合

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

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

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

getDhcpSnoopingSettingOnVlans

VLAN の InstanceNameId のリストを指定すると、VLAN に関連付けられた DHCP スヌーピング設定を戻します。

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

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

VLAN がデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameIds:DHCP スヌーピング設定を照会する VLAN の InstanceNameId のリスト。

戻り値

DhcpSnoopingSetting オブジェクトのリスト。戻されたリストには、VLAN の特定のリストに関連する DhcpSnoopingSetting オブジェクトが含まれます。

getDynamicBindingsInInterface

インターフェイスの InstanceNameId を指定すると、インターフェイス内で学習されるダイナミック バインディングを戻します。

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

渡された引数がヌルの場合、または有効なインターフェイス InstanceNameId ではない場合。

インターフェイスがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

特定のインターフェイスに設定されているスタティック バインディングのコレクション。戻されたコレクションには、タイプ DhcpSnoopingBinding のオブジェクトが含まれます。戻されたオブジェクトのリストでは、次のアソシエーションだけが存在し、その他のアソシエーションはクリアされます。

AbstractNetworkElement アソシエーション。

NetworkInterface アソシエーション。

VlanExternal アソシエーション。

getInterfacesWithDhcpRateLimitingInNetworkElement

ネットワーク要素の InstanceNameId を指定すると、DHCP レートが設定されているすべてのインターフェイスを戻します。

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

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

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

DHCP レート制限が設定されているインターフェイス オブジェクトのコレクション。戻されたオブジェクト リストには、次のアソシエーションのみが存在し、その他のアソシエーションはすべてクリアされます。

TrustStateSetting アソシエーション。

NetworkInterfaceName アソシエーション。

getInterfacesWithDynamicBindingsInNetworkElement

ネットワーク要素の InstanceNameId を指定すると、ダイナミック バインディングが設定されているインターフェイスを戻します。ネットワーク要素は、インターフェイスが存在しているデバイスです。

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

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

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

ダイナミック バインディングが学習されるネットワーク要素内のインターフェイスのコレクション。戻されたコレクションには、ダイナミック バインディングが設定されているインターフェイス オブジェクトの InstanceNameIds が含まれます。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

DhcpSnoopingBinding アソシエーション。

NetworkInterfaceName アソシエーション。

getInterfacesWithStaticBindingsInNetworkElement

ネットワーク要素の InstanceNameId を指定すると、スタティック バインディングが設定されているインターフェイスを戻します。ネットワーク要素は、インターフェイスが存在しているデバイスです。

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

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

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

スタティック バインディングが設定されている、ネットワーク要素内のインターフェイスのコレクション。戻されたコレクションには、スタティック バインディングが設定されているインターフェイス オブジェクトの InstanceNameId が含まれます。戻されたリスト内のオブジェクトには、次のアソシエーションのみが存在し、他のすべてのアソシエーションはクリアされます。

DhcpSnoopingBinding アソシエーション。

NetworkInterfaceName アソシエーション。

getNumberOfDynamicBindingsInVlans

VLAN の InstanceNameId を指定すると、VLAN に設定されているダイナミック バインディングの数を戻します。

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

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

VLAN がデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameIds:VLAN の InstanceNameId のコレクション。

戻り値

VLAN に設定されているダイナミック バインディングの数を表す整数値のコレクション。

getNumberOfStaticBindingsInVlans

VLAN の InstanceNameId を指定すると、VLAN のコレクション内に設定されているスタティック バインディングの数を戻します。

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

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

VLAN がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameIds:VLAN の InstanceNameId のコレクション。

戻り値

VLAN に設定されているスタティック バインディングの数を表す整数値のコレクション

getStaticBindingsInInterface

インターフェイスの InstanceNameId を指定すると、インターフェイスに設定されているスタティック バインディングを戻します。

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

渡された引数がヌルの場合、または有効なインターフェイス InstanceNameId ではない場合。

インターフェイスがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameId:インターフェイスの InstanceNameId

戻り値

特定のインターフェイスに設定されているスタティック バインディングのコレクション。戻されたコレクションには、タイプ DhcpSnoopingBinding のオブジェクトが含まれます。戻されたオブジェクトのリストでは、次のアソシエーションだけが存在し、その他のアソシエーションはクリアされます。

AbstractNetworkElement アソシエーション。

NetworkInterface アソシエーション。

VlanExternal アソシエーション。

getStaticBindingsInVlanOfAnInterface

VLAN およびインターフェイスの InstanceNameId を指定すると、インターフェイス内の VLAN に設定されているスタティック バインディングを戻します。

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

渡された引数 interfaceInstanceNameId がヌルの場合、または有効なインターフェイス InstanceNameId ではない場合。

インターフェイスがデータベースに存在しない場合。

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

VLAN がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameId:インターフェイスの InstanceNameId

vlanInstanceNameId:インターフェイスの VLAN の InstanceNameId

戻り値

インターフェイスの特定の VLAN に設定されているスタティック バインディングのコレクション。戻されたコレクションには、タイプ DhcpSnoopingBinding のオブジェクトが含まれます。戻されたオブジェクト リストには、次のアソシエーションのみが存在し、その他のアソシエーションはすべてクリアされます。

AbstractNetworkElement アソシエーション。

NetworkInterface アソシエーション。

VlanExternal アソシエーション。

getStaticDhcpSnoopingBindings

特定の InstanceNameIds に対応する DHCP スヌーピング バインディング オブジェクトのコレクションを戻します。

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

渡された引数がヌルであるか、または有効な DHCP スヌーピング バインディング InstanceNameId ではない場合。

DHCP スヌーピング バインディングがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

dhcpSnoopingBindings:DHCP スヌーピング バインディング テーブル内のエントリを表す DHCP スヌーピング バインディング オブジェクトの InstanceNameId のコレクション。

戻り値

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

AbstractNetworkElement アソシエーション。

NetworkInterface アソシエーション。

VlanExternal アソシエーション。

getTrustStateSettingOnInterfaces

インターフェイスの InstanceNameId を指定すると、レイヤ 2 インターフェイスのコレクションに設定されている DHCP スヌーピング信頼状態設定を戻します。

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

渡された引数がヌルの場合、または有効なインターフェイス InstanceNameId ではない場合。

インターフェイスがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameIds:インターフェイスの InstanceNameId のリスト。

戻り値

特定のインターフェイス TrustStateSetting に対応する TrustStateSetting オブジェクトのコレクション

getUntrustedInterfacesWithDefaultRateLimitInNetworkElement

ネットワーク要素の InstanceNameId を指定すると、ネットワーク要素内で、デフォルトの DHCP レートが設定されているすべての信頼されていないインターフェイスを戻します。

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

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

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

デフォルト DHCP レートが設定されている信頼されていないインターフェイス オブジェクトのコレクション。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

TrustStateSetting アソシエーション。

NetworkInterfaceName アソシエーション。

getVlansWithDhcpSnoopingInNetworkElement

ネットワーク要素の InstanceNameId が指定されると、特定のネットワーク要素内に DHCP スヌーピング設定(DHCP スヌーピングがイネーブルまたはディセーブル)を持つ VLAN のコレクションを戻します。これによって、DHCP スヌーピングがサポートされていない VLAN は戻りません。

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

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

ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

DHCP スヌーピングがイネーブルおよびディセーブルになっている VlanExternal オブジェクトのリスト。戻されたリストでは、DhcpSnoopingSetting とのアソシエーションだけが存在し、他のアソシエーションはクリアされます。

modifyDhcpSnoopingGlobalSetting

DhcpSnoopingGlobalSettings の 1 つまたは複数のアトリビュートを変更します。この API の「dhcpSnoopingServiceEnable」は変更できません。変更された場合、MetadataException がスローされます。DHCP スヌーピング サービス API をイネーブルまたはディセーブルにします。

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

引数 neInstanceNameId がヌルの場合。

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

引数 dhcpSnoopingGlobalSetting がヌルの場合。

dhcpSnoopingGlobalSetting オブジェクト内のいずれかのアトリビュートが無効の場合、PropertiesException がスローされます。

パラメータ

opContext:動作コンテキスト

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

dhcpSnoopingGlobalSetting:データベース内の既存の DhcpSnoopingGlobalSetting オブジェクトに置き換わる、変更した DhcpSnoopingGlobalSetting オブジェクト。

戻り値

void

modifyStaticBindings

データベースに存在する 1 つまたは複数の DHCP スヌーピング バインディング オブジェクトを変更します。

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

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

コレクション dhcpSnoopingBindings にあるいずれかの要素がヌルの場合。

コレクション dhcpSnoopingBindings の要素がタイプ DhcpSnoopingBinding ではない場合。

有効な DhcpSnoopingBinding のアトリビュートがない場合、PropertiesException がスローされます。

例:

IpAddress の値が指定されていない場合。

MacAddress の値が指定されていない場合。

リース有効期限の値が指定されていない場合など。

パラメータ

opContext:動作コンテキスト

dhcpSnoopingBindings:変更された DhcpSnoopingBinding エントリのコレクション。

戻り値

void

modifyTrustStateSettings

インターフェイスの特定のコレクションにある 1 つまたは複数の既存の信頼状態設定を変更します。

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

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

interfaceInstanceNameIds のコレクションにタイプ NetworkInterface ではないオブジェクトが含まれる場合。

TrustStateSetting がそのインターフェイスでサポートされていない場合。タイプ SwitchedNetworkInterface および RoutedNetworkInterface のインターフェイスでのみサポートされます。

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

trustStateSettings のコレクションにタイプ TrustStateSetting ではないオブジェクトが含まれる場合。

interfaceInstanceNameIds のコレクションと trustStateSettings のコレクションのサイズが等しくない場合、IntegrityException がスローされます。

有効な TrustStateSetting のアトリビュートがない場合、PropertiesException がスローされます。

例:TrustStateSetting が設定されているインターフェイスが RoutedNetworkInterface である場合、TrustStateSetting オブジェクト内の TrustState アトリビュートは、信頼される DHCP 信頼状態を持つことはできません。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameIds:インターフェイスの InstanceNameIds のコレクション。

trustStateSetting:変更された TrustStateSetting オブジェクト TrustStateSetting のコレクション

戻り値

void