Cisco DCNM Web サービス API ガイド リリース 5.1(1a)

IpSourceGuardApp サービス

---

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

IpSourceGuardApp サービスについて

この章では、IP ソース ガード サービス機能が公開している API について詳しく説明します。

addIpSourceBindings

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

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

• ipSourceBindingobject に abstractNetworkElementRef の値が含まれない場合。

• ipSourceBinding オブジェクトの abstractNetworkElementRef で指定されている AbstractNetworkElement がデータベースに存在しない場合。

• ipSourceBinding オブジェクトに networkInterfaceRef の値が含まれない場合。

• ipSourceBindingobject の networkInterfaceRef で指定されている NetworkInterface がデータベースに存在しない場合。

• ipSourceBinding オブジェクトに vlanRef の値が含まれない場合。

• ipSourceBinding オブジェクトの vlanRef で指定されている（@link com.cisco.dcbu.dcm.model.VLAN.VlanExternal）がデータベースに存在しない場合。

ipSourceBinding オブジェクトがすでに存在している場合、IntegrityException がスローされます。

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

• ipSourceBindingobject のアトリビュートが有効ではない場合。

• ipSourceBinding オブジェクトに対し指定されているリース有効期限が期限切れになった場合。

パラメータ

ipSourceBindings：IpSourceBinding タイプのオブジェクトのコレクション。このオブジェクトは、デバイスの IP ソース バインディング テーブル内のエントリを表します。

戻り値

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

deleteAllIpSourceBindingsInInterfaces

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

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

• 渡された引数 interfaceInstanceNameId が有効なインターフェイス インスタンス名 ID ではない場合。

• インターフェイスに、インターフェイスに関連付けられているスタティック IP ソース バインディングが含まれない場合。

パラメータ

interfaceInstanceNameIds：スタティック バインディング エントリを削除するインターフェイスの InstanceNameId のコレクション。

戻り値

void

deleteAllIpSourceBindingsInNetworkElements

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

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

• 渡された引数 neInstanceNameId がネットワーク要素の有効なインスタンス名 ID ではない場合。

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

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

パラメータ

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

戻り値

void

deleteAllIpSourceBindingsInVlanOfAnInterface

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

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

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

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

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

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

• VLAN に、VLAN に関連付けられている IpSourceBinding が含まれない場合。

パラメータ

opContext：動作コンテキスト

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

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

戻り値

void

deleteIpSourceBindings

IP ソース バインディング テーブルからスタティック バインディング エントリを削除します。IP ソース バインディングの InstanceNameId。

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

• ipSourceBindingInstanceNameId がヌルの場合、または IP ソース バインディングの有効なインスタンス名 ID ではない場合。

• IP ソース バインディングがデータベースに存在しない場合。

パラメータ

ipSourceBindingInstanceNameIds：削除する IP ソース バインディングの InstanceNameId のコレクション。

戻り値

void

disableIpSourceGuardInNetworkElement

ネットワーク要素のインスタンス名 ID を指定すると、ネットワーク要素のすべてのインターフェイスの IP ソース ガードをディセーブルにします。

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

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

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

パラメータ

opContext：動作コンテキスト

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

戻り値

void

disableIpSourceGuardOnInterfaces

指定したコレクション内のインターフェイスの IP ソース ガードをディセーブルにします。

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

• 渡された引数がヌルの場合、またはスイッチド ネットワーク インターフェイスの有効な InstanceNameId ではない場合。

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

パラメータ

opContext：動作コンテキスト

interfaceInstanceNameIds：IP ソース ガードをディセーブルにするインターフェイスの InstanceNameId のコレクション。

戻り値

void

enableIpSourceGuardOnInterfaces

指定したコレクション内のインターフェイスの IP ソース ガードをイネーブルにします。

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

• 渡された引数がヌルの場合、またはスイッチド ネットワーク インターフェイスの有効な InstanceNameId ではない場合。

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

パラメータ

opContext：動作コンテキスト

interfaceInstanceNameIds：IP ソース ガードをイネーブルにするインターフェイスの InstanceNameId のコレクション。

戻り値

void

getInterfacesWithIpSourceBindingsInNetworkElement

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

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

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

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

