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

目次

VlanApp サービス

VlanApp サービスについて

addAllowedVlansOnTrunks

addAllowedVlansOnPvlanTrunks

bindAccessPortsToVlan

bindHostPortsToPrivateVlan

bindNativeVlanOnTrunks

bindNativeVlanOnPvlanTrunks

bindPromiscuousPortsToPrivateVlan

bindSecondaryVlansToPrimary

bindSecondaryVlansToVlanNetworkInterface

createPvlanTrunkMapping

createSecondaryVlans

createVlanInNetwork

createVlans

deleteAllowedVlansOnTrunks

deleteAllowedVlansOnPvlanTrunks

deleteFipSnoopingEnabledVlans

deletePvlanTrunkMappings

deleteVlans

deleteVlansInNetwork

disablePrivateVlanService

enablePrivateVlanService

getActivePortsCountInVlans

getInactivePortsCountInVlans

getInternalVlansInNetworkElement

getPortsCountInVlans

getPortsInVlan

getPrivateVlanServiceState

getPrivateVlansInNetworkElement

getSecondaryVlans

getTotalPortCountInVlans

getTrunksForVlan

getVlanGlobalSettings

getVlanIdsInNetwork

getVlanRangeInNetworkElements

getVlanNetworkInterfaces

getVlans

getVlansInNetwork

getVlansInNetworkElement

getVlansWithSecurityAssociations

getVlansWithSpanAssociations

getVtpGlobalSettings

modifyAllowedVlansOnTrunks

modifySecondaryVlansForPromiscuousPorts

modifyVlanGlobalSetting

modifyAccessVlanToNativeVlanOnInterfaces

modifyAllowedVlansOnPvlanTrunks

modifySecondaryVlansForPvlanTrunkMapping

modifyVlanTypeToNormal

modifyVlanTypeToPrimary

modifyVlanTypeToSecondary

modifyVlans

unbindAccessPortsFromVlan

unbindHostPortsFromPrivateVlan

unbindNativeVlanOnTrunks

unbindPromiscuousPortsFromPrivateVlan

unbindSecondaryVlansFromPrimary

unbindSecondaryVlansFromVlanNetworkInterface

unbindNativeVlanOnPvlanTrunks

VlanApp サービス

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

VlanApp サービスについて

VLAN を使用すると、LAN を分割して小規模な論理ブロードキャスト ドメインにすることができます。VLAN 内のデバイスは、他の VLAN と同じ物理 LAN セグメントに接続されている場合であっても、他の VLAN からブロードキャスト パケットを受け取りません。

プライベート VLAN 機能を使用すると、VLAN を分割して、同じサブネットを共有する小規模なブロードキャスト ドメインにすることができます。たとえば、1 つの VLAN を分割して 1 つのプライマリ VLAN と 1 つまたは複数のセカンダリ VLAN にすることができます。

addAllowedVlansOnTrunks

ポート モードにかかわらず、指定されたポートで許可された VLAN として一連の VLAN を追加します。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成し、ポートにバインドします。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

vlanRange に含まれる ID が有効な範囲にない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:許可された VLAN の追加先になるポートの InstanceNameId のリスト。

vlanRange:指定したポートの許可された VLAN として追加する VLAN ID の IntegerRange(例:1-10,20,35,50-120)。

戻り値

void

addAllowedVlansOnPvlanTrunks

ポート モードにかかわらず、指定されたポートで PVLAN トランク許可された VLAN として一連の VLAN を追加します。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成し、ポートにバインドします。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

vlanRange に含まれる ID が有効な範囲にない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIdCo:PVLAN トランク許可された VLAN を追加するポートの InstanceNameId のリスト。

vlanRange:指定したポートの PVLAN トランク許可された VLAN として追加する VLAN ID の IntegerRange。

戻り値

void

bindAccessPortsToVlan

指定されたポートを指定された VLAN にバインドします。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成します。

ポートと VLAN の間の次のアソシエーションが更新されます。

アソシエーション タイプを access とする SwitchedNetworkInterfaceBelongsToVlan

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

vlanId がヌルの場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:指定した VLAN にバインドされている必要のある SwitchedNetworkInterface の InstanceNameId のリスト。

vlanId:指定したアクセス ポートをバインドする必要のある VlanExternalto の整数の VLAN ID。

戻り値

SwitchedNetworkInterfaceBelongsToVlan オブジェクトのリスト。

bindHostPortsToPrivateVlan

PVLAN ホスト ポートをセカンダリ VLAN にバインドします。指定された VLAN が存在しない場合は、未完成の通常の VLANVlanExternal を作成します。

ポートと VLAN の間の次のアソシエーションが更新されます。

プライマリ VLAN についてはアソシエーション タイプを PVLAN_HOST_PRIMARY とし、指定されたセカンダリ VLAN についてはアソシエーション タイプを PVLAN_HOST_SECONDARY とする SwitchedNetworkInterfaceBelongsToVlan が作成されます。

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

portNameIds の要素に対応するオブジェクトが存在しない場合。

指定されたポートがホスト モードではない場合。

secondaryVlanNameId または primaryVlanId がヌルの場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

primaryVlanId:指定したポートにバインドする PrimaryVlan の VLAN ID。

secondaryVlanId:指定したポートにバインドする SecondaryVlan の VLAN ID。

