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

目次

PortSecurityApp サービス

PortSecurityApp サービスについて

bindPortSecuritySettingToNetworkInterfaces

bindStaticSecureHostsToAccessNetworkInterface

bindStaticSecureHostsToPvlanHostNetworkInterface

bindStaticSecureHostsToPvlanPromiscousNetworkInterface

bindStaticSecureHostsToVlanInTrunkNetworkInterface

bindStaticSecureHostsToVlanInTrunkNetworkInterfaceByRange

clearPortSecuritySettingToNetworkInterfaces

createPortSecurityNetworkInterfaceSettingForVlans

deletePortSecurityNetworkInterfaceSettingForVlans

disablePortSecurityInAllInterfacesInNetworkElement

disablePortSecurityInNetworkInterfaces

disablePortSecurityService

disablePortSecurityStopLearning

enablePortSecurityInNetworkInterfaces

enablePortSecurityService

enablePortSecurityStopLearning

getAllDynamicSecureMacAddressesInNetworkInterface

getAllDynamicSecureMacAddressesInVlanOfNetworkInterface

getAllDynamicSecureMacAddressesInVlanOfNetworkInterfaceByVlanId

getAllPortSecurityDisabledInterfacesInNetworkElement

getAllPortSecurityEnabledInterfacesInNetworkElement

getAllPortSecurityVlanSettingsForNetworkInterface

getAllStaticSecureMacAddressesInNetworkInterface

getAllStaticSecureMacAddressesInVlanOfNetworkInterface

getAllStaticSecureMacAddressesInVlanOfNetworkInterfaceByVlanId

getPortSecurityCapableInterfaces

getPortSecurityGlobalSettingsInNetworkElements

getPortSecurityServiceStateInNetworkElements

getPortSecuritySettingsInNetworkInterfaces

getPortSecurityStopLearningStateInNetworkElements

getPortSecurityVlanSettingsForNetworkInterface

getPortSecurityVlanSettingsForNetworkInterfaceByRange

modifyPortSecurityGlobalSettings

modifyPortSecuritySettingInNetworkInterfaces

modifyPortSecurityVlanSettingsInNetworkInterface

unbindAllSecureDynamicHostsFromNetworkInterface

unbindAllSecureDynamicHostsFromVlanTrunkInNetworkInterface

unbindAllSecureDynamicHostsFromVlanTrunkInNetworkInterfaceByRange

unbindAllStaticSecureHostsFromNetworkInterface

unbindAllStaticSecureHostsFromVlanInTrunkInNetworkInterface

unbindAllStaticSecureHostsFromVlanInTrunkInNetworkInterfaceByRange

unbindSecureDynamicHostsFromVlanInTrunkNetworkInterface

unbindStaticSecureHostsFromVlanInTrunkNetworkInterface

PortSecurityApp サービス

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

PortSecurityApp サービスについて

ポート セキュリティ機能を使用すると、ポートへのアクセスを許可するワークステーションの MAC アドレスを制限および識別して、インターフェイスへの入力を制限できます。ポート セキュリティは、スイッチド ネットワーク インターフェイスだけイネーブルにできます。API カテゴリは次のとおりです。

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

Modify API:既存のポート セキュリティ パラメータを変更します。

Bind および Unbind API:セキュア MAC アドレスをバインドおよびアンバインドします。

Enable および Disable API:ポート セキュリティをイネーブルおよびディセーブルにします。

bindPortSecuritySettingToNetworkInterfaces

指定された PortSecurityNetworkInterfaceSetting をインターフェイスのコレクションに適用します。このインターフェイスのコレクションでは、ポート セキュリティがイネーブルおよびディセーブルにされたインターフェイスの両方が必要です。

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

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

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

portSecurityNetworkInterfaceSetting がヌルの場合。

パラメータ

opContext:動作コンテキスト

interfaceNameIds:ポート セキュリティ設定を適用する必要があるスイッチド ネットワーク インターフェイスの InstanceNameId のコレクション。

