- はじめに
- 概要
- AaaApp サービス
- AclApp サービス
- ClusterApp サービス
- CollectorApp サービス
- CollectorExtendedApp サービス
- ConfigTemplateApp サービス
- ConfigArchiveApp サービス
- ConfigDeliveryApp サービス
- DaiApp サービス
- DataPurgingApp サービス
- DeviceGroupApp サービス
- DeviceListApp サービス
- DhcpSnoopingApp サービス
- Dot1xApp サービス
- EtherChannelApp サービス
- EventApp サービス
- FabricPathResourcesApp サービス
- FabricPathTopologyApp サービス
- FcApp サービス
- FcoeApp サービス
- FeatureSetApp サービス
- FexApp サービス
- FipSnoopingApp サービス
- GlbpApp サービス
- HsrpApp サービス
- IgmpSnoopingApp サービス
- ImageInstallApp サービス
- InterfacesApp サービス
- InventoryApp サービス
- IpSourceGuardApp サービス
- KeyChainApp サービス
- Interface L2IsisApp サービス
- LicensingApp サービス
- LogApp サービス
- LstApp サービス
- NacLpIpApp サービス
- ObjectGroupApp サービス
- ObjectTrackingApp サービス
- PollerApp サービス
- PortProfileApp サービス
- PortSecurityApp サービス
- RbacApp サービス
- RepositoryApp サービス
- SecurityApp サービス
- ServerAdminApp サービス
- ServerApp サービス
- SoftwareApp サービス
- SpanApp サービス
- StpApp サービス
- SvsConnectionApp サービス
- SvsDomainApp サービス
- ThresholdActionApp サービス
- TrafficStormControlApp サービス
- TunnelApp サービス
- UserApp サービス
- VdcApp サービス
- VlanApp サービス
- VpcApp サービス
- VrfApp サービス
Cisco DCNM Web サービス API ガイド リリース 5.1(1a)
偏向のない言語
この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
翻訳について
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
- Updated:
- 2017年8月3日
章のタイトル： 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 サービス
StpApp サービスについて
この章では、Spanning Tree Protocol（STP; スパニング ツリー プロトコル）サービス機能によって公開される API を定義します。
bindPvstSettingToVlans
1 つまたは複数の VLAN ID の PVST 設定を適用します。いずれかのプロパティが PvstSetting でヌルとして設定されている場合は、これらのプロパティはデフォルト値に設定されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
bindStpNetworkInterfaceSettingForMstInstances
StpNetworkInterfaceSettingBase を特定のインターフェイスの MST ID の範囲にバインドします。StpNetworkInterfaceSettingBase インスタンスには、有効なインスタンス名が設定されている必要があります。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
networkInterfaceInstanceNameIds がヌル、または空の場合。
• networkInterfaceInstanceNameIds に無効なネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。
• networkInterfaceInstanceNameIds に特定の InstanceNameId がある同等の NetworkInterface オブジェクトがない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• インターフェイスに対応するすべての StpNetworkInterfaceSetting アトリビュートが無効である場合。
• StpNetworkInterfaceSetting の cost は、値 1 ～ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。
networkInterfaceInstanceNameIds：ネットワーク インターフェイスの InstanceNameId のリスト。
mstIds：MST ID の範囲（例：1-10,20,35,50-120）。
bindStpNetworkInterfaceSettingForVlans
StpNetworkInterfaceSettingBase を特定のインターフェイスの VLAN ID の範囲にバインドします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• networkInterfaceInstanceNameIds がヌル、または空の場合。
• networkInterfaceInstanceNameIds に無効なネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。
• networkInterfaceInstanceNameIds に特定の InstanceNameId がある同等の NetworkInterface オブジェクトがない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• インターフェイスに対応するすべての StpNetworkInterfaceSetting アトリビュートが無効である場合。
• StpNetworkInterfaceSetting の cost は、値 1 ～ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。
networkInterfaceInstanceNameIds：ネットワーク インターフェイスの InstanceNameId のリスト。
vlanIds：VLAN ID の範囲（例：1-10,20,35,50-120）。
bindStpNeworkInterfaceSettingsToNetworkInterface
STP 設定を 1 つまたは複数のネットワーク インターフェイスに適用します。StpNetworkInterfaceSetting には、有効なインスタンス名が設定されている必要があります。デフォルト値にリセットする必要があるフィールドではヌル値を渡します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• networkInterfaceInstanceNameIds がヌル、または空の場合。
• networkInterfaceInstanceNameIds に無効なネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。
• networkInterfaceInstanceNameIds に特定の InstanceNameId がある同等の NetworkInterface オブジェクトがない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• インターフェイスに対応するすべての StpNetworkInterfaceSetting アトリビュートが無効である場合。
• StpNetworkInterfaceSetting の cost は、値 1 ～ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。
networkInterfaceInstanceNameIds：ネットワーク インターフェイスの InstanceNameId のリスト。
bindVlansToMstInstance
VLAN ID のセットを MST インスタンスにバインドします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• mstId がデータベースに同等の MstSetting オブジェクトを持たない場合。
createMstInstance
ネットワーク要素で MST インスタンスおよび関連する VLAN を作成します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• vlanInstanceNameIds がヌル、または空の場合。
• vlanInstanceNameIds に無効な VLAN InstanceNameId またはヌル値が含まれている場合。
• vlanInstanceNameIds に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• すべての MstSetting アトリビュートが無効である場合。
• MstSetting の stpHelloTime は、値 1 ～ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• mstInstance がデータベースにすでに存在する場合。
neInstanceNameId：ネットワーク要素の InstanceNameId。
vlanInstanceNameIds：MST インスタンスに関連付ける VLAN の InstanceNameId のリスト。
createMstInstanceByRange
ネットワーク要素のセットで MST インスタンスを作成します。指定された ID を持つ MST インスタンスを作成して、指定された VLAN 範囲に関連付けます。指定された VLAN が存在しない場合は、VLAN は作成されませんが、マッピングは作成されます。
サーバでは、特定の MST 設定について次のアソシエーションが作成されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds がヌル、または空の場合。
• neInstanceNameIds に無効なネットワーク要素 InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等のネットワーク要素オブジェクトがない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• すべての MstSetting アトリビュートが無効である場合。
• MstSetting の instanceId は、値 0 ～ 4094 までの整数でなければなりません。0 未満または 4094 を超える値によって PropertiesException が発生します。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• instanceId に対応する MstSetting がデータベースにすでに存在する場合。
neInstanceNameIds：MST インスタンスが作成されるネットワーク要素の InstanceNameId のリスト。
vlanRange：VLAN ID の範囲。VLAN が存在しない場合は、インスタンス状態が不完全と指定された VLAN を作成します。
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 が含まれている場合。
createMstInstancesInNetworkElement
ネットワーク要素で MST インスタンスを作成します。MST は VLAN なしでは作成できません。
特定の MST 設定について次のアソシエーションが提供されます。
• MST インスタンスにマップされた VLAN アソシエーション
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• mstInstances がヌルであるか、コレクションが空である場合。
• mstInstances に 1 つまたは複数のヌル要素が含まれているか、コレクションにタイプが MstSetting ではないオブジェクトが含まれている場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• すべての MstSetting アトリビュートが無効である場合。
• MstSetting の stpHelloTime は、値 1 ～ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• mstInstances に、データベースにすでに存在する MstSetting が含まれている場合。
deleteMstInstances
MST インスタンスを削除します。動作 STP タイプが MST の場合は、MST インスタンスに対応するすべての VLAN にデフォルトの MST インスタンス 0 が割り当てられます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• mstInstanceNameIds コレクションがヌル、または空の場合。
• mstInstanceNameIds コレクションに、タイプが MstSetting InstanceNameId ではない要素が含まれている場合。
• mstInstanceNameIds コレクションに、データベースに存在しない MstSetting が含まれている場合。
getAllStpSettingsForNetworkInterfaces
STP 設定とともにすべてのポートを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク インターフェイス要素 InstanceNameId ではない場合にスローされます。
ifInstanceNameIdCol：NetworkInterface に対応する InstanceNameId
それぞれの NetworkInterface に次のアソシエーションがあります。
getAllStpStateCountsForVlans
渡されたリスト内の各 VLAN に対応する L2PairForStateCount のリストのリストを戻します。L2PairForStateCount のリストの戻されるリストには、各 STP の状態とそれぞれの stp-state のカウントがあります。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanInstanceNameId に無効な VLAN InstanceNameId またはヌル値が含まれている場合。
• vlanInstanceNameId に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。
getBlockingStpPortsCountInMsts
特定の MST インスタンス ID リストの各 MST に参加している STP ブロッキング ステートを持つポートの数が含まれる整数オブジェクトのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• mstInstanceNameIds がヌル、または空の場合。
• mstInstanceNameIds に無効な MstSetting InstanceNameId またはヌル値が含まれている場合。
• mstInstanceNameIds に特定の InstanceNameId がある同等の MstSetting オブジェクトがない場合。
getBlockingStpPortsCountInVlans
特定の VLAN インスタンス ID リストの各 VLAN に参加している STP ブロッキング ステートを持つポートの数が含まれる整数オブジェクトのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanInstanceNameIds がヌル、または空の場合。
• vlanInstanceNameIds に無効な VLAN InstanceNameId またはヌル値が含まれている場合。
• vlanInstanceNameIds に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。
getForwardingStpPortsCountInMsts
特定の MST インスタンス ID リストの各 MST に参加している STP フォワーディング ステートを持つポートの数が含まれる整数オブジェクトのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• mstInstanceNameIds がヌル、または空の場合。
• mstInstanceNameIds に無効な MstSetting InstanceNameId またはヌル値が含まれている場合。
• mstInstanceNameIds に特定の InstanceNameId がある同等の MstSetting オブジェクトがない場合。
getForwardingStpPortsCountInVlans
特定の VLAN インスタンス ID リストの各 VLAN に参加している STP フォワーディング ステートを持つポートの数が含まれる整数オブジェクトのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanInstanceNameIds がヌル、または空の場合。
• vlanInstanceNameIds に無効な VLAN InstanceNameId またはヌル値が含まれている場合。
• vlanInstanceNameIds に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。
getMstGlobalSettings
特定のネットワーク要素リストの MST グローバル設定を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
neInstanceNameIds：ネットワーク要素の InstanceNameId のリスト。ヌルの場合は、すべてのネットワーク要素の MST グローバル設定を戻します。
getMstIdsInNetwork
ネットワーク要素のリストで設定されている MST の ID を戻します。この API にはアソシエーションは読み込まれません。MST 範囲だけがこの API によって戻されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
neInstanceNameds：MST ID を照会するネットワーク要素の InstanceNameIds。ヌルの場合は、すべての管理対象ネットワーク要素から MST ID を戻します。
getMstInstances
特定の InstanceNameIds に対応する MST インスタンスを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• mstSettingInstanceNameIds がヌル、または空の場合。
• mstSettingInstanceNameIds に無効な MstSetting InstanceNameId またはヌル値が含まれている場合。
• mstSettingInstanceNameIds に特定の InstanceNameId がある同等の MstSetting オブジェクトがない場合。
mstSettingInstanceNameIds：MST インスタンスに対応する InstanceNameId のリスト。
照会される InstanceNameId に対応する MstSetting のリスト。
getMstInstancesInNetwork
ネットワーク要素リストの MST ID リストに対応する MST 設定を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
mstIds：MST ID の範囲（例：1-10,20,35,50-120）。ヌルの場合は、すべての MST を戻します。
neInstanceNameIds：MST ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で MST を戻します。
getNetworkInterfacesWithStpSettings
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
neInstanceNameId：ネットワーク要素の InstanceNameId。
特定のネットワーク要素に存在するインターフェイスのリスト。Nexus 7000 シリーズ スイッチの場合は、レイヤ 2 インターフェイスだけで STP 設定がサポートされるため、戻されるリストには SwitchedNetworkInterface インスタンスだけが含まれます。
NetworkInterface ごとに、次のアソシエーションが使用可能です。
getOperationalStpSettingForVlans
VLAN インスタンス名 ID に対応する StpSetting オブジェクトのリスト（PvstSetting または MstSetting のいずれか）を戻します。ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanInstanceNameIds に無効な VLAN InstanceNameId またはヌル値が含まれている場合。
• 入力 VLAN InstanceNameId の同等の VLAN オブジェクトがない場合。
vlanInstanceNameIds：VLAN InstanceNameId のリスト。
入力 VLAN オブジェクトに対応する StpSetting オブジェクト（MstSetting、PvstSetting）のリスト。
getStpDisabledVlansInNetwork
ネットワーク要素リストの VLAN ID リストに対応する STP ディセーブル VLAN オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
vlanIds：VLAN ID の範囲（例：1-10,20,35,50-120）。ヌルの場合は、すべての VLAN を戻します。
neInstanceNameIds：VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。
• VLAN がプライマリ VLAN である場合は、関連付けられたセカンダリ VLAN
getStpEnabledVlansInNetwork
ネットワーク要素リストの VLAN ID リストに対応する STP イネーブル VLAN オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
vlanIds：VLAN ID の範囲（例：1-10,20,35,50-120）。ヌルの場合は、すべての VLAN を戻します。
neInstanceNameIds：VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。
• VLAN がプライマリ VLAN である場合は、関連付けられたセカンダリ VLAN
getStpGlobalSettings
特定のネットワーク要素リストの STP グローバル設定を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
neInstanceNameIds：ネットワーク要素の InstanceNameId のリスト。ヌルの場合は、すべてのネットワーク要素の STP グローバル設定を戻します。
getStpMode
特定のネットワーク要素リストの STP タイプ リストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds がヌル、または空の場合。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
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 オブジェクトがない場合。
vlanIds：VLAN ID の範囲（ヌルの場合は、すべての VLAN を戻します）。
neInstanceNameIds：VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。
getStpNetworkInterfaceSettings
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• networkInterfaceInstanceNameIds がヌル、または空の場合。
• networkInterfaceInstanceNameIds に無効な NetworkInterface InstanceNameId またはヌル値が含まれている場合。
• networkInterfaceInstanceNameIds に特定の InstanceNameId がある同等の NetworkInterface オブジェクトがない場合。
networkInterfaceInstanceNameIds：ネットワーク インターフェイスの InstanceNameId のリスト。
getStpNetworkInterfaceSettingsForAccessPortsInMst
入力 MST InstanceNameId に対応する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 MST と関連するいずれかの SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForMst オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForMst コレクションは、入力 MST に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。
ValidationException は、渡された引数がヌルの場合、または有効な MstSetting InstanceNameId ではない場合にスローされます。
mstInstanceNameId：MST の InstanceNameId。
SwitchedNetworkInterface ごとに、次のアソシエーションが使用可能です。
• StpNetworkInterfaceSettingForMst のコレクション
SwitchedNetworkInterface ごとに、次のアソシエーションが使用可能です。
getStpNetworkInterfaceSettingsForAllPortsInMst
入力 MST InstanceNameId に対応する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 MST と関連するいずれかの SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForMst オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForMst コレクションは、入力 MST に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。
ValidationException は、渡された引数がヌルの場合、または有効な MstSetting InstanceNameId ではない場合にスローされます。
mstInstanceNameId：MST の InstanceNameId。
SwitchedNetworkInterface ごとに、次のアソシエーションが使用可能です。
getStpRootBridgeStatusForVlansBasedOnDeviceProtocol
VLAN に対応する StpRootBridgeStatus オブジェクトのリストを戻します。デバイスに VLAN がない場合は、StpRootBridgeStatus オブジェクトはヌルとして戻されます。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
vlanIds：VLAN ID の範囲。ヌルの場合は、すべての VLAN を戻します。
neInstanceNameIds：VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。
getStpRootVlansBasedOnDeviceProtocol
渡されるデバイス リストに対応する IntegerRange のリストを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
vlanIds：VLAN ID の範囲。ヌルの場合は、すべての VLAN を戻します。
neInstanceNameIds：VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で VLAN を戻します。
getStpNetworkInterfaceSettingsForPortsInVlan
VLAN に対応する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 VLAN といずれかの SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForVlan オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForVlan コレクションは、入力 VLAN に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。
ValidationException は、渡された引数がヌルの場合、または有効な VLAN InstanceNameId ではない場合にスローされます。
vlanInstanceNameId：VLAN の InstanceNameId。
SwitchedNetworkInterface ごとに、次のアソシエーションが使用可能です。
getStpNetworkInterfaceSettingsForPortsInVlansByInterfaces
vlanRange 内の各 VLAN と、ifInstanceNameIdCol に対応するいずれかの SwitchedNetworkInterface オブジェクトの間に StpNetworkInterfaceSettingVlan アソシエーションが存在する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 VLAN と、ifInstanceNameIdCol に対応する SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForVlan オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForVlan コレクションは、入力 VLAN に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。
ValidationException は、渡された引数がヌルであるか、vlanRange サイズが 0 以下であるときにスローされます。
ifInstanceNameIdCol：SwitchedNetworkInterface
SwitchedNetworkInterface ごとに、次のアソシエーションが使用可能です。
getStpNetworkInterfaceSettingsForTrunkPortsInMst
入力 MST InstanceNameId に対応する SwitchedNetworkInterface オブジェクトのリストを戻します。入力 MST と関連するいずれかの SwitchedNetworkInterfaces の間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForMst オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForMst コレクションは、入力 MST に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。
ValidationException は、渡された引数がヌルの場合、または有効な MstSetting InstanceNameId ではない場合にスローされます。
mstInstanceNameId：MST の InstanceNameId。
SwitchedNetworkInterface ごとに、次のアソシエーションが使用可能です。
getStpNetworkInterfaceSettingsForVlanMemberPortsInMst
入力 MST InstanceNameId に対応する SwitchedNetworkInterface オブジェクトのリストと、vlanRange に対応する各 VLAN のメンバー ポートを戻します。入力 MST といずれかの VLAN メンバー ポートの間に存在する STP 設定情報は、各 SwitchedNetworkInterface オブジェクト内の StpNetworkInterfaceSettingForMst オブジェクトのコレクションとして使用可能です。StpNetworkInterfaceSettingForMst コレクションは、入力 MST に対応する SwitchedNetworkInterface とともに STP 設定情報を使用できない場合はヌルです。
ValidationException は、渡された引数がヌルの場合、または有効な MstSetting InstanceNameId ではない場合にスローされます。
mstInstanceNameId：MST の InstanceNameId
vlanInstanceNameId：VLAN の InstanceNameId
SwitchedNetworkInterface ごとに、次のアソシエーションが使用可能です。
getStpSettingsForMst
ネットワーク要素のリストで MST の STP 設定を戻します。特定の MST およびネットワーク要素リストでは、MstSetting のリストを戻し、すべてのネットワーク要素の STP 設定を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
neInstanceNameIds：照会されるネットワーク要素の InstanceNameId のリスト。
関連する StpRootBridgeStatus を持つ MstSetting のリスト。MST のポートが動作可能ではない場合は、ルート ブリッジ ステータスはヌルです。
getStpSettingsForVlan
ネットワーク要素セットで VLAN の STP 設定（PVRST）を戻します。特定の VLAN およびネットワーク要素リストでは PvstSetting のリストを戻します。ネットワーク要素が指定されていない場合は、すべてのネットワーク要素の STP 設定を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
neInstanceNameIds：照会されるネットワーク要素の InstanceNameId のリスト。
関連する StpRootBridgeStatus を持つ PvstSetting のリスト。VLAN のポートが動作可能ではない場合は、ルート ブリッジ ステータスはヌルです。
getStpStatusForNetworkInterfacesInVlan
vlanInstanceNameId に対応する VLAN と、interfaceInstanceNameIds リストに対応する NetworkInterface の各インスタンスの間に存在する StpNetworkInterfaceSettingForVlan アソシエーションに対応する StpNetworkInterfaceStatus オブジェクトのリストを戻します。デバイスが MST モードで動作している場合は、空のリストが戻されます。ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanInstanceNameId に無効な VLAN InstanceNameId またはヌル値が含まれている場合。
• 入力 VLAN InstanceNameId の同等の VLAN オブジェクトがない場合。
• interfaceInstanceNameIds に無効な NetworkInterface InstanceNameId またはヌル値が含まれている場合。
• 入力 NetworkInterface InstanceNameId の同等の NetworkInterface オブジェクトがない場合。
vlanInstanceNameId：VLAN InstanceNameId。
interfaceInstanceNameIds：NetworkInterface InstanceNameId のリスト。
getStpTopologyInterface
L2NetworkInterfaceSummaryStatus のリストのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• niInstanceNameIds に無効な InstanceNameId 値が含まれている場合。
• 入力 NI InstanceNameId の同等の SNI オブジェクトがない場合。
• vlanRange がヌル、または空の場合。vlan-range に無効な vlanIds が含まれている場合。
niInstanceNameIds：サマリー オブジェクトを照会するネットワーク インターフェイスのインスタンス名 ID。ヌルにはできません。
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 が含まれている場合。
niInstanceNameIds：サマリー オブジェクトを照会するネットワーク インターフェイスのインスタンス名 ID。ヌルにはできません。
getTotalStpPortsCountInMsts
特定の MST インスタンス ID リストの各 MST に参加している STP ステータスを持つポートの数が含まれる整数オブジェクトのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• mstInstanceNameIds がヌル、または空の場合。
• mstInstanceNameIds に無効な MstSetting InstanceNameId またはヌル値が含まれている場合。
• mstInstanceNameIds に特定の InstanceNameId がある同等の MstSetting オブジェクトがない場合。
getTotalStpPortsCountInVlans
特定の VLAN インスタンス ID リストの各 VLAN に参加している STP ステータスを持つポートの数が含まれる整数オブジェクトのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanInstanceNameIds がヌル、または空の場合。
• vlanInstanceNameIds に無効な VLAN InstanceNameId またはヌル値が含まれている場合。
• vlanInstanceNameIds に特定の InstanceNameId がある同等の VLAN オブジェクトがない場合。
getVlansWithPvrstSetting
ネットワーク要素リストの VLAN ID リストに対応する PVRST 設定を持つ VLAN を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds に無効な NetworkElement InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等の NetworkElement オブジェクトがない場合。
vlanIds：VLAN ID の範囲（例：1-10,20,35,50-120）。ヌルの場合は、すべての VLAN を戻します。
neInstanceNameIds：VLAN ID を照会するネットワーク要素のインスタンス名 ID。ヌルの場合は、すべての管理対象ネットワーク要素で MST を戻します。
• VLAN がプライマリ VLAN である場合は、関連付けられたセカンダリ VLAN。
• セカンダリ VLAN の場合は、プライマリ VLAN 参照。
PvstSetting ごとに、次のアソシエーションが使用可能です。
SecondaryVlan ごとに、次のアソシエーションが使用可能です。
modifyMstGlobalSettings
1 つまたは複数のネットワーク要素の MST グローバル設定を変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• modifiedMstGlobalSetting がヌルの場合。
modifyMstInstances
MST インスタンスの設定を変更します。ユーザは設定で MST ID を変更できません。また、スイッチ プライオリティと STP ルート タイプの両方は変更できません。スイッチ プライオリティまたは STP ルート タイプのいずれかを設定できます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• mstInstances がヌルであるか、コレクションが空である場合。
• mstInstances に 1 つまたは複数のヌル要素が含まれているか、コレクションにタイプが MstSetting ではないオブジェクトが含まれている場合。
• mstInstances 内のすべての MstSetting オブジェクトに、同等の永続的 MstSetting オブジェクトがない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• すべての MstSetting アトリビュートが無効である場合。
• MstSetting の stpHelloTime は、値 1 ～ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。
modifyPvstSettings
PVRST インスタンスの設定を変更します。また、スイッチ プライオリティと STP ルート タイプの両方は変更できません。スイッチ プライオリティまたは STP ルート タイプのいずれかを設定できます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• pvstSettings がヌルであるか、コレクションが空の場合。
• pvstSettings に 1 つまたは複数のヌル要素が含まれているか、コレクションにタイプが PvstSetting ではないオブジェクトが含まれている場合。
• pvstSettings 内のすべての PvstSetting オブジェクトに、同等の永続的 PvstSetting オブジェクトがない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• すべての PvstSetting アトリビュートが無効の場合。
• PvstSetting の stpHelloTime は、値 1 ～ 10 までの整数でなければなりません。1 未満または 10 を超える値によって PropertiesException が発生します。
modifyStpGlobalSettings
ネットワーク要素で STP グローバル設定を変更します。ユーザは、API を使用してプロトコルも変更できます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• modifiedStpGlobalSetting がヌルの場合。
modifyStpNetworkInterfaceSettingForMst
スイッチ ポートの特定の MST インスタンスの MST 設定を変更します。デフォルト値にリセットする必要があるフィールドのヌル値を設定します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• インターフェイスに対応するすべての StpNetworkInterfaceSettingForMst アトリビュートが無効である場合。
• StpNetworkInterfaceSettingForMst の cost は、値 1 ～ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。
modifyStpNetworkInterfaceSettingForVlan
スイッチ ポートの特定の VLAN の PVLAN 設定を変更します。デフォルト値にリセットする必要があるフィールドのヌル値を設定します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• インターフェイスに対応するすべての StpNetworkInterfaceSettingForVlan アトリビュートが無効である場合。
• StpNetworkInterfaceSettingForVlan の cost は、値 1 ～ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。
modifyStpNetworkInterfaceSettings
ネットワーク インターフェイスの STP 設定を変更します。デフォルト値にリセットする必要があるパラメータのヌル値を渡します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• stpNetworkInterfaceSettings がヌル、または空の場合。
• stpNetworkInterfaceSettings に無効な StpNetworkInterfaceSetting InstanceNameId またはヌル値が含まれている場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• すべての StpNetworkInterfaceSetting アトリビュートが無効である場合。
• StpNetworkInterfaceSetting の cost は、値 1 ～ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。
modifyStpSettingForNetworkInterfaces
ネットワーク インターフェイスの特定のコレクションでリンク設定と STP 設定を変更します。デフォルト値にリセットする必要があるフィールドのヌル値を渡します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• networkInterfaces がヌル、または空の場合。
• networkInterfaces 内のすべての NetworkInterface オブジェクトに、同等の永続的 NetworkInterface オブジェクトがない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• インターフェイスに対応するすべての StpNetworkInterfaceSetting または StpLinkSetting アトリビュートが無効である場合。
• StpNetworkInterfaceSetting の cost は、値 1 ～ 200000000 までの整数でなければなりません。1 未満または 200000000 を超える値によって PropertiesException が発生します。
networkInterfaces：変更済みの StpLinkSetting および StpNetworkInterfaceSetting を持つ NetworkInterface のリスト
modifyStpType
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIds がヌル、または空の場合。
• neInstanceNameIds に無効なネットワーク要素 InstanceNameId またはヌル値が含まれている場合。
• neInstanceNameIds に特定の InstanceNameId がある同等のネットワーク要素オブジェクトがない場合。
unbindVlansFromMstInstance
1 つまたは複数の VLAN を MST インスタンスからアンバインドします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• mstId がデータベースに同等の MstSetting オブジェクトを持たない場合。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• MstSetting オブジェクトに VLAN が関連付けられていない場合。
• MstSetting オブジェクトに関連付けられたすべての VLAN が unbind vlanIds で指定されている場合。
FeatureException は、MstSetting オブジェクトがデフォルトの MST に対応するときにスローされます。
ParameterException は、vlanIds で指定されたすべての VLAN に MstSetting オブジェクトとの既存のアソシエーションがないときにスローされます。
フィードバック