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

目次

StpApp サービス

StpApp サービスについて

bindPvstSettingToVlans

bindStpNetworkInterfaceSettingForMstInstances

bindStpNetworkInterfaceSettingForVlans

bindStpNeworkInterfaceSettingsToNetworkInterface

bindVlansToMstInstance

createMstInstance

createMstInstanceByRange

createMstInstances

createMstInstancesInNetworkElement

deleteMstInstances

getAllStpSettingsForNetworkInterfaces

getAllStpStateCountsForVlans

getBlockingStpPortsCountInMsts

getBlockingStpPortsCountInVlans

getForwardingStpPortsCountInMsts

getForwardingStpPortsCountInVlans

getMstGlobalSettings

getMstIdsInNetwork

getMstInstances

getMstInstancesInNetwork

getNetworkInterfacesWithStpSettings

getOperationalStpSettingForVlans

getStpDisabledVlansInNetwork

getStpEnabledVlansInNetwork

getStpGlobalSettings

getStpMode

getStpNetworkInterfaceSettingForPortsInVlanBasedOnDeviceProtocolNew

getStpNetworkInterfaceSettings

getStpNetworkInterfaceSettingsForAccessPortsInMst

getStpNetworkInterfaceSettingsForAllPortsInMst

getStpRootBridgeStatusForVlansBasedOnDeviceProtocol

getStpRootVlansBasedOnDeviceProtocol

getStpNetworkInterfaceSettingsForPortsInVlan

getStpNetworkInterfaceSettingsForPortsInVlansByInterfaces

getStpNetworkInterfaceSettingsForTrunkPortsInMst

getStpNetworkInterfaceSettingsForVlanMemberPortsInMst

getStpSettingsForMst

getStpSettingsForVlan

getStpStatusForNetworkInterfacesInVlan

getStpTopologyInterface

getStpTopologyInterfaces

getTotalStpPortsCountInMsts

getTotalStpPortsCountInVlans

getVlansWithPvrstSetting

modifyMstGlobalSettings

modifyMstInstances

modifyPvstSettings

modifyStpGlobalSettings

modifyStpNetworkInterfaceSettingForMst

modifyStpNetworkInterfaceSettingForVlan

modifyStpNetworkInterfaceSettings

modifyStpSettingForNetworkInterfaces

modifyStpType

unbindVlansFromMstInstance

StpApp サービス

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

StpApp サービスについて

この章では、Spanning Tree Protocol(STP; スパニング ツリー プロトコル)サービス機能によって公開される API を定義します。

bindPvstSettingToVlans

1 つまたは複数の VLAN ID の PVST 設定を適用します。いずれかのプロパティが PvstSetting でヌルとして設定されている場合は、これらのプロパティはデフォルト値に設定されます。

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

neIds がヌルの場合。

vlanIds がヌルの場合。

setting がヌルの場合。

パラメータ

opContext:動作コンテキスト

neIds:NetworkElement インスタンス名 ID のコレクション。

vlanIds:VLAN ID

setting:Per-VLAN STP 設定

戻り値

void

bindStpNetworkInterfaceSettingForMstInstances

StpNetworkInterfaceSettingBase を特定のインターフェイスの MST ID の範囲にバインドします。StpNetworkInterfaceSettingBase インスタンスには、有効なインスタンス名が設定されている必要があります。

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

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

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

networkInterfaceInstanceNameIds に特定の InstanceNameId がある同等の NetworkInterface オブジェクトがない場合。

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

setting がヌルの場合。

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

インターフェイスに対応するすべての StpNetworkInterfaceSetting アトリビュートが無効である場合。

例:

StpNetworkInterfaceSetting の cost は、値 1 ~ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

networkInterfaceInstanceNameIds:ネットワーク インターフェイスの InstanceNameId のリスト。

mstIds:MST ID の範囲(例:1-10,20,35,50-120)。

setting:ネットワーク インターフェイスに適用される STP 設定。1 ~ 200000000 までの範囲の値。

戻り値

void

bindStpNetworkInterfaceSettingForVlans

StpNetworkInterfaceSettingBase を特定のインターフェイスの VLAN ID の範囲にバインドします。

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

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

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