portSecurityNetworkInterfaceSetting:PortSecurityNetworkInterfaceSetting オブジェクト。

戻り値

void

bindStaticSecureHostsToAccessNetworkInterface

アクセス モードで稼動するスイッチド ネットワーク インターフェイスにホストのコレクションをスタティックに適用します。

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

interfaceNameId がヌルの場合。

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

指定 InstanceNameId と同等のスイッチド ネットワーク インターフェイス オブジェクトがない場合。

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

パラメータ

opContext:TODO

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

secureStaticMacAddressCol:インターフェイスにバインドされる SecuredMacAddress のコレクション。

戻り値

セキュア MAC アドレスの InstanceNameId のコレクション。

bindStaticSecureHostsToPvlanHostNetworkInterface

プライベート VLAN ホスト モードで稼動するスイッチド ネットワーク インターフェイスにホストのコレクションをスタティックに適用します。

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

interfaceNameId がヌルの場合。

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

指定 InstanceNameId と同等のスイッチド ネットワーク インターフェイス オブジェクトがない場合。

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

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

secureStaticMacAddressCol:インターフェイスにバインドされる SecuredMacAddress のコレクション。

戻り値

セキュア MAC アドレスの InstanceNameId のコレクション。

bindStaticSecureHostsToPvlanPromiscousNetworkInterface

プライベート VLAN プロミスキャス モードで稼動するスイッチド ネットワーク インターフェイスにホストのコレクションをスタティックに適用します。

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

interfaceNameId がヌルの場合。

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

指定 InstanceNameId と同等のスイッチド ネットワーク インターフェイス オブジェクトがない場合。

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

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

secureStaticMacAddressCol:インターフェイスにバインドされる SecuredMacAddress のコレクション。

戻り値

セキュア MAC アドレスの InstanceNameId のコレクション。

bindStaticSecureHostsToVlanInTrunkNetworkInterface

トランク モードで稼動するスイッチド ネットワーク インターフェイスにホストのコレクションをスタティックに適用します。

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

interfaceNameId がヌルの場合。

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

指定 InstanceNameId と同等のスイッチド ネットワーク インターフェイス オブジェクトがない場合。

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

vlanId コレクションにタイプ VlanExternal でないオブジェクトが含まれている場合。

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

パラメータ

opContext:動作コンテキスト

interfaceNameId:トランク モードで稼動するスイッチド ネットワーク インターフェイスの InstanceNameId。

vlanIds:トランク ネットワーク インターフェイスにより伝送される VLAN の InstanceNameId のコレクション。

secureStaticMacAddressCol:インターフェイスにバインドされる SecuredMacAddress のコレクション。

戻り値

セキュア MAC アドレスの InstanceNameId のコレクション。

bindStaticSecureHostsToVlanInTrunkNetworkInterfaceByRange

トランク モードで稼動するスイッチド ネットワーク インターフェイスにホストのコレクションをスタティックに適用します。これは、デバイスに存在しない VLAN をサポートします(事前プロビジョニング)。

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

interfaceNameId がヌルの場合。

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

指定 InstanceNameId と同等のスイッチド ネットワーク インターフェイス オブジェクトがない場合。

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

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

パラメータ

opContext:動作コンテキスト

interfaceNameId:トランク モードで稼動するスイッチド ネットワーク インターフェイスの InstanceNameId。

vlanRange:VLAN の範囲(カンマ区切りおよびハイフンでつないだ VLAN ID を含む)

secureStaticMacAddressCol:インターフェイスにバインドされる SecuredMacAddress のコレクション。

戻り値

セキュア MAC アドレスの InstanceNameId のコレクション。

clearPortSecuritySettingToNetworkInterfaces

インターフェイスのコレクションのポート セキュリティ設定をクリアします。

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

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

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameIds:ポート セキュリティ設定を適用する必要があるスイッチド ネットワーク インターフェイスの InstanceNameId のコレクション。