secondaryHostPortNameIdCol:ホスト モードになっている SwitchedNetworkInterfaces の InstanceNameId のリスト。

戻り値

SwitchedNetworkInterfaceBelongsToVlan オブジェクトのリスト。

bindNativeVlanOnTrunks

指定された VLAN を指定されたポートのネイティブ VLAN として設定します。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成し、ポートにバインドします。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

vlanRange に含まれる ID が有効な範囲にない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:SwitchedNetworkInterface ポートの InstanceNameIds のリスト。

vlanId:指定したポートのネイティブ VLAN として設定する VLAN の整数 ID。

戻り値

void

bindNativeVlanOnPvlanTrunks

指定された VLAN を指定されたポートの PVLAN トランク ネイティブ VLAN として設定します。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成し、ポートにバインドします。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

vlanRange に含まれる ID が有効な範囲にない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:SwitchedNetworkInterface ポートの InstanceNameIds のリスト。

vlanId:指定したポートのネイティブ VLAN として設定する VLAN の整数 ID。

戻り値

void

bindPromiscuousPortsToPrivateVlan

指定されたプライマリ VLAN に混合モード ポートをバインドし、作成した混合モード アソシエーションに対する指定されたセカンダリ VLAN のマッピングも行います。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成します。

ポート、プライマリ VLAN、およびセカンダリ VLAN の間で次のアソシエーションが更新されます。

PromiscuousPvlanMapping

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

primaryVlanId がヌルか、PrimaryVlan の InstanceNameId でない、または対応するオブジェクトが存在しない場合。

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

secondaryVlanIds に含まれているいずれかの VLANId が primaryVlanId と重複している場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:SwitchedNetworkInterfaces の InstanceNameId のリスト。

primaryVlanId:指定した混合モード ポートを追加するプライマリ VLAN の整数 VLAN。

secondaryVlanIds:混合モード ポートにマッピングするセカンダリ VLAN ID の IntegerRange(例:1-10,20,35,50-120)。

戻り値

PromiscuousPvlanMappings のリスト。

bindSecondaryVlansToPrimary

指定されたセカンダリ VLAN を指定されたプライマリ VLAN にバインドします。

指定されたセカンダリ VLAN オブジェクトが存在しない場合は、未完了のセカンダリ VLAN オブジェクトを作成してバインドします。

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

primaryVlanNameId がヌルか、プライマリ VLAN の InstanceNameId ではない場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

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

primaryVlanNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

primaryVlanNameId:プライマリ VLAN の InstanceNameId。

secondaryVlanRange:指定したプライマリ VLAN にバインドするセカンダリ VLAN ID の IntegerRange(例:1-10,20,35,50-120)。

戻り値

void

bindSecondaryVlansToVlanNetworkInterface

一連のセカンダリ VLAN を単一の VlanNetworkInterface(SVI)にバインドします。

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

vlanNetworkInterfaceNameId がヌルか、VlanNetworkInterface の有効な InstanceNameId ではない場合。

secondaryVlanId がヌルか、リストが空の場合。

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

vlanNetworkInterfaceNameId に対応する VlanNetworkInterface オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNetworkInterfaceNameId:セカンダリ VLAN をバインドする VlanNetworkInterface の InstanceNameId。

secondaryVlanNameIds:VlanNetworkInterface にバインドするセカンダリ VLAN の InstanceNameId のリスト。

戻り値

void

createPvlanTrunkMapping

任意のレイヤ 2 インターフェイスでプライマリ VLAN とセカンダリ VLAN の間に PVLAN トランク アソシエーションを作成します。指定された VLAN が存在しない場合は、未完成で VlanExternal の通常の VLAN を作成します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

portInstanceNameId がヌルか、タイプ InstanceNameId ではない場合。

portInstanceNameId が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

primaryVlanId がヌルの場合。

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

pvlanTrunkAssociationType がヌルの場合。

secondaryVlanIdRange に含まれているいずれかの VLANId が primaryVlanId と重複している場合。

プライベート VLAN サービスがイネーブルではない場合。

secondaryVlanIdRange に含まれている VLAN ID がアソシエーション PvlanTrunkAssociationType.SECONDARY に対応する複数の ID の場合。

指定した VLAN がアソシエーション PvlanTrunkAssociationType.SECONDARY のタイプ Community の場合。

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

portInstanceNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portInstanceNameId:SwitchedNetworkInterface ポートの InstanceNameId

primaryVlanId:レイヤ 2 インターフェイスにマッピングするプライマリ VLAN の整数 VLAN ID

secondaryVlanIdRange:レイヤ 2 インターフェイスにマッピングするセカンダリ VLAN ID の IntegerRange(例:1-10,20,35,50-120)。

pvlanTrunkAssociationType:PvlanTrunkAssociationType PVLAN トランク アソシエーション タイプ。

戻り値

PvlanTrunkMapping の InstanceNameId。

createSecondaryVlans

指定されたプライマリ InstanceNameId に対するセカンダリ VLAN のリストを作成します。セカンダリ VLAN を作成するプライマリ VLAN は存在している必要があります。

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

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

secVlanCol に含まれている要素が、SecondaryVlan の有効なタイプではない場合。

secondaryVlanType がヌルの場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

デバイス内で一意な VLAN 名ではない場合。

指定された VLAN ID が内部 VLAN の VLAN ID とオーバーラップする場合。