networkInterfaceInstanceNameIds に特定の InstanceNameId がある同等の NetworkInterface オブジェクトがない場合。

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

setting がヌルの場合。

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

インターフェイスに対応するすべての StpNetworkInterfaceSetting アトリビュートが無効である場合。

例:

StpNetworkInterfaceSetting の cost は、値 1 ~ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

networkInterfaceInstanceNameIds:ネットワーク インターフェイスの InstanceNameId のリスト。

vlanIds:VLAN ID の範囲(例:1-10,20,35,50-120)。

setting:ネットワーク インターフェイスに適用される STP 設定。1 ~ 200000000 までの範囲の値。

戻り値

void

bindStpNeworkInterfaceSettingsToNetworkInterface

STP 設定を 1 つまたは複数のネットワーク インターフェイスに適用します。StpNetworkInterfaceSetting には、有効なインスタンス名が設定されている必要があります。デフォルト値にリセットする必要があるフィールドではヌル値を渡します。

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

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

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

networkInterfaceInstanceNameIds に特定の InstanceNameId がある同等の NetworkInterface オブジェクトがない場合。

setting がヌルの場合。

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

インターフェイスに対応するすべての StpNetworkInterfaceSetting アトリビュートが無効である場合。

例:

StpNetworkInterfaceSetting の cost は、値 1 ~ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

networkInterfaceInstanceNameIds:ネットワーク インターフェイスの InstanceNameId のリスト。

setting:ネットワーク インターフェイスに適用される STP 設定。1 ~ 200000000 までの範囲の値。

戻り値

void

bindVlansToMstInstance

VLAN ID のセットを MST インスタンスにバインドします。

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

mstId がヌルの場合。

mstId がデータベースに同等の MstSetting オブジェクトを持たない場合。

vlanIds がヌルの場合。

パラメータ

opContext:動作コンテキスト

mstId:MST の InstanceNameId

vlanIds:VLAN ID の範囲(例:1-10,20,35,50-120)。

戻り値

void

createMstInstance

ネットワーク要素で MST インスタンスおよび関連する VLAN を作成します。

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

neInstanceNameId がヌルの場合。

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

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

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

vlanInstanceNameIds に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。

mstInstance がヌルの場合。

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

すべての MstSetting アトリビュートが無効である場合。

例:

MstSetting の stpHelloTime は、値 1 ~ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。

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

mstInstance がデータベースにすでに存在する場合。

パラメータ

opContext:動作コンテキスト

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

mstInstance:作成する MST インスタンス。

vlanInstanceNameIds:MST インスタンスに関連付ける VLAN の InstanceNameId のリスト。

戻り値

新規 MST インスタンスの InstanceNameId。

createMstInstanceByRange

ネットワーク要素のセットで MST インスタンスを作成します。指定された ID を持つ MST インスタンスを作成して、指定された VLAN 範囲に関連付けます。指定された VLAN が存在しない場合は、VLAN は作成されませんが、マッピングは作成されます。

サーバでは、特定の MST 設定について次のアソシエーションが作成されます。

MST から VLAN へのマッピング

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

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

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

neInstanceNameIds に特定の InstanceNameId がある同等のネットワーク要素オブジェクトがない場合。

instanceId がヌルの場合。

vlanRange がヌルの場合。

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

すべての MstSetting アトリビュートが無効である場合。

例:

MstSetting の instanceId は、値 0 ~ 4094 までの整数でなければなりません。0 未満または 4094 を超える値によって PropertiesException が発生します。

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

instanceId に対応する MstSetting がデータベースにすでに存在する場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:MST インスタンスが作成されるネットワーク要素の InstanceNameId のリスト。

instanceId:MST インスタンス ID。

vlanRange:VLAN ID の範囲。VLAN が存在しない場合は、インスタンス状態が不完全と指定された VLAN を作成します。

戻り値

ネットワーク要素で作成された MST インスタンスごとの InstanceNameId のリスト。

createMstInstances

1 つまたは複数のネットワーク要素でアソシエーションを持つ MST インスタンスを作成します。

特定の MST 設定について次のアソシエーションが提供されます。

ネットワーク要素

MST インスタンスにマップされた VLAN アソシエーション

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

mstInstances がヌルであるか、コレクションが空である場合。

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