戻り値

void

createPortSecurityNetworkInterfaceSettingForVlans

新しく作成された PortSecurityNetworkInterfaceSettingForVlan のリストを戻します。この新しく作成されたクラスでは、maxAddress だけが設定されます。

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

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

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

maxAddressList がヌルの場合。

vlanRange のサイズが maxAddressList のサイズと異なる場合。

accessPort の場合は、VLAN サイズが複数ある場合。

パラメータ

opContext:動作コンテキスト

ifInstanceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

vlanRange:VLAN ID のコレクションを表すカンマ区切りまたはハイフンでつないだ文字列。

-

戻り値

新しく作成された PortSecurityNetworkInterfaceSettingForVlan の InstanceNameIds のコレクション。

deletePortSecurityNetworkInterfaceSettingForVlans

VLAN オブジェクトの 1 つまたは複数の標準ポート セキュリティ ネットワーク インターフェイス設定を削除します。PortSecurityNetworkInterfaceSettingForVlan オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。ValidationException は、次のいずれかの状況が発生した場合にスローされます。

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

psSettingForVlanInstanceNameIds に VLAN InstanceNameId の無効なポート セキュリティ ネットワーク インターフェイスまたはヌル値が含まれている場合。

psSettingForVlanInstanceNameIds に、特定の InstanceNameId を持つ同等の PortSecurityNetworkInterfaceSettingForVlan オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

psSettingForVlanInstanceNameIds:PortSecurityNetworkInterfaceSettingForVlan の InstanceNameId。

戻り値

void

disablePortSecurityInAllInterfacesInNetworkElement

ネットワーク要素のすべてのインターフェイスのポート セキュリティをディセーブルにします。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

void

disablePortSecurityInNetworkInterfaces

ポート セキュリティがイネーブルにされているインターフェイスの指定セットのポート セキュリティをディセーブルにします。

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

interfaceName がヌルの場合。

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

指定 InstanceNameId と同等のスイッチド ネットワーク インターフェイス オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

interfaceNames:ポート セキュリティがイネーブルにされるスイッチド ネットワーク インターフェイスの InstanceNameId のコレクション。

戻り値

void

disablePortSecurityService

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

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

32:neInstanceNameIdCol がヌルの場合。

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

34:ネットワーク要素がデータベースにない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

void

disablePortSecurityStopLearning

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

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

38:neInstanceNameIdCol がヌルの場合。

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

40:ネットワーク要素がデータベースにない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

void

enablePortSecurityInNetworkInterfaces

インターフェイスの指定セットのポート セキュリティをイネーブルにします。ポート セキュリティは、次のインターフェイスでイネーブルにできます。

ポート セキュリティがディセーブルにされているスイッチド ネットワーク インターフェイス。

ポート セキュリティ設定がないスイッチド ネットワーク インターフェイス。

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

interfaceName がヌルの場合。

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

指定 InstanceNameId と同等のスイッチド ネットワーク インターフェイス オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

interfaceNames:ポート セキュリティをイネーブルにする必要があるスイッチド ネットワーク インターフェイスの InstanceNameId のコレクション。

戻り値

PortSecurityNetworkInterfaceSetting オブジェクトのコレクション。

enablePortSecurityService

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

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

29:neInstanceNameIdCol がヌルの場合。

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

31:ネットワーク要素がデータベースにない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

void

enablePortSecurityStopLearning

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

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

35:neInstanceNameIdCol がヌルの場合。

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

37:ネットワーク要素がデータベースにない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

void

getAllDynamicSecureMacAddressesInNetworkInterface

スイッチド ネットワーク インターフェイスのすべての VLAN でダイナミックに学習されるすべてのホスト MAC アドレスを戻します。トランク ポートの場合、すべての VLAN を介してポートにバインドされる MAC アドレスが戻されます。アクセス ポートの場合、アクセス VLAN にバインドされる MAC アドレスが戻されます。

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

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

戻り値