VLAN がデフォルト VLAN、たとえば、VLAN 1 や Catalyst 6500 シリーズ スイッチの VLAN 1002 の場合。

指定されたプライマリ VLAN に隔離 VLAN が複数マッピングされている場合。

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

同じ vlanId を持つ VLAN が、指定したデバイスにすでに存在している場合。

primaryVlanNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

primaryVlanNameId:セカンダリ VLAN を関連付ける必要のある PrimaryVlan オブジェクト。

secVlanCo:作成後にプライマリ VLAN に関連付ける必要のある SecondaryVlan オブジェクトのリスト。

戻り値

新規作成された SecondaryVlan の InstanceNameId のリスト。

createVlanInNetwork

一連のネットワーク要素に通常の VLAN を作成します。ネットワーク要素が指定されなかった場合は、すべての管理対象ネットワーク要素に VLAN を作成します。

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

vlanId がヌルの場合。

neNameIds に含まれている要素が AbstractNetworkElement の有効な InstanceNameId ではない場合。

デバイス内で一意な VLAN 名ではない場合。

指定された VLAN ID が内部 VLAN の VLAN ID とオーバーラップする場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

vlanId がいずれかのデフォルト VLAN ID と重複する場合。デフォルト VLAN ID とは、VLAN 1 や VLAN 1002(Catalyst 6500 シリーズ スイッチの場合)などです。

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

同じ vlanId を持つ VLAN が、指定したデバイスにすでに存在している場合。

neNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

neNameIds:VLAN を作成するネットワーク要素の InstanceNameIds。ヌルまたは空の場合は、すべての管理対象ネットワーク要素に VLAN が作成されます。

vlanId:作成する VLAN の ID。整数。

vlanName:VLAN を記述。ヌルの場合、VLAN はデフォルト名で作成されます。たとえば、キーワード VLAN の後に VLAN ID を付加した値が設定されます。

戻り値

新規作成された VLAN に対応する InstanceNameId のリスト。

createVlans

リストされた VLAN をネットワーク要素に作成します。このメソッドは、通常の VLAN の作成にも、プライベート VLAN の作成にも使用できます。この API ではアソシエーション(SVI、セカンダリ VLAN など)はいずれも考慮されません。

指定された VLAN に対する次のアソシエーションが規定されます。

ネットワーク要素リファレンス

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

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

vlanCol に含まれている要素が VlanExternal の有効なタイプでないか、AbstractNetworkElement リファレンスが指定されていない場合。

デバイス内で一意な VLAN 名ではない場合。

指定された VLAN ID が内部 VLAN の VLAN ID とオーバーラップする場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

VLAN がデフォルト VLAN の場合。デフォルト VLAN ID とは、VLAN 1 や VLAN 1002(Catalyst 6500 シリーズ スイッチの場合)などです。

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

同じ vlanId を持つ VLAN が、指定したデバイスにすでに存在している場合。

指定された AbstractNetworkElement に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanCol:作成する VlanExternal オブジェクトのリスト。

戻り値

新規作成された VLAN に対応する InstanceNameId のリスト。

deleteAllowedVlansOnTrunks

トランク ポートの許可された VLAN リストから一連の VLAN を削除します。任意のタイプの VLAN が対象です。いずれかのポートについて許可された VLAN リストからすべての VLAN を削除する場合、許可された VLAN にはデフォルト(1 ~ 4094)が設定されます。

次の検証が実行されます。

指定された VLAN は通常の VLAN だけである必要があります。

指定されたポートはトランク ポートだけである必要があります。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

vlanRange に含まれる ID が有効な範囲にない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:許可された VLAN の削除元になるポートの InstanceNameId のリスト。

vlanRange:指定したポートの許可された VLAN から削除する VLAN ID の IntegerRange(例:1-10,20,35,50-120)。

戻り値

void

deleteAllowedVlansOnPvlanTrunks

PVLAN トランク ポートの許可された VLAN リストから一連の VLAN を削除します。任意のタイプの VLAN が対象です。デフォルトでは、PVLAN トランク ポートの許可された VLAN は空になります。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

vlanRange に含まれる ID が有効な範囲にない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIdCol:PVLAN トランク許可された VLAN を削除するポートの InstanceNameId のリスト。

vlanRange:指定したポートの PVLAN トランク許可された VLAN リストから削除する VLAN ID の IntegerRange。

戻り値

void

deleteFipSnoopingEnabledVlans

FIP スヌーピングがイネーブルになっている VLAN のコレクションを削除します。VLAN を削除する前に、FIP スヌーピング機能をディセーブルにします。指定された VLAN にアソシエーションがある場合は、VLAN を未完成状態に設定し、アソシエーションを保持します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

vlanNameIds に含まれている要素が VLAN の InstanceNameId ではない場合。

指定された VLAN が内部、デフォルト、またはプライベートのいずれかの VLAN の場合。

VLAN で FIP スヌーピングがディセーブルになっている場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:削除する VLAN の InstanceNameId のリスト。

戻り値

void

deletePvlanTrunkMappings

指定された PVLAN トランク アソシエーションを削除します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

pvlanTrunkMappingInstanceNameIdCol がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

pvlanTrunkMappingInstanceNameIdCol に含まれている要素が PvlanTrunkMapping オブジェクトの有効な InstanceNameId ではない場合。

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