mstInstances 内のすべての MstSetting オブジェクトに、データベースに存在しない AbstractNetworkElement とのアソシエーションがある場合。

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

すべての MstSetting アトリビュートが無効である場合。

例:

MstSetting の stpHelloTime は、値 1 ~ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。

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

mstInstances 内のすべての MstSetting オブジェクトに、AbstractNetworkElement とのアソシエーションがない場合。

mstInstances に、データベースにすでに存在する MstSetting が含まれている場合。

パラメータ

opContext:動作コンテキスト

mstInstances:作成する MST インスタンスのリスト。

戻り値

新規 MST インスタンスの InstanceNameId のリスト。

createMstInstancesInNetworkElement

ネットワーク要素で MST インスタンスを作成します。MST は VLAN なしでは作成できません。

特定の MST 設定について次のアソシエーションが提供されます。

MST インスタンスにマップされた VLAN アソシエーション

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

neInstanceNameId がヌルの場合。

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

mstInstances がヌルであるか、コレクションが空である場合。

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

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

すべての MstSetting アトリビュートが無効である場合。

例:

MstSetting の stpHelloTime は、値 1 ~ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。

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

mstInstances に、データベースにすでに存在する MstSetting が含まれている場合。

パラメータ

opContext:動作コンテキスト

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

mstInstances:MST インスタンスのリスト。

戻り値

新規 MST インスタンスの InstanceNameId のリスト。

deleteMstInstances

MST インスタンスを削除します。動作 STP タイプが MST の場合は、MST インスタンスに対応するすべての VLAN にデフォルトの MST インスタンス 0 が割り当てられます。

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

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

mstInstanceNameIds コレクションに、タイプが MstSetting InstanceNameId ではない要素が含まれている場合。

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

パラメータ

opContext:動作コンテキスト

mstInstances:削除する MST インスタンスの InstanceNameId のリスト。

戻り値

void

getAllStpSettingsForNetworkInterfaces

STP 設定とともにすべてのポートを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

パラメータ

opContext:現在の動作コンテキスト

ifInstanceNameIdCol:NetworkInterface に対応する InstanceNameId

戻り値

NetworkInterface インスタンスのリスト。

それぞれの NetworkInterface に次のアソシエーションがあります。

STP 設定

リンク設定

ポートでの Per-VLAN 設定および関連する VLAN

ポートでの Per-MST 設定および関連する MstSetting

getAllStpStateCountsForVlans

渡されたリスト内の各 VLAN に対応する L2PairForStateCount のリストのリストを戻します。L2PairForStateCount のリストの戻されるリストには、各 STP の状態とそれぞれの stp-state のカウントがあります。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

vlanInstanceNameId に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。

パラメータ

opContext:現在の動作コンテキスト

vlanInstanceNameId:STP 状態カウントを照会する VLAN のインスタンス名 ID。

戻り値

VLAN に対応する L2PairForStateCount のリスト。

getBlockingStpPortsCountInMsts

特定の MST インスタンス ID リストの各 MST に参加している STP ブロッキング ステートを持つポートの数が含まれる整数オブジェクトのリストを戻します。

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

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

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

mstInstanceNameIds に特定の InstanceNameId がある同等の MstSetting オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

mstInstanceNameIds:MST ID の InstanceNameId のリスト

戻り値

特定の MST インスタンス ID リストのカウントを持つ整数のリスト。

getBlockingStpPortsCountInVlans

特定の VLAN インスタンス ID リストの各 VLAN に参加している STP ブロッキング ステートを持つポートの数が含まれる整数オブジェクトのリストを戻します。

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

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

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

vlanInstanceNameIds に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameIds:VLAN の InstanceNameId のリスト

戻り値

特定の VLAN ID リストのカウントを持つ整数のリスト。

getForwardingStpPortsCountInMsts

特定の MST インスタンス ID リストの各 MST に参加している STP フォワーディング ステートを持つポートの数が含まれる整数オブジェクトのリストを戻します。

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

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

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

mstInstanceNameIds に特定の InstanceNameId がある同等の MstSetting オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

mstInstanceNameIds:MST ID の InstanceNameId のリスト

戻り値