パラメータ

opContext：動作コンテキスト

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

戻り値

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

• IpSourceBindingassociation。

• com.cisco.dcbu.dcm.model.interfaces.NetworkinterfaceInstanceNameId アソシエーション。

getIpSourceBindings

インスタンス ID に対応する IpSourceBinding オブジェクトを戻します。

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

• 渡された引数がヌルの場合、または IP ソース バインディングの有効な InstanceNameId ではない場合。

• IP ソース バインディングがデータベースに存在しない場合。

パラメータ

ipSourceBindingInstanceNameIds：IP ソース バインディング テーブル内のエントリを表す IpSourceBinding オブジェクトの InstanceNameId のコレクション。

戻り値

IpSourceBinding タイプのオブジェクトのコレクション。戻されるオブジェクトには、次のアソシエーションのみ含まれ、その他のすべてのアソシエーションはクリアされます。

• AbstractNetworkElement アソシエーション。

• NetworkInterface アソシエーション。

• VlanExternal アソシエーション。

getIpSourceBindingsInInterface

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

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

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

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

パラメータ

opContext：動作コンテキスト

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

戻り値

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

• AbstractNetworkElement アソシエーション。

• NetworkInterface アソシエーション。

• VlanExternal アソシエーション。

getIpSourceBindingsInVlanOfAnInterface

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

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

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

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

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

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

パラメータ

opContext：動作コンテキスト

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

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

戻り値

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

• AbstractNetworkElement アソシエーション。

• NetworkInterface アソシエーション。

• VlanExternal アソシエーション。

getIpSourceGuardDisabledInterfacesInNetworkElement

指定したネットワーク要素内の、IP ソース ガードがディセーブルになっているすべてのインターフェイスを戻します。

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

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

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

パラメータ

opContext：動作コンテキスト

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

戻り値

指定したネットワーク要素内の、IP ソース ガードがディセーブルになっている SwitchedNetworkInterface のコレクション。戻されたオブジェクトのリストでは、次のアソシエーションだけが存在し、その他のアソシエーションはクリアされます。

• IP ソース ガード アソシエーション。

• NetworkInterfaceName アソシエーション。

getIpSourceGuardEnabledInterfacesInNetworkElement

指定したネットワーク要素内の、IP ソース ガードがイネーブルになっているすべてのインターフェイスを戻します。

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

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

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

パラメータ

opContext：動作コンテキスト

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

戻り値

指定したネットワーク要素内の、IP ソース ガードがイネーブルになっている SwitchedNetworkInterface のコレクション。戻されるリスト内のオブジェクトには、次のアソシエーションのみ含まれ、その他のアソシエーションクリアされます。

• IP ソース ガード アソシエーション。

• NetworkInterfaceName アソシエーション。

getIpSourceGuardSettingOnInterfaces

指定したインターフェイスに対応する IP ソース ガード設定を戻します。

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

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

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

パラメータ

opContext：動作コンテキスト

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

戻り値

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

getNumberOfDynamicBindingsInVlan

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

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

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

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

パラメータ

opContext：動作コンテキスト

vlanInstanceNameId：VLAN の InstancNameId。

戻り値

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

getNumberOfIpSourceBindingsInInterfaces

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

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

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

パラメータ

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

戻り値

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

getNumberOfIpSourceBindingsInVlans

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

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

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

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

パラメータ

opContext：動作コンテキスト

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

戻り値

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

modifyIpSourceBindings

変更済みのスタティック IP ソース バインディング エントリでサーバをアップデートします。

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

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

• 元の ipSourceBinding がデータベースに存在しない場合。

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

例：

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

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

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

パラメータ

ipSourceBinding：IpSourceBinding タイプの変更済みの IP ソース バインディング エントリのコレクション。

戻り値

void

modifyIpSourceGuardSettings

変更済みの IP ソース ガード設定エントリでサーバをアップデートして、IP ソース ガード設定をイネーブルまたはディセーブルにするか、あるいはデフォルトに設定します。

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

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

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

パラメータ

interfaceInstanceNameIds：IP ソース ガードをディセーブルにするインターフェイスの InstanceNameId のコレクション。

enableState：IpSourceGuard 状態。

戻り値

void