void

getAllDynamicSecureMacAddressesInVlanOfNetwork
Interface

スイッチド ネットワーク インターフェイスの VLAN でダイナミックに学習されるすべてのホスト MAC アドレスを戻します。

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

interfaceNameId がヌルの場合。

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

vlanId がヌルの場合。

vlanId が有効な VLAN InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

vlanId:VLAN の InstanceNameId。

戻り値

指定 VLAN にバインドされるホストに関する SecureStaticMacAddress オブジェクトのコレクション。

getAllDynamicSecureMacAddressesInVlanOfNetwork
InterfaceByVlanId

スイッチド ネットワーク インターフェイスの VLAN でダイナミックに学習されるすべてのホスト MAC アドレスを戻します。このメソッドは、作成されていない VLAN のスタティック セキュア MAC アドレスの割り当てにも対応します(事前プロビジョニング)。

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

interfaceNameId がヌルの場合。

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

vlanId がヌルの場合。

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

VLAN:有効な VLAN ID。

戻り値

指定 VLAN にバインドされるホストに関する SecuredDynamicMacAddress オブジェクトのコレクション。

getAllPortSecurityDisabledInterfacesInNetworkElement

指定ネットワーク要素でポート セキュリティがディセーブルにされているすべてのインターフェイスを戻します。ネットワーク要素のインスタンス名 ID を指定すると、スイッチド ネットワーク インターフェイス オブジェクトのコレクションを戻します。次に、ポート セキュリティがディセーブルにされているインターフェイスをチェックする基準を示します。

PortSecurityNetworkInterfaceSetting パラメータが設定されていて、getPortSecurityEnable() メソッドが false を戻す。

PortSecurityNetworkInterfaceSetting パラメータが設定されていないで、PortSecuritySetting サイズのコレクションサイズが 0 を超えている。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

ポート セキュリティがディセーブルにされている SwitchedNetworkInterfaces のコレクション。次のアソシエーションだけが存在します。その他のすべてのアソシエーションはクリアされます。

PortSecurityNetworkInterfaceSetting

NetworkInterfaceName

PortSetting

PortCapablity

NetworkInterfaceStaus

PortStatus

AbstractNetworkElement

RoutedSubNetworkInterface のコレクション

VLAN コレクションに属するスイッチド ネットワーク インターフェイスのコレクション

getAllPortSecurityEnabledInterfacesInNetworkElement

指定ネットワーク要素でポート セキュリティがイネーブルにされているすべてのインターフェイスを戻します。ネットワーク要素のインスタンス名 ID を指定すると、スイッチド ネットワーク インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

ポート セキュリティがイネーブルにされている SwitchedNetworkInterfaces のコレクション。次のアソシエーションだけが存在します。その他のすべてのアソシエーションはクリアされます。

PortSecurityNetworkInterfaceSetting

NetworkInterfaceName

PortSetting

PortCapablity

NetworkInterfaceStaus

PortStatus

AbstractNetworkElement

RoutedSubNetworkInterface のコレクション

VLAN コレクションに属するスイッチド ネットワーク インターフェイスのコレクション

getAllPortSecurityVlanSettingsForNetworkInterface

スイッチド ネットワーク インターフェイスのコレクションの各 VLAN で設定されたポート セキュリティ設定を戻します。トランク ポートの場合、トランクのすべての VLAN のポート セキュリティ設定が戻されます。アクセス ポートの場合、アクセス VLAN ポート セキュリティ設定が戻されます。

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

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

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameIds:スイッチド ネットワーク インターフェイスの InstanceNameIdsInstanceNameId のコレクション。

戻り値

インターフェイスの VLAN に関連する PortSecurityNetworkInterfaceSettingForVlan オブジェクトのコレクション。アクセス ポートの場合、戻されるコレクションのサイズは 1 です。

getAllStaticSecureMacAddressesInNetworkInterface