特定の MST インスタンス ID リストのカウントを持つ整数のリスト。

getForwardingStpPortsCountInVlans

特定の VLAN インスタンス ID リストの各 VLAN に参加している STP フォワーディング ステートを持つポートの数が含まれる整数オブジェクトのリストを戻します。

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

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

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

vlanInstanceNameIds に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameIds:VLAN の InstanceNameId のリスト

戻り値

特定の VLAN ID リストのカウントを持つ整数のリスト。

getMstGlobalSettings

特定のネットワーク要素リストの MST グローバル設定を戻します。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素の InstanceNameId のリスト。ヌルの場合は、すべてのネットワーク要素の MST グローバル設定を戻します。

戻り値

照会されるネットワーク要素に対応する MstGlobalSetting のリスト。

getMstIdsInNetwork

ネットワーク要素のリストで設定されている MST の ID を戻します。この API にはアソシエーションは読み込まれません。MST 範囲だけがこの API によって戻されます。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameds:MST ID を照会するネットワーク要素の InstanceNameIds。ヌルの場合は、すべての管理対象ネットワーク要素から MST ID を戻します。

戻り値

MST ID の範囲

getMstInstances

特定の InstanceNameIds に対応する MST インスタンスを戻します。

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

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

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

mstSettingInstanceNameIds に特定の InstanceNameId がある同等の MstSetting オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

mstSettingInstanceNameIds:MST インスタンスに対応する InstanceNameId のリスト。

戻り値

照会される InstanceNameId に対応する MstSetting のリスト。

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

マップされる VLAN

ルート bridgeId

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

VLAN ステータス

getMstInstancesInNetwork

ネットワーク要素リストの MST ID リストに対応する MST 設定を戻します。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

mstIds:MST ID の範囲(例:1-10,20,35,50-120)。ヌルの場合は、すべての MST を戻します。

neInstanceNameIds:MST ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で MST を戻します。

戻り値

MST 設定のリスト

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

マップされる VLAN

ルート bridgeId

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

VLAN ステータス

getNetworkInterfacesWithStpSettings

STP 設定とともにすべてのポートを戻します。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

特定のネットワーク要素に存在するインターフェイスのリスト。Nexus 7000 シリーズ スイッチの場合は、レイヤ 2 インターフェイスだけで STP 設定がサポートされるため、戻されるリストには SwitchedNetworkInterface インスタンスだけが含まれます。

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

STP 設定

リンク設定

ポートでの Per-VLAN 設定および関連する VLAN

ポートでの Per-MST 設定および関連する MstSetting

getOperationalStpSettingForVlans

VLAN インスタンス名 ID に対応する StpSetting オブジェクトのリスト(PvstSetting または MstSetting のいずれか)を戻します。ValidationException は、次のいずれかの状況が発生した場合にスローされます。

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

入力 VLAN InstanceNameId の同等の VLAN オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameIds:VLAN InstanceNameId のリスト。

戻り値

入力 VLAN オブジェクトに対応する StpSetting オブジェクト(MstSetting、PvstSetting)のリスト。

getStpDisabledVlansInNetwork

ネットワーク要素リストの VLAN ID リストに対応する STP ディセーブル VLAN オブジェクトを戻します。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

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

neInstanceNameIds:VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。

戻り値

ExternalVlan のリスト

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

STP 設定

VLAN がプライマリ VLAN である場合は、関連付けられたセカンダリ VLAN

VLAN ステータス

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

ルート bridgeId

getStpEnabledVlansInNetwork

ネットワーク要素リストの VLAN ID リストに対応する STP イネーブル VLAN オブジェクトを戻します。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

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

neInstanceNameIds:VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。

戻り値

ExternalVlan のリスト

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

STP 設定

VLAN がプライマリ VLAN である場合は、関連付けられたセカンダリ VLAN

VLAN ステータス

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

ルート bridgeId

getStpGlobalSettings

特定のネットワーク要素リストの STP グローバル設定を戻します。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素の InstanceNameId のリスト。ヌルの場合は、すべてのネットワーク要素の STP グローバル設定を戻します。

戻り値

照会されるネットワーク要素に対応する StpGlobalSetting のリスト。

getStpMode