pvlanTrunkMappingInstanceNameIdCol の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

pvlanTrunkMappingInstanceNameIdCol:PvlanTrunkMappings の InstanceNameId のリスト。

戻り値

void

deleteVlans

VLAN のコレクションを削除します。VLAN がプライマリ VLAN の場合は、関連付けられているすべてのセカンダリ VLAN が削除されます。指定された VLAN にアソシエーションがある場合は、VLAN を未完成状態に設定し、アソシエーションを保持します。

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

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

vlanNameIds に含まれている要素が VLAN の InstanceNameId ではない場合。

指定された VLAN が内部またはデフォルトの VLAN の場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

VLAN 名がデバイス内のいずれかの VLAN と重複する場合。

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

vlanNameIds の InstanceNameId に対応する VLAN オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:削除する VLAN の InstanceNameId のリスト。

戻り値

void

deleteVlansInNetwork

ネットワーク要素のリストから VLAN のコレクションを削除します。VLAN がプライマリ VLAN の場合は、関連付けられているすべてのセカンダリ VLAN がアンバインドされます。プライマリ VLAN にバインドされている未完成のセカンダリ VLAN がある場合は、その未完成 VLAN の削除も行います。

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

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

指定された VLAN が内部またはデフォルトの VLAN の場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

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

neNameIds の InstanceNameId に対応する AbstractNetworkElement オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanIds:削除する VLAN の IntegerRange。

neNameIds:VLAN を削除する必要のあるネットワーク要素の InstanceNameId のリスト。ヌルの場合は、すべてのネットワーク要素から VLAN が削除されます。

戻り値

void

disablePrivateVlanService

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

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

neInstanceNameIdCol がヌルの場合。

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

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

パラメータ

opContext:動作コンテキスト。

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

戻り値

void

enablePrivateVlanService

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

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

neInstanceNameIdCol がヌルの場合。

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

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

パラメータ

opContext:動作コンテキスト。

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

戻り値

void

getActivePortsCountInVlans

リストで指定された VLAN InstanceNameId にあるアクティブ ポートの数のリストを戻します。

次のように VLAN タイプに基づいてポートをカウントします。

通常の VLAN:アクティブなアクセス ポートの数。

プライマリ VLAN:アクティブな混合モード ポートの数。

セカンダリ VLAN:アクティブな PVLAN ホスト ポートの数。

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

vlanNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

vlanNameIds に含まれている要素が VlanExternal オブジェクトの有効な InstanceNameId ではない場合。

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

vlanNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:アクティブ ポート数を問い合わせる VLAN オブジェクトの InstanceNameId のリスト。

戻り値

アクティブ ポート数のリスト

getInactivePortsCountInVlans

リストで指定された VLAN InstanceNameId にある非アクティブ ポートの数のリストを戻します。

次のように VLAN タイプに基づいてポートをカウントします。

通常の VLAN:非アクティブ アクセス ポートの数。

プライマリ VLAN:非アクティブ混合モード ポートの数。

セカンダリ VLAN:非アクティブ PVLAN ホスト ポートの数。

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

vlanNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

vlanNameIds に含まれている要素が VlanExternal オブジェクトの有効な InstanceNameId ではない場合。

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

vlanNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:非アクティブ ポート数を問い合わせる VLAN オブジェクトの InstanceNameId のリスト。

戻り値

非アクティブ ポート数のリスト。

getInternalVlansInNetworkElement

ネットワーク要素に対応する内部 VLAN オブジェクトを戻します。

VlanInternal オブジェクトのアソシエーションは使用可能になりません。

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

neNameId がヌルか、AbstractNetworkElement の InstanceNameId ではない場合。

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

neNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

neNameId:内部 VLAN を問い合わせるネットワーク要素の InstanceNameId。

戻り値

VlanInternal オブジェクトの順序付きリスト。

getPortsCountInVlans

リストで指定された VLAN InstanceNameId にあるポートの数のリストを戻します。

次のように VLAN タイプに基づいてポートをカウントします。

通常の VLAN:指定されたステータスを持つアクセス ポートの数。

プライマリ VLAN:指定されたステータスを持つ混合モード ポートの数。

セカンダリ VLAN:指定されたステータスを持つ PVLAN ホスト ポートの数。

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

vlanNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

vlanNameIds に含まれている要素が VlanExternal オブジェクトの有効な InstanceNameId ではない場合。

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

vlanNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:NetworkInterfaceOperationStatus に基づいてポート数を問い合わせる VLAN オブジェクトの InstanceNameId のリスト。

status:NetworkInterfaceOperationStatus。ヌルの場合は、動作ステータスにかかわらず、VLAN に含まれるポートの数が戻ります。

戻り値

ポート数のリスト

getPortsInVlan

VLAN に属しているポートのリストを戻します。指定された VLAN タイプに基づいて、次のように SwitchedNetworkInterface のコレクション(物理ポートおよびポート チャネル)を戻します。

a)通常の VLAN:アクセス ポート

b)プライマリ VLAN:混合モード ポート

c)セカンダリ VLAN:プライベート VLAN ホスト ポート

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

NetworkInterfaceName。

NetworkInterfaceStatus。

PromiscuousPvlanMapping。混合モード PVLAN マッピングのためにセカンダリ VLAN コレクションへの読み込みが行われます。

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