スイッチド ネットワーク インターフェイスのすべての VLAN にスタティックにバインドされるすべてのホスト MAC アドレスを戻します。トランク ポートの場合、すべての VLAN を介してポートにバインドされる MAC アドレスが戻されます。アクセス ポートの場合、アクセス VLAN にバインドされる MAC アドレスが戻されます。

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

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

戻り値

スイッチド ネットワーク インターフェイスにバインドされるホストに関する SecureStaticMacAddress オブジェクトのコレクション。

getAllStaticSecureMacAddressesInVlanOfNetworkInterface

スイッチド ネットワーク インターフェイスの VLAN にスタティックにバインドされるすべてのホスト MAC アドレスを戻します。このメソッドは、作成されている VLAN のスタティック セキュア MAC アドレスを取得します。

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

interfaceNameId がヌルの場合。

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

vlanId がヌルの場合。

vlanId が有効な VLAN InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

vlanId:VLAN の InstanceNameId。

戻り値

指定 VLAN にバインドされるホストに関する SecureStaticMacAddress オブジェクトのコレクション。

getAllStaticSecureMacAddressesInVlanOfNetworkInterfaceByVlanId

スイッチド ネットワーク インターフェイスの VLAN にスタティックにバインドされるすべてのホスト MAC アドレスを戻します。このメソッドは、作成されていない VLAN のスタティック セキュア MAC アドレスの割り当てに対応します。

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

interfaceNameId がヌルの場合。

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

vlanId がヌルの場合。

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

VLAN:有効な VLAN ID。

戻り値

指定 VLAN にバインドされるホストに関する SecureStaticMacAddress オブジェクトのコレクション。

getPortSecurityCapableInterfaces

指定ネットワーク要素およびスロット番号のすべてのポート セキュリティ対応インターフェイスを戻します。ネットワーク要素およびスロット番号のインスタンス名 ID を指定すると、ポート セキュリティ対応スイッチド ネットワーク インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

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

slotNo:整数で示したスロット番号。

戻り値

ポート セキュリティ対応 SwitchedNetworkInterfaces のコレクション。

getPortSecurityGlobalSettingsInNetworkElements

ネットワーク要素の指定リストで設定されたポート セキュリティ グローバル コンフィギュレーションを戻します。ネットワーク要素のリストには、仮想ネットワーク要素も含まれます。この API は、Nexus 7000 シリーズ スイッチ プラットフォームだけに適用されます。ValidationException は、次のいずれかの状況が発生した場合にスローされます。

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

abstractNetworkElementIds に無効な理論ネットワーク要素 InstanceNameId またはヌル値が含まれている場合。

abstractNetworkElementIds の指定 InstanceNameId と同等の理論ネットワーク要素オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

abstractNetworkElementIds:理論ネットワーク要素の InstanceNameIds のコレクション。

戻り値

理論ネットワーク要素で行われたグローバル ポート セキュリティ設定を表す PortSecurityGlobalSetting オブジェクトのコレクション。

getPortSecurityServiceStateInNetworkElements

PortSecurityService がネットワーク要素のリストでイネーブルまたはディセーブルにされているかなどの PortSecurity サービスの状態を戻します。ネットワーク要素のインスタンス名 ID のリストを指定すると、ブール値の配列を戻します。

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

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

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

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

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

getPortSecuritySettingsInNetworkInterfaces

ネットワーク インターフェイスの指定コレクションで行われたポート セキュリティ設定を戻します。このコレクションでは、ポート セキュリティがイネーブルおよびディセーブルにされたインターフェイスの両方のポート セキュリティ設定が必要です。インターフェイスにポート セキュリティ設定パラメータが含まれない場合、このコレクションはヌルです。

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

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

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameIds:スイッチド ネットワーク インターフェイスの InstanceNameId のコレクション。

戻り値

すべての SwitchedNetworkInterfaces に関連する PortSecurityNetworkInterfaceSetting オブジェクトのコレクション。

getPortSecurityStopLearningStateInNetworkElements