特定のネットワーク要素リストの STP タイプ リストを戻します。

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

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素の {InstanceNameId} のリスト。

戻り値

ネットワーク要素の STP タイプのリスト。

getStpNetworkInterfaceSettingForPortsInVlanBasedOnDeviceProtocolNew

VLAN に対応する StpNetworkInterfaceSettingBase オブジェクトのリストを戻します。戻されるリストのリストは、VLAN ID に基づいて順序付けされます。次の場合でのフィルタリング後に、戻されるリストには switchedNetworkInterface が追加されます。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

switchedNetworkInterface に stpNetworkInterfaceSettingForVlan または stpNetworkInterfaceSettingForMstobject がない場合。

stpNetworkInterfaceSettingForVlan または stpNetworkInterfaceSettingForMst オブジェクトが stpNetworkInterfaceStatus ではない場合。

switchedNetworkInterface に物理リンクがない場合。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:現在の動作コンテキスト

vlanIds:VLAN ID の範囲(ヌルの場合は、すべての VLAN を戻します)。

neInstanceNameIds:VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。

戻り値

ネットワーク要素の STP タイプのリスト。

getStpNetworkInterfaceSettings

特定のスイッチ ポート リストの STP 設定を戻します。

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

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

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

networkInterfaceInstanceNameIds に特定の InstanceNameId がある同等の NetworkInterface オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

networkInterfaceInstanceNameIds:ネットワーク インターフェイスの InstanceNameId のリスト。

戻り値

StpNetworkInterfaceSetting のリスト

getStpNetworkInterfaceSettingsForAccessPortsInMst

入力 MST InstanceNameId に対応する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 MST と関連するいずれかの SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForMst オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForMst コレクションは、入力 MST に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。

ValidationException は、渡された引数がヌルの場合、または有効な MstSetting InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

mstInstanceNameId:MST の InstanceNameId。

戻り値

SwitchedNetworkInterface のリスト

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

StpNetworkInterfaceSettingForMst のコレクション

StpNetworkInterfaceStatus

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

StpNetworkInterfaceSettingForMst のコレクション

StpNetworkInterfaceStatus

getStpNetworkInterfaceSettingsForAllPortsInMst

入力 MST InstanceNameId に対応する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 MST と関連するいずれかの SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForMst オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForMst コレクションは、入力 MST に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。

ValidationException は、渡された引数がヌルの場合、または有効な MstSetting InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

mstInstanceNameId:MST の InstanceNameId。

戻り値

SwitchedNetworkInterface のリスト

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

StpNetworkInterfaceSettingForMst のコレクション

StpNetworkInterfaceStatus

getStpRootBridgeStatusForVlansBasedOnDeviceProtocol

VLAN に対応する StpRootBridgeStatus オブジェクトのリストを戻します。デバイスに VLAN がない場合は、StpRootBridgeStatus オブジェクトはヌルとして戻されます。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:現在の動作コンテキスト

vlanIds:VLAN ID の範囲。ヌルの場合は、すべての VLAN を戻します。

neInstanceNameIds:VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。

戻り値

VLAN に対応する StpRootBridgeStatus のリスト。

getStpRootVlansBasedOnDeviceProtocol

渡されるデバイス リストに対応する IntegerRange のリストを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:現在の動作コンテキスト

vlanIds:VLAN ID の範囲。ヌルの場合は、すべての VLAN を戻します。

neInstanceNameIds:VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。

戻り値

VLAN に対応する IntegerRange のリスト。

getStpNetworkInterfaceSettingsForPortsInVlan

VLAN に対応する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 VLAN といずれかの SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForVlan オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForVlan コレクションは、入力 VLAN に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。

ValidationException は、渡された引数がヌルの場合、または有効な VLAN InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameId:VLAN の InstanceNameId。

戻り値

SwitchedNetworkInterface のリスト

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

StpNetworkInterfaceSettingForVlan

StpNetworkInterfaceStatus

getStpNetworkInterfaceSettingsForPortsInVlansByInterfaces

vlanRange 内の各 VLAN と、ifInstanceNameIdCol に対応するいずれかの SwitchedNetworkInterface オブジェクトの間に StpNetworkInterfaceSettingVlan アソシエーションが存在する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 VLAN と、ifInstanceNameIdCol に対応する SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForVlan オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForVlan コレクションは、入力 VLAN に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。

