Cisco DCNM Web Services API ガイド Release 4.0
PortSecurityApp Service
PortSecurityApp Service
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

PortSecurityApp Service

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 Service

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

PortSecurityApp サービスの概要

ポート セキュリティ機能によって、ポートへのアクセスが許可されたワークステーションの Media Access Control(MAC; メディア アクセス制御)アドレスを制限および識別して、インターフェイスへの入力を制限できます。ポート セキュリティは、スイッチド ネットワーク インターフェイスでのみイネーブルにできます。API のカテゴリは次のとおりです。

Query/Get API ― 永続的データベースからのクエリー データ

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

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

Enable and 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 アドレスの InstanceNameIdof のコレクション

bindStaticSecureHostsToPvlanPromiscousNetworkInterface

ホストのコレクションを、無差別モードで動作するスイッチド ネットワーク インターフェイスに静的に割り当てます。

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

interfaceNameId がヌルの場合

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

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

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

戻り値

セキュアな MAC アドレスの InstanceNameIdof のコレクション

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 サイズが 1 より大きい場合

パラメータ

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 サービスをディセーブルにします。サービスのイネーブル化/ディセーブル化は、DC OS プラットフォームでサポートされます。Catalyst 6500 シリーズ スイッチのネットワーク要素でこのAPI を呼び出した場合、FeatureException がスローされます。

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

neInstanceNameIdCol がヌルの場合

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

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

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

void

disablePortSecurityStopLearning

InstanceNameId ネットワーク要素の PortSecurity Stop Learning をディセーブルにします。
Stop Learning のイネーブル化/ディセーブル化は、DC OS プラットフォームでサポートされます。Catalyst 6500 シリーズ スイッチのネットワーク要素を使用して、このAPI を呼び出した場合、FeatureException がスローされます。

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

neInstanceNameIdCol がヌルの場合

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

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

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

void

enablePortSecurityInNetworkInterfaces

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

ポート セキュリティがディセーブルのスイッチド ネットワーク インターフェイス

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

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

interfaceName がヌルの場合

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

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

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

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

enablePortSecurityService

InstanceNameId ネットワーク要素の PortSecurity サービスをイネーブルにします。サービスのイネーブル化/ディセーブル化は、DC OS プラットフォームでサポートされます。Catalyst 6500 シリーズ スイッチのネットワーク要素を使用して、このAPI を呼び出した場合、FeatureException がスローされます。

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

neInstanceNameIdCol がヌルの場合

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

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

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

void

enablePortSecurityStopLearning

InstanceNameId ネットワーク要素の PortSecurity Stop Learning をイネーブルにします。Stop Learning のイネーブル化/ディセーブル化は、DC OS プラットフォームでサポートされます。Catalyst 6500 シリーズ スイッチのネットワーク要素を使用して、このAPI を呼び出した場合、FeatureException がスローされます。

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

neInstanceNameIdCol がヌルの場合

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

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

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

void

getAllDynamicSecureMacAddressesInNetworkInterface

スイッチド ネットワーク インターフェイス内のすべての VLAN(仮想 LAN)で動的に学習されたホスト Media Access Control(MAC; メディア アクセス制御)アドレスをすべて戻します。トランク ポートの場合、すべての VLAN を介してポートにバインドされた MAC アドレスは戻されます。アクセス ポートの場合、アクセス VLAN にバインドされた MAC アドレスは戻されます。

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

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

void

getAllDynamicSecureMacAddressesInVlanOfNetworkInterface

スイッチド ネットワーク インターフェイス内の 1 つの VLAN(仮想 LAN)で動的に学習されたホスト Media Access Control(MAC; メディア アクセス制御)アドレスをすべて戻します。

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

interfaceNameId がヌルの場合

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

vlanId がヌルの場合

niId が有効な VLAN InstanceNameId でない場合

パラメータ

opContext ― 動作可能なコンテキスト

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

vlanId ― VLAN の InstanceNameId

戻り値

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

getAllDynamicSecureMacAddressesInVlanOfNetworkInterfaceByVlanId

スイッチド ネットワーク インターフェイス内の複数の VLAN(仮想 LAN)で動的に学習されたホスト Media Access Control(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(仮想 LAN)に静的にバインドされたホスト Media Access Control(MAC; メディア アクセス制御)アドレスをすべて戻します。トランク ポートの場合、すべての VLAN を介してポートにバインドされた MAC アドレスは戻されます。アクセス ポートの場合、アクセス VLAN にバインドされた MAC アドレスは戻されます。

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

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

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

getAllStaticSecureMacAddressesInVlanOfNetworkInterface

スイッチド ネットワーク インターフェイス内の 1 つの VLAN(仮想 LAN)に静的にバインドされたホスト Media Access Control(MAC; メディア アクセス制御)アドレスをすべて戻します。このメソッドは、作成された VLAN 内のスタティック セキュア MAC アドレスを取得します。

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

interfaceNameId がヌルの場合

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

vlanId がヌルの場合

niId が有効な VLAN InstanceNameId でない場合

パラメータ

opContext ― 動作可能なコンテキスト

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

vlanId ― VLAN の InstanceNameId

戻り値

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

getAllStaticSecureMacAddressesInVlanOfNetworkInterfaceByVlanId

スイッチド ネットワーク インターフェイス内の 1 つの VLAN(仮想 LAN)に静的にバインドされたホスト Media Access Control(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 Stop Learning のステートを戻します。ネットワーク要素のインスタンス名 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(仮想 LAN)のコレクションにバインドされたホストをすべてクリアします。このメソッドは、作成されていない VLAN(事前プロビジョニング)内のセキュア ダイナミック Media Access Control(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