vlanNameId がヌルか、VlanExternal の有効な InstanceNameId ではない場合。

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

vlanNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameId:ポートを問い合わせる VlanExternal の InstanceNameId。

戻り値

指定された VLAN InstanceNameId 用に関連付けられている SwitchedNetworkInterface ポートのリスト。

getPrivateVlanServiceState

対応する PVLAN サービスがイネーブルかどうかを示すブールのリストを戻します。

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

neInstanceNameIdCol がヌルの場合。

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

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

パラメータ

opContext:動作コンテキスト。

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

戻り値

void

getPrivateVlansInNetworkElement

ネットワーク要素に設定されているプライベート VLAN を戻します。ネットワーク要素の InstanceNameId を指定すると、プライマリ VLAN および対応するセカンダリ VLAN のリストを戻します。

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

VLAN ステータス

プライマリ VLAN の場合、セカンダリ VLAN コレクション。このセカンダリ VLAN は VlanStatus を参照します。

セカンダリ VLAN の場合は、プライマリ VLAN 参照。このプライマリ VLAN は VlanStatus を参照します。

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

neNameId が AbstractNetworkElement の InstanceNameId ではない場合。

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

neNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

neNameId:プライベート VLAN を問い合わせるネットワーク要素の InstanceNameId。

戻り値

プライベート VLAN の PrimaryVlan オブジェクトおよび SecondaryVlan オブジェクトの順序付きリスト。

getSecondaryVlans

1 つまたは複数のプライマリ VLAN のセカンダリ VLAN を戻します。

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

VLAN ステータス

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

pvlanNameIds がヌルまたは空か、タイプ InstanceNameId ではない場合。

pvlanNameIds に含まれている要素が PrimaryVlan オブジェクトの有効な InstanceNameId ではない場合。

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

pvlanNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

pvlanNameIds:セカンダリ VLAN を問い合わせる必要のある PrimaryVlan InstanceNameIds のリスト。

戻り値

SecondaryVlan オブジェクトおよび関連付けられている PrimaryVlan 参照のリスト。

getTotalPortCountInVlans

リストで指定された VLAN InstanceNameId にあるポートの数のリストを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

VLAN ステータス

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

pvlanNameIds がヌルまたは空か、タイプ InstanceNameId ではない場合。

vlanInstanceNameIdCol に含まれている要素が VlanExternal オブジェクトの有効な InstanceNameId ではない場合。

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

vlanInstanceNameIdCol の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

operationStatusList:NetworkInterfaceOperationStatus。ヌルの場合は、動作ステータスにかかわらず、VLAN に含まれるポートの数を戻します。アクティブ ポート数の場合は、operationStatusList に NetworkInterfaceOperationStatus.UP または NetworkInterfaceOperationStatus.TRUNKING が含まれている必要があります。アクティブ ポート数の場合に限っては、NetworkInterfaceOperationStaus.DOWN を渡す必要があります。

戻り値

ポート数のリスト。

getTrunksForVlan

VLAN を許可するトランク ポートを戻します。

次のように VLAN タイプに基づく SwitchedNetworkInterface のリストを戻します。

通常の VLAN:VLAN を許可するトランク ポート

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

NetworkInterfaceName

NetworkInterfaceStatus

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

vlanNameId がヌルか、VlanExternal の有効な InstanceNameId ではない場合。

指定された VLAN がプライベート VLAN(PrimaryVlan または SecondaryVlan)の場合。

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

vlanNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameId:ポートを問い合わせる VlanExternal の InstanceNameId。

戻り値

SwitchedNetworkInterface のリスト。

getVlanGlobalSettings

指定されたネットワーク要素の VLAN グローバル設定のリストを戻します。

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

neNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

neNameIds に含まれている要素が AbstractNetworkElement の InstanceNameId タイプではない場合。

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

neNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

neNameIds:VLAN ID を問い合わせるネットワーク要素の InstanceNameId。ヌルの場合は、すべての管理対象ネットワーク要素のすべての VLAN ID を戻します。

戻り値

指定されたネットワーク要素に対応する VlanGlobalSetting オブジェクトのリスト。

getVlanIdsInNetwork

一連のネットワーク要素に設定されている VLAN の ID を戻します。この API は通常およびプライマリの VLAN の ID を戻します。この API ではアソシエーションを読み込まず、VLAN ID 範囲だけを戻します。

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

neNameIds に含まれている要素が AbstractNetworkElement の InstanceNameId タイプではない場合。

パラメータ

opContext:動作コンテキスト。

neNameIds:VLAN ID を問い合わせるネットワーク要素の InstanceNameId。ヌルの場合は、すべての管理対象ネットワーク要素のすべての VLAN ID を戻します。

戻り値

一連の VLAN ID IntegerRange

getVlanRangeInNetworkElements

引数として渡されたそれぞれの ANE に対する IntegerRange のリストを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

neInstanceNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIds:ANE の InstanceNameId のリスト。ヌルおよび空にはできません。

戻り値

IntegerRange のリスト。

getVlanNetworkInterfaces

VLAN のリストに対応する VlanNetworkInterface(SVI)オブジェクトを戻します。

インターフェイスごとに、次のアソシエーションが使用可能です。

Name。

Interface Status。

セカンダリ VLAN コレクション。

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

vlanNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