ValidationException は、渡された引数がヌルであるか、vlanRange サイズが 0 以下であるときにスローされます。

パラメータ

opContext:動作コンテキスト

ifInstanceNameIdCol:SwitchedNetworkInterface

vlanRange:VLAN の範囲。

戻り値

SwitchedNetworkInterface のリスト

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

StpNetworkInterfaceSettingForVlan

StpNetworkInterfaceStatus

getStpNetworkInterfaceSettingsForTrunkPortsInMst

入力 MST InstanceNameId に対応する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 MST と関連するいずれかの SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForMst オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForMst コレクションは、入力 MST に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。

ValidationException は、渡された引数がヌルの場合、または有効な MstSetting InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

mstInstanceNameId:MST の InstanceNameId。

戻り値

SwitchedNetworkInterface のリスト

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

StpNetworkInterfaceSettingForMst のコレクション

StpNetworkInterfaceStatus

getStpNetworkInterfaceSettingsForVlanMemberPortsInMst

入力 MST InstanceNameId に対応する SwitchedNetworkInterface オブジェクトのリストと、vlanRange に対応する各 VLAN のメンバー ポートを戻します。入力 MST といずれかの VLAN メンバー ポートの間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForMst オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForMst コレクションは、入力 MST に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。

ValidationException は、渡された引数がヌルの場合、または有効な MstSetting InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

mstInstanceNameId:MST の InstanceNameId

vlanInstanceNameId:VLAN の InstanceNameId

戻り値

SwitchedNetworkInterface のリスト

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

StpNetworkInterfaceSettingForMst のコレクション

StpNetworkInterfaceStatus

getStpSettingsForMst

ネットワーク要素のリストで MST の STP 設定を戻します。特定の MST およびネットワーク要素リストでは、MstSetting のリストを戻し、すべてのネットワーク要素の STP 設定を戻します。

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

mstId がヌルの場合。

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

mstId:照会される MST インスタンスの ID。

neInstanceNameIds:照会されるネットワーク要素の InstanceNameId のリスト。

戻り値

関連する StpRootBridgeStatus を持つ MstSetting のリスト。MST のポートが動作可能ではない場合は、ルート ブリッジ ステータスはヌルです。

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

マップされる VLAN

ルート bridgeId

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

VLAN ステータス

getStpSettingsForVlan

ネットワーク要素セットで VLAN の STP 設定(PVRST)を戻します。特定の VLAN およびネットワーク要素リストでは PvstSetting のリストを戻します。ネットワーク要素が指定されていない場合は、すべてのネットワーク要素の STP 設定を戻します。

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

vlanId がヌルの場合。

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

vlanId:照会される VLAN の ID。

neInstanceNameIds:照会されるネットワーク要素の InstanceNameId のリスト。

戻り値

関連する StpRootBridgeStatus を持つ PvstSetting のリスト。VLAN のポートが動作可能ではない場合は、ルート ブリッジ ステータスはヌルです。

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

ルート bridgeId

getStpStatusForNetworkInterfacesInVlan

vlanInstanceNameId に対応する VLAN と、interfaceInstanceNameIds リストに対応する NetworkInterface の各インスタンスの間に存在する StpNetworkInterfaceSettingForVlan アソシエーションに対応する StpNetworkInterfaceStatus オブジェクトのリストを戻します。デバイスが MST モードで動作している場合は、空のリストが戻されます。ValidationException は、次のいずれかの状況が発生した場合にスローされます。

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

入力 VLAN InstanceNameId の同等の VLAN オブジェクトがない場合。

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

入力 NetworkInterface InstanceNameId の同等の NetworkInterface オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameId:VLAN InstanceNameId。

interfaceInstanceNameIds:NetworkInterface InstanceNameId のリスト。

戻り値

StpNetworkInterfaceStatus のリスト。

getStpTopologyInterface

L2NetworkInterfaceSummaryStatus のリストのリストを戻します。

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

niInstanceNameIds に無効な InstanceNameId 値が含まれている場合。