PortSecurityStopLearning がネットワーク要素のリストでイネーブルまたはディセーブルにされているかなどの PortSecurity ストップ ラーニング状態を戻します。ネットワーク要素のインスタンス名 ID のリストを指定すると、ブール値の配列を戻します。

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

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

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

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

パラメータ

opContext:動作コンテキスト

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

戻り値

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

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

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

getPortSecurityVlanSettingsForNetworkInterface

スイッチド ネットワーク インターフェイスの VLAN の指定コレクションで設定されるポート セキュリティ設定を戻します。このオブジェクトには、常に SecuredMacAddress オブジェクトおよび SecuredDynamicMacAddress オブジェクトのコレクションが含まれます。

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

interfaceNameId がヌルの場合。

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

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

interfaceNameIds に無効な VLAN InstanceNameId またはヌル値が含まれている場合。

vlanIds の指定 InstanceNameId と同等の VLAN がない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

vlanIds:トランクのメンバーである VLAN の InstanceNameId のコレクション。アクセス ポートの場合、このコレクションには、アクセス VLAN の InstanceNameId だけが含まれます。

戻り値

インターフェイスの指定 VLAN に関連する PortSecurityNetworkInterfaceSettingForVlan オブジェクトのコレクション。アクセス ポートの場合、戻されるコレクションのサイズは 1 です。

getPortSecurityVlanSettingsForNetworkInterfaceByRange

vlanRange で表される VLAN の指定コレクションで設定されるポート セキュリティ設定を戻します(事前プロビジョニング)。このオブジェクトには、常に SecuredMacAddress オブジェクトおよび SecuredDynamicMacAddress オブジェクトのコレクションが含まれます。

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

interfaceNameId がヌルの場合。

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

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

パラメータ

opContext:動作コンテキスト

interfaceNameId:スイッチド ネットワーク インターフェイスの InstanceNameId。

vlanRange:VLAN の範囲(カンマ区切りおよびハイフンでつないだ VLAN ID を含む)

戻り値

インターフェイスの VLAN に関連する PortSecurityNetworkInterfaceSettingForVlan オブジェクトのコレクション。アクセス ポートの場合、戻されるコレクションのサイズは 1 です。

modifyPortSecurityGlobalSettings

ネットワーク要素に適用されるポート セキュリティ グローバル設定の指定リストを更新します。この API は、Nexus 7000 シリーズ スイッチ プラットフォームに固有です。

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

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

portSecurityGlobalSetting コレクションにタイプ PortSecurityGlobalSetting でないオブジェクトが含まれている場合。

パラメータ

opContext:動作コンテキスト

portSecurityGlobalSettings:PortSecurityGlobalSetting オブジェクトのコレクション。networkElementIds

戻り値

void

modifyPortSecuritySettingInNetworkInterfaces

変更された PortSecurityNetworkInterfaceSetting オブジェクトのコレクションでサーバを更新します。

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

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

portSecurityNetworkInterfaceSetting コレクションにタイプ PortSecurityNetworkInterfaceSetting でないオブジェクトが含まれている場合。

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

portSecurityNetworkInterfaceSetting コレクションで、PortSecurityNetworkInterfaceSetting の任意のアトリビュートが有効ではない場合。

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

portSecurityNetworkInterfaceSetting コレクションにデータベースに存在しない PortSecurityNetworkInterfaceSetting が含まれている場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

void

modifyPortSecurityVlanSettingsInNetworkInterface

変更された PortSecurityNetworkInterfaceSettingForVlan オブジェクトのコレクションでサーバを更新します。

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

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

portSecurityVlanSetting コレクションにタイプ PortSecurityNetworkInterfaceSettingForVlan でないオブジェクトが含まれている場合。

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

portSecurityVlanSetting コレクションで、PortSecurityNetworkInterfaceSettingForVlan の任意のアトリビュートが有効ではない場合。

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