vlanNameIds に含まれている要素が VlanExternal オブジェクトの有効な InstanceNameId ではない場合。

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

vlanNameId の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:VlanExternal オブジェクトの InstanceNameId のリスト。

戻り値

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

getVlans

指定された VLAN InstaneNameId リストに対応する VLAN オブジェクトを戻します。この API では VLAN 外部オブジェクトだけが許可されます。

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

VLAN ステータス

プライマリ VLAN の場合、セカンダリ VLAN コレクション。このセカンダリ VLAN は VlanStatus を参照します。

セカンダリ VLAN の場合は、プライマリ VLAN 参照。このプライマリ VLAN は VlanStatus を参照します。

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

vlanNameIds がヌルまたは空か、タイプ InstanceNameId ではない場合。

pvlanNameIds に含まれている要素が VlanExternal オブジェクトの有効な InstanceNameId ではない場合。

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

vlanNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:VLAN の InstanceNameId。

戻り値

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

getVlansInNetwork

ネットワーク要素のリストに対応する VLAN ID のリストに対応する VLAN オブジェクトを戻します。渡された VLAN ID がヌルの場合は、指定されたネットワーク要素のすべての VLAN を戻します。ネットワーク要素の InstanceNameId リストとしてヌルが渡された場合は、すべての管理対象ネットワーク要素の VLAN を戻します。

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

VLAN ステータス

PVRST 設定

MST 設定

プライマリ VLAN の場合、セカンダリ VLAN コレクション。このセカンダリ VLAN は、VlanStatus および STP 設定を参照します。

セカンダリ VLAN の場合は、プライマリ VLAN 参照。このプライマリ VLAN は、VlanStatus および STP 設定を参照します。

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

neNameIds に含まれている要素が AbstractNetworkElement の InstanceNameId タイプではない場合。

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

neNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanIdRange:一連の VLAN ID(例:1-10,20,35,50-120)。ヌルの場合は、すべての VLAN を戻します。

neNameIds:VLAN ID を問い合わせるネットワーク要素の InstanceNameId のリスト。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。

戻り値

VlanExternal オブジェクトの順序付きリスト。

getVlansInNetworkElement

ネットワーク要素に設定されている VLAN を戻します。ネットワーク要素の InstanceNameId を指定すると、次のタイプを持つ VLAN のリストを戻します。

通常の VLAN。

プライベート VLAN(プライマリおよびセカンダリ)。

この API では内部 VLAN を戻しません。

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

VLAN ステータス

プライマリ VLAN の場合、セカンダリ VLAN コレクション。このセカンダリ VLAN は VlanStatus を参照します。

セカンダリ VLAN の場合は、プライマリ VLAN 参照。このプライマリ VLAN は VlanStatus を参照します。

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

neNameId が AbstractNetworkElement の InstanceNameId ではない場合。

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

neNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

neNameId:VLAN を問い合わせるネットワーク要素の InstanceNameId。

戻り値

VlanExternal オブジェクトの順序付きリスト。

getVlansWithSecurityAssociations

VLAN に対応するセキュリティ アソシエーションを戻します。

VLAN ごとに、次のアソシエーションが読み込まれます。

DaiSetting

DhcpSnoopingSetting

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

vlanNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

vlanNameIds に含まれている要素が VlanExternal オブジェクトの有効な InstanceNameId ではない場合。

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

vlanNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:VLAN の InstanceNameId。

戻り値

指定された InstanceNameId に対応する VlanExternal オブジェクトおよびセキュリティ アソシエーションのリスト。

getVlansWithSpanAssociations

VLAN に対応する SPAN アソシエーションを戻します。

VLAN ごとに、次のアソシエーションが読み込まれます。

送信元 VLAN へのローカル SPAN

フィルタリングされた VLAN

LocalSpanSessionAppliesToVlan とフィルタリングされた VLAN アソシエーションの相手側で次のオブジェクトが読み込まれます。

LocalSpanSession

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

vlanNameIds がヌルまたは空か、タイプ InstanceNameId ではない場合。

vlanNameIds に含まれている要素が VlanExternal オブジェクトの有効な InstanceNameId ではない場合。

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

vlanNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNameIds:VLAN の InstanceNameId。

戻り値

指定された InstaneNameId に対応する VlanExternal オブジェクトおよび SPAN アソシエーションのリスト。

getVtpGlobalSettings

指定されたネットワーク要素の VTP グローバル設定のリストを戻します。Nexus 7000 シリーズ スイッチ プラットフォームの場合、VtpGlobalSetting オブジェクトはヌルになります。

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

neNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

neNameIds に含まれている要素が AbstractNetworkElement の InstanceNameId タイプではない場合。

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

neNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

neNameIds:VLAN ID を問い合わせるネットワーク要素の InstanceNameId。ヌルの場合は、すべての管理対象ネットワーク要素のすべての VLAN ID を戻します。

戻り値

指定されたネットワーク要素に対応する VtpGlobalSetting オブジェクトのリスト。

modifyAllowedVlansOnTrunks

ポート モードにかかわらず指定されたポートのリストに対する既存の許可された VLAN を変更します。指定された VLAN ID で古いアソシエーションを置き換えます。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成してポートにバインドします。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

vlanRange に含まれる ID が有効な範囲にない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:許可された VLAN を変更するポートの InstanceNameId のリスト。