ヌルが渡される場合。

入力 NI InstanceNameId の同等の SNI オブジェクトがない場合。

vlanRange がヌル、または空の場合。vlan-range に無効な vlanIds が含まれている場合。

パラメータ

opContext:現在の動作コンテキスト

niInstanceNameIds:サマリー オブジェクトを照会するネットワーク インターフェイスのインスタンス名 ID。ヌルにはできません。

vlanRange:サマリー オブジェクトを照会する必要がある VLAN の範囲。

戻り値

L2NetworkInterfaceSummaryStatus のリスト。

getStpTopologyInterfaces

L2NetworkInterfaceSummaryStatus のリストのリストを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

networkElementInstanceNameIds に無効な InstanceNameId networkElementInstanceNameIds 値が含まれている場合。

入力 ANE InstanceNameId の同等の ANE オブジェクトがない場合。

networkElementInstanceNameIds では、ヌルは許可される値です。ヌルが渡される場合は、すべてのネットワーク要素で L2NetworkInterfaceSummaryStatus のリストが戻されます。

vlanRange がヌル、または空の場合。vlan-range に無効な vlanIds が含まれている場合。

パラメータ

opContext:現在の動作コンテキスト

niInstanceNameIds:サマリー オブジェクトを照会するネットワーク インターフェイスのインスタンス名 ID。ヌルにはできません。

vlanRange:サマリー オブジェクトを照会する必要がある VLAN の範囲。

戻り値

L2NetworkInterfaceSummaryStatus のリスト。

getTotalStpPortsCountInMsts

特定の MST インスタンス ID リストの各 MST に参加している STP ステータスを持つポートの数が含まれる整数オブジェクトのリストを戻します。

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

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

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

mstInstanceNameIds に特定の InstanceNameId がある同等の MstSetting オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

mstInstanceNameIds:MST ID の InstanceNameId のリスト

戻り値

特定の MST インスタンス ID リストのカウントを持つ整数のリスト。

getTotalStpPortsCountInVlans

特定の VLAN インスタンス ID リストの各 VLAN に参加している STP ステータスを持つポートの数が含まれる整数オブジェクトのリストを戻します。

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

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

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

vlanInstanceNameIds に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

vlanInstanceNameIds:VLAN の InstanceNameId のリスト。

戻り値

特定の VLAN ID リストのカウントを持つ整数のリスト。

getVlansWithPvrstSetting

ネットワーク要素リストの VLAN ID リストに対応する PVRST 設定を持つ VLAN を戻します。

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

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

neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト

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

neInstanceNameIds:VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で MST を戻します。

戻り値

VLAN のリスト

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

STP 設定

VLAN がプライマリ VLAN である場合は、関連付けられたセカンダリ VLAN。

セカンダリ VLAN の場合は、プライマリ VLAN 参照。

VLAN ステータス

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

ルート bridgeId

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

STP 設定。この設定には StpRootBridgeStatus があります。

VLAN ステータス

modifyMstGlobalSettings

1 つまたは複数のネットワーク要素の MST グローバル設定を変更します。

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

neInstanceNameId がヌルの場合。

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

modifiedMstGlobalSetting がヌルの場合。

パラメータ

opContext:動作コンテキスト

modifiedMstGlobalSetting:変更済みの MstGlobalSetting。

戻り値

void

modifyMstInstances

MST インスタンスの設定を変更します。ユーザは設定で MST ID を変更できません。また、スイッチ プライオリティと STP ルート タイプの両方は変更できません。スイッチ プライオリティまたは STP ルート タイプのいずれかを設定できます。

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

mstInstances がヌルであるか、コレクションが空である場合。

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

mstInstances 内のすべての MstSetting オブジェクトに、同等の永続的 MstSetting オブジェクトがない場合。

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

すべての MstSetting アトリビュートが無効である場合。

例:

MstSetting の stpHelloTime は、値 1 ~ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

mstSettings:変更済みの MstSetting のリスト。

戻り値

void

modifyPvstSettings

PVRST インスタンスの設定を変更します。また、スイッチ プライオリティと STP ルート タイプの両方は変更できません。スイッチ プライオリティまたは STP ルート タイプのいずれかを設定できます。

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