portSecurityVlanSetting コレクションにデータベースに存在しない PortSecurityNetworkInterfaceSettingForVlan が含まれている場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

void

unbindAllSecureDynamicHostsFromNetworkInterface

ネットワーク インターフェイスでダイナミックに学習されたすべてのホストをクリアします。アクセス ポートの場合、このメソッドは、アクセス VLAN でダイナミックに学習されるすべてのホストをアンバインドします。トランク ポートの場合、このメソッドは、トランクのすべての VLAN でダイナミックに学習されるすべてのホストをアンバインドします。

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

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

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameIds:スタティック セキュア ホストがクリアされるインスタンス インターフェイスの InstanceNameId のコレクション。

戻り値

void

unbindAllSecureDynamicHostsFromVlanTrunkInNetworkInterface

トランク ネットワーク インターフェイスの VLAN のコレクションでダイナミックに学習されたすべてのホストをクリアします。

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

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

interfaceNameId に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

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

vlanId コレクションにタイプ VlanExternal でないオブジェクトが含まれている場合。

パラメータ

opContext:動作コンテキスト

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

vlanIds:VLAN の InstanceNameIds のコレクション。

戻り値

void

unbindAllSecureDynamicHostsFromVlanTrunkInNetworkInterfaceByRange

トランク ネットワーク インターフェイスで許可される VLAN のコレクションにバインドされるすべてのホストをクリアします。このメソッドは、このメソッドは、作成されていない VLAN のダイナミック セキュア MAC アドレスのクリアにも対応します(事前プロビジョニング)。

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

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

interfaceNameId に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

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

パラメータ

opContext:動作コンテキスト

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

vlanRange:VLAN ID のコレクションを表すカンマ区切りまたはハイフンでつないだ文字列。

戻り値

void

unbindAllStaticSecureHostsFromNetworkInterface

ネットワーク インターフェイスにバインドされるすべてのスタティック セキュア ホストをクリアします。アクセス ポートの場合、このメソッドは、アクセス VLAN にバインドされるすべてのホストをクリアします。トランク ポートの場合、このメソッドは、トランクのすべての VLAN にバインドされるホストをクリアします。

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

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

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameIds:スタティック セキュア ホストがクリアされるインスタンス インターフェイスの InstanceNameId のコレクション。

戻り値

void

unbindAllStaticSecureHostsFromVlanInTrunkInNetworkInterface

トランク ネットワーク インターフェイスの VLAN のコレクションにバインドされるすべてのホストをクリアします。

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

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

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

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

vlanIds コレクションにタイプ VlanExternal でないオブジェクトが含まれている場合。

パラメータ

opContext:動作コンテキスト

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

vlanIds:VLAN の InstanceNameIds のコレクション。

戻り値

void

unbindAllStaticSecureHostsFromVlanInTrunkInNetworkInterfaceByRange

トランク ネットワーク インターフェイスで許可される VLAN のコレクションにバインドされるすべてのホストをクリアします。これは、存在しない VLAN に対応するときにも使用されます(事前プロビジョニング)。

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

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

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

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

パラメータ

opContext:動作コンテキスト

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

vlanRange:VLAN ID のコレクションを表すカンマ区切りまたはハイフンでつないだ文字列。

戻り値

void

unbindSecureDynamicHostsFromVlanInTrunkNetworkInterface

トランク ネットワーク インターフェイスの VLAN でダイナミックに学習されるホストのコレクションをクリアします。

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

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

パラメータ

opContext:動作コンテキスト

secureDynamicMacAddressCol:インターフェイスにバインドされる SecuredDynamicMacAddress のコレクション。

戻り値

void

unbindStaticSecureHostsFromVlanInTrunkNetworkInterface

トランク ネットワーク インターフェイスにバインドされるホストのコレクションをクリアします。

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

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

パラメータ

opContext:動作コンテキスト

secureHostInstanceNameIdCol:インターフェイスにバインドされる SecureStaticMacAddress の InstanceNameId のコレクション

戻り値

void