vlanRange:指定されたポートの許可された VLAN として変更する VLAN ID の IntegerRange(例:1-10,20,35,50-120)。

戻り値

void

modifySecondaryVlansForPromiscuousPorts

リストで指定されたポートで、既存の混合モード PVLAN アソシエーションと関連付けられている既存のセカンダリ VLAN を変更します。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成します。

ポートとセカンダリ VLAN の間の次のアソシエーションが置換されます。

PromiscuousPvlanMapping。

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

primaryVlanId がヌルか、PrimaryVlan の InstanceNameId でない、または対応するオブジェクトが存在しない場合。

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

secondaryVlanIdsRange に含まれているいずれかの VLANId が primaryVlanId と重複している場合。

指定されたポートに対して混合モード バインディングが存在しない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIdCol:SwitchedNetworkInterfaces の InstanceNameId のリスト。

secondaryVlanIdRange:混合モード ポートにマッピングするセカンダリ VLAN ID の IntegerRange(例:1-10,20,35,50-120)。

戻り値

PromiscuousPvlanMappings のリスト。

modifyVlanGlobalSetting

指定されたグローバル設定で既存の VLAN グローバル設定オブジェクトを変更します。古いアソシエーションは新規グローバル設定で置換されます。

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

neNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

neNameIds に含まれている要素が AbstractNetworkElement の InstanceNameId タイプではない場合。

setting がヌルの場合。

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

neNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

neNameId:AbstractNetworkElement の InstanceNameId。

setting:変更済み VlanGlobalSetting オブジェクト。

戻り値

void

modifyAccessVlanToNativeVlanOnInterfaces

指定された InstanceNameId オブジェクトのインターフェイスで、現在のアクセス VLAN をトランク ネイティブ VLAN としてバインドします。現在のアクセス VLAN はアンバインドされ、そのインターフェイスがアクセス VLAN としてデフォルト VLAN にバインドされます。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

ifNameIdCol に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

ifNameIdCol の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

ifNameIdCol:SwitchedNetworkInterface ポートの InstanceNameIds のリスト。

戻り値

SwitchedNetworkInterfaceBelongsToVlan オブジェクトのリスト。

modifyAllowedVlansOnPvlanTrunks

ポート モードにかかわらず指定されたポートのリストに対する既存の PVLAN トランク許可された VLAN を変更します。指定された VLAN ID で古いアソシエーションを置き換えます。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成してポートにバインドします。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

portNameIds に含まれている要素が SwitchedNetworkInterface の有効な InstanceNameId ではない場合。

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

vlanRange に含まれる ID が有効な範囲にない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIdCol:PVLAN トランク許可された VLAN を変更するポートの InstanceNameId のリスト。

vlanRange:指定したポートの PVLAN トランク許可された VLAN として変更する VLAN ID の IntegerRange。

戻り値

void

modifySecondaryVlansForPvlanTrunkMapping

指定された PVLAN トランク アソシエーションについて既存のセカンダリ VLAN を変更します。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

pvlanTrunkMappingInstanceNameId がヌルか、タイプ InstanceNameId ではない場合。

pvlanTrunkMappingInstanceNameId が PvlanTrunkMapping オブジェクトの有効な InstanceNameId ではない場合。

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

secondaryVlanIdRange に含まれているいずれかの VLANId が primaryVlanId と重複している場合。

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

* pvlanTrunkMappingInstanceNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

pvlanTrunkMappingInstanceNameId:PvlanTrunkMapping の InstanceNameId

secondaryVlanIdRange:セカンダリ VLAN ID の IntegerRange。

戻り値

void

modifyVlanTypeToNormal

リストで指定された VLAN のタイプを通常に変更します。これにより、サーバで作成されており、タイプが変更された VLAN オブジェクトのリストが戻ります。

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

vlanCol がヌルまたは空か、リスト内の要素がタイプ VlanExternal ではない場合。

リストに含まれている要素が、デバイスにすでに存在している VlanExternal の場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

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

vlanCol のオブジェクトに対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanCol:通常の VLAN およびセカンダリ VLAN を含む VLAN のリスト

戻り値

変更された(通常の)VLAN のリスト

modifyVlanTypeToPrimary

リストで指定された VLAN のタイプをプライマリに変更します。これにより、サーバで作成されており、タイプが変更された VLAN オブジェクトのリストが戻ります。

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

vlanCol がヌルまたは空か、リスト内の要素がタイプ VlanExternal ではない場合。

リストに含まれている要素が、デバイスにすでに存在している PrimaryVlan の場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

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

vlanCol のオブジェクトに対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanCol:通常の VLAN およびセカンダリ VLAN を含んでいる VLAN のリスト

戻り値

変更された VLAN のリスト

modifyVlanTypeToSecondary

リストで指定された VLAN のタイプをセカンダリに変更します。これにより、サーバで作成されており、タイプが変更された VLAN オブジェクトのリストが戻ります。

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

vlanCol がヌルまたは空か、リスト内の要素がタイプ VlanExternal ではない場合。

リストに含まれている要素が、デバイスにすでに存在しているいずれかの VLAN とオーバーラップする secondaryVlanType を持つ SecondaryVlan の場合。

secondaryVlanType がヌルの場合。

指定されたセカンダリ VLAN オブジェクトに対応するプライマリ VLAN の隔離 VLAN の制限を超えている場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

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