pvstSettings がヌルであるか、コレクションが空の場合。

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

pvstSettings 内のすべての PvstSetting オブジェクトに、同等の永続的 PvstSetting オブジェクトがない場合。

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

すべての PvstSetting アトリビュートが無効の場合。

例:

PvstSetting の stpHelloTime は、値 1 ~ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

pvstSettings:変更済みの PvstSetting のリスト。

戻り値

void

modifyStpGlobalSettings

ネットワーク要素で STP グローバル設定を変更します。ユーザは、API を使用してプロトコルも変更できます。

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

neInstanceNameId がヌルの場合。

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

modifiedStpGlobalSetting がヌルの場合。

パラメータ

opContext:動作コンテキスト

modifiedStpGlobalSetting:変更済みの StpGlobalSetting。

戻り値

void

modifyStpNetworkInterfaceSettingForMst

スイッチ ポートの特定の MST インスタンスの MST 設定を変更します。デフォルト値にリセットする必要があるフィールドのヌル値を設定します。

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

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

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

インターフェイスに対応するすべての StpNetworkInterfaceSettingForMst アトリビュートが無効である場合。

例:

StpNetworkInterfaceSettingForMst の cost は、値 1 ~ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

settings:StpNetworkInterfaceSettingForMst のリスト

戻り値

void

modifyStpNetworkInterfaceSettingForVlan

スイッチ ポートの特定の VLAN の PVLAN 設定を変更します。デフォルト値にリセットする必要があるフィールドのヌル値を設定します。

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

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

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

インターフェイスに対応するすべての StpNetworkInterfaceSettingForVlan アトリビュートが無効である場合。

例:

StpNetworkInterfaceSettingForVlan の cost は、値 1 ~ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

settings:StpNetworkInterfaceSettingForVlan のリスト

戻り値

void

modifyStpNetworkInterfaceSettings

ネットワーク インターフェイスの STP 設定を変更します。デフォルト値にリセットする必要があるパラメータのヌル値を渡します。

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

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

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

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

すべての StpNetworkInterfaceSetting アトリビュートが無効である場合。

例:

StpNetworkInterfaceSetting の cost は、値 1 ~ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

stpNetworkInterfaceSettings:変更済みの STP 設定のリスト。

戻り値

void

modifyStpSettingForNetworkInterfaces

ネットワーク インターフェイスの特定のコレクションでリンク設定と STP 設定を変更します。デフォルト値にリセットする必要があるフィールドのヌル値を渡します。

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

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

networkInterfaces 内のすべての NetworkInterface オブジェクトに、同等の永続的 NetworkInterface オブジェクトがない場合。

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

インターフェイスに対応するすべての StpNetworkInterfaceSetting または StpLinkSetting アトリビュートが無効である場合。

例:

StpNetworkInterfaceSetting の cost は、値 1 ~ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。

パラメータ

opContext:動作コンテキスト

networkInterfaces:変更済みの StpLinkSetting および StpNetworkInterfaceSetting を持つ NetworkInterface のリスト

戻り値

void

modifyStpType

ネットワーク要素のセットの STP タイプを変更します。

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

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

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

neInstanceNameIds に特定の InstanceNameId がある同等のネットワーク要素オブジェクトがない場合。

protocol がヌルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素の InstanceNameId のリスト。

protocol:STP プロトコル タイプ。

戻り値

void

unbindVlansFromMstInstance

1 つまたは複数の VLAN を MST インスタンスからアンバインドします。

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

mstId がヌルの場合。

mstId がデータベースに同等の MstSetting オブジェクトを持たない場合。

vlanIds がヌルの場合。

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

MstSetting オブジェクトに VLAN が関連付けられていない場合。

MstSetting オブジェクトに関連付けられたすべての VLAN が unbind vlanIds で指定されている場合。

FeatureException は、MstSetting オブジェクトがデフォルトの MST に対応するときにスローされます。

ParameterException は、vlanIds で指定されたすべての VLAN に MstSetting オブジェクトとの既存のアソシエーションがないときにスローされます。

パラメータ

opContext:動作コンテキスト

mstId:MST の InstanceNameId

vlanIds:VLAN ID の範囲(例:1-10,20,35,50-120)。

戻り値

void