vlanCol のオブジェクトに対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanCol:通常の VLAN およびプライマリ VLAN を含んでいる VLAN のリスト

secondaryVlanType:セカンダリ VLAN タイプ(コミュニティ/隔離)

戻り値

変更された VLAN のリスト

modifyVlans

既存の VLAN オブジェクトのコレクションを変更します。アソシエーションは更新しません。VLAN 固有のパラメータだけを更新します。

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

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

modifiedVlanCol に含まれている要素がタイプ VlanExternal ではない場合。

指定された VLAN が内部またはデフォルトの VLAN の場合。

プライベート VLAN でリモート SPAN がイネーブルにされている場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアントまたはサーバの場合。

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

VlanExternal オブジェクト modifiedVlanCol のいずれかのアトリビュートが有効でないか、プラットフォーム タイプでサポートされていないアトリビュートの場合。

例:

ethernet mediaType の VlanExternal だけがサポートされている場合。

VlanExternal の vlanId が範囲外の場合。

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

modifiedVlanCol VlanExternal コレクションのオブジェクトに対応するオブジェクトが存在しない。

パラメータ

opContext:動作コンテキスト。

modifiedVlanCol:変更した VlanExternal オブジェクトのリスト。

戻り値

void

unbindAccessPortsFromVlan

指定されたポートのアクセス VLAN アソシエーションをアンバインドします。アンバインド後のポートをデフォルト VLAN にバインドします。

ポートと VLAN の間の次のアソシエーションが更新されます。

アソシエーション タイプを access とする SwitchedNetworkInterfaceBelongsToVlan

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

vlanId がヌルの場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:アクセス VLAN からアンバインドする必要のある SwitchedNetworkInterface の InstanceNameId のリスト。

戻り値

void

unbindHostPortsFromPrivateVlan

指定されたポートの PVLAN ホスト アソシエーションをアンバインドします。

ポートと VLAN の間の次のアソシエーションが更新されます。

アソシエーション タイプを access とする SwitchedNetworkInterfaceBelongsToVlan。

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:PVLAN ホスト VLAN からアンバインドする必要のある SwitchedNetworkInterface の InstanceNameId のリスト。

戻り値

void

unbindNativeVlanOnTrunks

指定されたポートのトランク ネイティブ VLAN アソシエーションをアンバインドします。アンバインド後のポートをデフォルト VLAN にバインドします。

ポートと VLAN の間の次のアソシエーションが更新されます。

アソシエーション タイプを access とする SwitchedNetworkInterfaceBelongsToVlan。

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

vlanId がヌルの場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:トランク ネイティブ VLAN からアンバインドする必要のある SwitchedNetworkInterface の InstanceNameId のリスト。

戻り値

void

unbindPromiscuousPortsFromPrivateVlan

指定されたプライマリ VLAN に混合モード ポートをバインドし、作成した混合モード アソシエーションに対する指定されたセカンダリ VLAN のマッピングも行います。指定された VLAN が存在しない場合は、未完成の通常の VLAN を作成します。

ポート、プライマリ VLAN、およびセカンダリ VLAN の間で次のアソシエーションが更新されます。

PromiscuousPvlanMapping。

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:混合モード マッピングからアンバインドする必要のある SwitchedNetworkInterface の InstanceNameId のリスト。

戻り値

void

unbindSecondaryVlansFromPrimary

バインドされている場合に、プライマリ VLAN からセカンダリ VLAN をアンバインドします。

セカンダリ VLAN が未完成状態の場合は、そのセカンダリ VLAN を削除します。

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

secondaryVlanNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

secondaryVlanNameIds に含まれている要素が SecondaryVlan オブジェクトの有効な InstanceNameId ではない場合。

Catalyst 6500 シリーズ スイッチの場合に、VTP モードがクライアント/サーバの場合。

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

secondaryVlanNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

secondaryVlanNameIds:プライマリ VLAN からアンバインドするセカンダリ VLAN の(@link InstanceNameId)のリスト。

戻り値

void

unbindSecondaryVlansFromVlanNetworkInterface

指定された VlanNetworkInterface(SVI)からセカンダリ VLAN をアンバインドします。

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

vlanNetworkInterfaceNameId がヌルか、VlanNetworkInterface の有効な InstanceNameId ではない場合。

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

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

vlanNetworkInterfaceNameId に対応する VlanNetworkInterface オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

vlanNetworkInterfaceNameId:セカンダリ VLAN をバインドする VlanNetworkInterface の InstanceNameId。

secondaryVlanIds:VlanNetworkInterface にバインドするセカンダリ VLAN ID の IntegerRange(例:1-10,20,35,50-120)。

戻り値

void

unbindNativeVlanOnPvlanTrunks

指定されたポートの PVLAN トランク ネイティブ VLAN アソシエーションをアンバインドします。アンバインド後のポートは、デフォルト VLAN にバインドされます。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

portNameIds がヌルまたは空か、リスト内の要素がタイプ InstanceNameId ではない場合。

portNameIds に含まれている要素が SwitchedNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

vlanId がヌルの場合。

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

portNameIds の InstanceNameIds に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

portNameIds:PVLAN トランク ネイティブ VLAN からアンバインドする必要のある SwitchedNetworkInterfaces の InstanceNameId のリスト。

戻り値

void