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

目次

InterfacesApp サービス

InterfacesApp サービスについて

createLoopbackNetworkInterfaces

createRoutedSubNetworkInterfaces

createVirtualSwitchedNetworkInterfaces

createVlanNetworkInterfaces

deleteLogicalNetworkInterfaces

disableLldpService

disableSviService

disableUdldService

enableLldpService

enableSviService

enableUdldService

fetchCurrentTransceiverStatusForPorts

getAclAssociations

getActiveRoutedPortsCountInNetworkElement

getActiveSwitchedPortsCountInNetworkElement

getAdminDownRoutedPortsCountInNetworkElement

getAdminDownSwitchedPortsCountInNetworkElement

getAllFibreChannelInterfacesInNetworkElement

getAllInterfacesInNetworkElement

getAllMgmtInterfaces

getAllVirtualEthernetPorts

getControlInterfaces

getErrorDetectionSettings

getErrorRecoverySettings

getIpAclAssociationsForNetworkInterface

getLldpGlobalSetting

getLldpSettingsForNetworkInterface

getLogicalInterfacesInNetworkElement

getLoopbackInterfacesInNetworkElement

getMacAclAssociationsForNetworkInterface

getMgmtInterfaces

getMissingPortGroupMembers

getNetworkInterfaces

getNetworkInterfacesByName

getNetworkInterfaceSettings

getOperDownRoutedPortsCountInNetworkElement

getOperDownSwitchedPortsCountInNetworkElement

getPortsInCards

getPortsInModule

getPortsInNetworkElement

getPortStatusSummary

getPortsWithErrorVlanAssociations

getPortsWithFabricPortStatusAssociations

getPortsWithLogicalIntfAssociation

getPortsWithLsgAssociations

getPortsWithPortChannelAssociations

getPortsWithSecurityAssociations

getPortsWithSpanAssocations

getPortsWithVlanAssociations

getPortUsedForDiscovery

getRoutedPortsInModule

getRoutedPortsInNetworkElement

getRoutedPortsWithSecurityAssociations

getRoutedSubNetworkInterfacesInNetworkElement

getSubInterfacesForRoutedNetworkInterface

getSviServiceStateForNetworkElements

getSvsVirtualEthGlobalSetting

getSwicthedPortsCountInModule

getSwitchedPortsInModule

getSwitchedPortsInModuleByMode

getSwitchedPortsInNetworkElement

getSwitchedPortsWithSecurityAssociations

getSystemDefaultSettings

getTotalPortsCountInNetworkElement

getTotalRoutedPortsCountInNetworkElement

getTotalSwitchedPortsCountInNetworkElement

getTunnelInterfacesInNetworkElement

getUdldServiceStateForNetworkElements

getVirtualEthernetPortsInNetworkElement

getVirtualPortsInCard

getVirtualPortsInVirtualComputerSystem

getVirtualPortsWithNoCardAssoc

getVlanNetworkInterfacesInNetworkElement

modifyAdminStateForNetworkInterfaces

modifyErrorDetectionSettingInNetworkElement

modifyErrorRecoverySettingInNetworkElement

modifyNetworkInterfaces

modifyNetworkInterfaceSetting

modifyPortModeToRouted

modifyPortModeToSwitched

modifyRoutedSubNetworkInterfaces

modifySvsVethGlobalSettingInNetworkElement

modifySwitchPortMode

modifySystemDefaultSetting

InterfacesApp サービス

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

InterfacesApp サービスについて

この章では、InterfacesApp サービス機能が公開している API について詳しく説明します。

createLoopbackNetworkInterfaces

ネットワーク要素に 1 つまたは複数のループバック インターフェイス オブジェクトを作成します。

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

neInstanceNameId がヌルの場合。

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

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

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

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

loopBackIns コレクションで、LoopBackNetworkInterface アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素のインスタンス名 ID。

loopbackIns:作成する必要があるループバック オブジェクト。

戻り値

新しく作成されたループバック インターフェイス オブジェクトのインスタンス名 ID。

createRoutedSubNetworkInterfaces

ルーテッド物理インターフェイスに対し 1 つまたは複数のルーテッド サブインターフェイス オブジェクトを作成します。

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

niId がヌルの場合。

niId が有効な InstanceNameId ではない場合。

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

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

InstanceNameId に対応するオブジェクトがデータベースに存在しない場合。

カプセル化 VLAN(Vlan)アソシエーションを作成せずに、インターフェイスに IP アドレス(Ipv4AddressPrefix)を設定しようとした場合。

設定対象の IP アドレス(Ipv4AddressPrefix)が、デバイスに存在する他のレイヤ 3 インターフェイスのプライマリまたはセカンダリ IP アドレスと重複する場合。

設定対象のカプセル化 VLAN(Vlan)が使用できない場合、または他のインターフェイスですでに使用されている場合。

カプセル化 VLAN を指定せずに、カプセル化方式(SubInterfaceEncapsulationType)を設定した場合。

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

subInfs コレクションで、RoutedSubNetworkInterface アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

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

niId:RoutedNetworkInterface のインスタンス名 ID。

subInfs:作成する必要がある RoutedSubNetworkInterface オブジェクトのリスト。

戻り値

新しく作成されたルーテッド サブネットワーク インターフェイス オブジェクトのインスタンス名 ID。

createVirtualSwitchedNetworkInterfaces

ネットワーク要素に 1 つまたは複数の仮想スイッチド インターフェイス オブジェクトを作成します。

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

neInstanceNameId がヌルの場合。

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

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

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

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

vsnifs コレクションで、VirtualSwitchedNetworkInterface アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素のインスタンス名 ID。

vsnifs:作成する必要がある vsni オブジェクト。

戻り値

新しく作成された vsni インターフェイス オブジェクトのインスタンス名 ID。

createVlanNetworkInterfaces

ネットワーク要素に 1 つまたは複数の VLAN インターフェイス(SVI)オブジェクトを作成します。

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

neInstanceNameId がヌルの場合。

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

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

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

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

vlanIns コレクションで、VlanNetworkInterface アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素のインスタンス名 ID。

vsnifs:作成する必要がある vsni オブジェクト。

戻り値

新しく作成された SVI オブジェクトのインスタンス名 ID。

deleteLogicalNetworkInterfaces

1 つまたは複数の既存のレイヤ 3 論理ネットワーク インターフェイス オブジェクトを削除します。このメソッドは、次の論理インターフェイスに対して使用できます。

ループバック インターフェイス

SVI

ルーテッド サブネットワーク インターフェイス

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

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

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

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素のインスタンス名 ID。

戻り値

void

disableLldpService

デバイスの LldpService をディセーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、それらの要素で lldp がディセーブルになります。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:lldp をディセーブルにする AbstractNetworkElement の InstanceNameId のリスト。

戻り値

void

disableSviService

指定したデバイス ID に関連する SVI サービスをディセーブルにします。

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

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

neInstanceNameIdCol コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

void

disableUdldService

指定したデバイス ID に関連する UDLD サービスをディセーブルにします。

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

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

neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

void

enableLldpService

デバイスの LldpService をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、それらの要素で lldp がイネーブルになります。この API は、デバイスで「lldp 機能」オプションをグローバルにイネーブルにするための API です。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:AbstractNetworkElement の InstanceNameId のリスト。

戻り値

void

enableSviService

指定したデバイス ID に関連する SVI サービスをイネーブルにします。

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

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

neInstanceNameIdCol コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

void

enableUdldService

指定したデバイス ID に関連する UDLD サービスをイネーブルにします。

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

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

neInstanceNameIdCol コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

void

fetchCurrentTransceiverStatusForPorts

すべてのトランシーバ ステータス アソシエーションを読み込んだネットワーク インターフェイス オブジェクトのリストを戻します。

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

パラメータ

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

ifInstanceNameIdCol:NetworkInterface に対応する InstanceNameId

戻り値

セキュリティ アソシエーションを読み込んだ NetworkInterface インスタンスのリスト。

インターフェイスごとに次のアソシエーションが読み込まれます(指定したインターフェイスに対しアソシエーションが存在する場合)。

sfpStatusRef

sfpDiagnosticsThresoldStatusRef

networkInterfaceNameRef

getAclAssociations

指定したインターフェイス オブジェクトに対応する ACL アソシエーション オブジェクトのインターフェイスのコレクションを戻します。

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

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

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

指定したネットワーク インターフェイスに関連付けられている AclAppliesToNetworkInterface オブジェクトのセット。

次のオブジェクトが AclAppliesToNetworkInterface アソシエーションの他のエンドで読み込まれます。

1. AccessControlList

getActiveRoutedPortsCountInNetworkElement

デバイスに存在するアクティブ ルーテッド ポートの数を戻します。

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

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

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

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

戻り値

ポートの数。

getActiveSwitchedPortsCountInNetworkElement

デバイスに存在する、指定したスイッチ ポート モードのアクティブ スイッチド ポートの数を戻します。

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

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

mode がヌルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

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

戻り値

ポートの数。

getAdminDownRoutedPortsCountInNetworkElement

デバイスに存在する管理上ダウン状態のルーテッド ポートの数を戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

戻り値

ポートの数。

getAdminDownSwitchedPortsCountInNetworkElement

デバイスに存在する、指定したスイッチ ポート モードの、管理上ダウン状態のスイッチド ポートの数を戻します。

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

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

mode がヌルの場合

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

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

戻り値

ポートの数。

getAllFibreChannelInterfacesInNetworkElement

ネットワーク要素に存在するすべてのタイプのファイバ チャネル インターフェイスを戻します。ネットワーク要素のインスタンス名 ID を指定すると、インターフェイス オブジェクトのコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

className:インターフェイスの完全修飾クラス名。

戻り値

デバイスに存在するすべてのインターフェイスのリスト。

getAllInterfacesInNetworkElement

ネットワーク要素に存在するすべてのタイプのインターフェイスを戻します。ネットワーク要素のインスタンス名 ID を指定すると、インターフェイス オブジェクト(物理インターフェイスと論理インターフェイスの両方)のコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

戻り値

デバイスに存在するすべてのインターフェイスのリスト。

getAllMgmtInterfaces

指定した neInstanceNameIdCol に対応する mgmt インターフェイスのリストのリストを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

戻り値

デバイスに存在するすべてのインターフェイスのリスト。

getAllVirtualEthernetPorts

デバイスに存在するすべての仮想ポートを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

slotNo:ポートが必要なモジュールのスロット番号。

戻り値

モジュールに存在する SwitchedNetworkInterface インスタンスのセット。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getControlInterfaces

指定したリスト内のデバイスの ControlNetworkInterface を戻します。neInstanceNameIdCol に対応する NetworkElement に ControlNetworkInterface が含まれない場合、戻されるリストにヌル エントリが含まれる場合があります。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:ネットワーク要素に対応する InstanceNameId。

戻り値

デバイスに存在するコントロール インターフェイスのリスト。

getErrorDetectionSettings

リスト内のネットワーク要素のポート エラー検出設定のコレクションを戻します。

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

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

neInstanceNameIds コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

指定したリスト内のデバイスの PortErrorDisableDetectionSetting のリスト。他のアソシエーションは取得できません。

getErrorRecoverySettings

リスト内のネットワーク要素のポート エラー回復設定のコレクションを戻します。

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

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

neInstanceNameIds コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

指定したリスト内のデバイスの PortErrorDisableRecoverySetting のリスト。他のアソシエーションは取得できません。

getIpAclAssociationsForNetworkInterface

指定したインターフェイス オブジェクトに対応する、IP ACL アソシエーション オブジェクトのインターフェイスのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

interfaceId:RoutedNetworkInterface に対応する InstanceNameId。

戻り値

指定したネットワーク インターフェイスに関連付けられている AclAppliesToNetworkInterface オブジェクトのリスト。

次のオブジェクトが AclAppliesToNetworkInterface アソシエーションの他のエンドで読み込まれます。

AccessControlList

getLldpGlobalSetting

LldpGlobalSetting オブジェクトのリストを戻します。各 LldpGlobalSetting オブジェクトには、ブール アトリビュートの lldpServiceEnable が読み込まれ、該当デバイスで LLDP サービスがイネーブルであるか、またはディセーブルであるかが示されます。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:ネットワーク要素に対応する InstanceNameId。

戻り値

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

getLldpSettingsForNetworkInterface

リスト内のネットワーク インターフェイスに関連付けられている LLDP 設定オブジェクトのリストを戻します。

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

パラメータ

opContext:動作コンテキスト

interfaceIdCol:NetworkInterface に対応する InstanceNameId。

戻り値

LldpSetting のインスタンス

getLogicalInterfacesInNetworkElement

ネットワーク要素に存在するすべての論理インターフェイスを戻します。ネットワーク要素のインスタンス名 ID を指定すると、論理インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

ネットワーク要素に存在するすべての論理インターフェイスのリスト。次のインターフェイスが戻されます。

SVI。

トンネル インターフェイス。

ループバック インターフェイス。

ポート チャネル。

getLoopbackInterfacesInNetworkElement

ネットワーク要素に存在するすべてのループバック インターフェイスを戻します。ネットワーク要素のインスタンス名 ID を指定すると、ループバック インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

ネットワーク要素に存在するすべての LoopBackNetworkInterface のリスト

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

NetworkInterfaceName

NetworkInterfaceStatus

getMacAclAssociationsForNetworkInterface

指定したインターフェイス オブジェクトに対応する、MAC ACL アソシエーション オブジェクトのインターフェイスのコレクションを戻します。

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

パラメータ

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

interfaceId:SwitchedNetworkInterface に対応する InstanceNameId。

戻り値

指定したネットワーク インターフェイスに関連付けられている AclAppliesToNetworkInterface オブジェクトのリスト。

getMgmtInterfaces

指定したリスト内のデバイスに関連する MgmtNetworkInterface を戻します。neInstanceNameIdCol に対応する NetworkElement に MgmtNetworkInterface が含まれない場合、戻されるリストにヌル エントリが含まれる場合があります。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:ネットワーク要素に対応する InstanceNameId。

戻り値

デバイスに存在する Mgmt インターフェイスのリスト。

getMissingPortGroupMembers

指定したリスト内のインターフェイス InstanceNameId で欠落しているポート グループ メンバーのリストを戻します。指定したリストにポート グループのすべてのメンバーが含まれる場合、または指定したインターフェイスがポート グループのメンバーではない場合、空のリストを戻します。

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

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

interfaceIds に NetworkInterface の無効な InstanceNameId またはヌル値が含まれる場合。

interfaceIds に、特定の InstanceNameId を持つ同等の NetworkInterface オブジェクトが存在しない場合。

パラメータ

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

interfaceId:SwitchedNetworkInterface に対応する InstanceNameId。

戻り値

RoutedNetworkInterface オブジェクトのリストを戻します。

インターフェイスごとに、次のアソシエーションが使用可能です。その他のすべてのアソシエーションはクリアされます。

NetworkInterfaceName

NetworkInterfaceStatus

PortCapability

getNetworkInterfaces

指定したリスト内のインターフェイス ID に関連するネットワーク インターフェイス オブジェクトのコレクションを戻します。

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

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

interfaceIds コレクションが空の場合、またはこのコレクションに、ネットワーク インターフェイスの有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

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

interfaceId:SwitchedNetworkInterface に対応する InstanceNameId。

戻り値

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

物理ポートの場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

ルーテッド ポートの場合、ルーテッド サブネットワーク インターフェイス

ルーテッド サブネットワーク インターフェイスの場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

カプセル化 VLAN

論理インターフェイス(ポートチャネル、SVI、ループバック)の場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

getNetworkInterfacesByName

NetworkInterface の名前または範囲を指定すると、NetworkInterface オブジェクトのリストを戻します。

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

パラメータ

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

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

interfaceRange:戻すインターフェイスの名前または範囲。

戻り値

指定した interfaceRange に対応する NetworkInterface オブジェクトのリスト。

getNetworkInterfaceSettings

指定したリスト内のデバイス ID に関連するネットワーク インターフェイスのグローバル設定のコレクションを戻します。

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

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

neInstanceNameIds コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

指定したリスト内のデバイスの NetworkInterfaceSetting のリスト。アソシエーションは取得できません。

getOperDownRoutedPortsCountInNetworkElement

デバイスに存在する動作上ダウン状態のルーテッド ポートの数を戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId。

戻り値

ポートの数。

getOperDownSwitchedPortsCountInNetworkElement

デバイスに存在する、指定したスイッチ ポート モードの、動作上ダウン状態のスイッチド ポートの数を戻します。

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

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

mode がヌルの場合

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

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

戻り値

ポートの数

getPortsInCards

カードに存在する SwitchedNetworkInterface インスタンスと RoutedNetworkInterface インスタンスのリストを戻します。

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

パラメータ

opContext:動作コンテキスト

cardInstanceNameIdCol:リスト内のカードに対応する InstanceNameId。

戻り値

カードに存在する SwitchedNetworkInterface インスタンスと RoutedNetworkInterface インスタンスのリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

ルーテッド ポートの場合、ルーテッド サブネットワーク インターフェイス

ルーテッド サブネットワーク インターフェイスの場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation

getPortsInModule

指定したスロットのモジュールに存在するすべての物理ポートを戻します。ネットワーク要素のインスタンス名 ID およびモジュールのスロット番号を指定すると、そのモジュールに対応する物理インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

slotNo:ポートが必要なモジュールのスロット番号。

戻り値

モジュールに存在する SwitchedNetworkInterface インスタンスと RoutedNetworkInterface インスタンスのリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

ルーテッド ポートの場合、ルーテッド サブネットワーク インターフェイス

ルーテッド サブネットワーク インターフェイスの場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation

getPortsInNetworkElement

ネットワーク要素に存在するスイッチド物理インターフェイス オブジェクトとルーテッド物理インターフェイス オブジェクトのコレクションを戻します。ネットワーク要素のインスタンス名 ID を指定すると、インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

デバイスに存在する SwitchedNetworkInterface インスタンスと RoutedNetworkInterface インスタンスのリスト。戻されるオブジェクト リストでは、次のアソシエーションだけが使用可能で、その他のアソシエーションはすべてクリアされます。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

ルーテッド ポートの場合、ルーテッド サブネットワーク インターフェイス

ルーテッド サブネットワーク インターフェイスの場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

VLAN

getPortStatusSummary

スイッチド ポートとルーテッド ポートの両方のステータス サマリーを戻します。このステータス サマリーには、動作上アップ/ダウン状態、および管理上アップ/ダウン状態であるポートの数と、スイッチド/ルーテッド ポートの総数が含まれます。

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

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

neInstanceNameIds コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId

interfaceType:NetworkInterfaceType。

戻り値

スイッチド ポートとルーテッド ポートのリスト。

getPortsWithErrorVlanAssociations

エラー VLAN アソシエーションを読み込んだスイッチド ネットワーク インターフェイス オブジェクトのリストを戻します。

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

パラメータ

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

interfaceIdCol:SwitchedNetworkInterface に対応する InstanceNameId。

戻り値

SwitchedNetworkInterface のインスタンス。

getPortsWithFabricPortStatusAssociations

fabricPortStatus アソシエーションを読み込んだネットワーク インターフェイス オブジェクトを戻します。

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

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

interfaceIds に NetworkInterface の無効な InstanceNameId またはヌル値が含まれる場合。

interfaceIds に、特定の InstanceNameId を持つ同等の NetworkInterface オブジェクトが存在しない場合。

パラメータ

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

interfaceIdCol:SwitchedNetworkInterface に対応する InstanceNameId。

戻り値

NetworkInterface のインスタンス。

getPortsWithLogicalIntfAssociation

論理インターフェイス アソシエーションを読み込んだネットワーク インターフェイス オブジェクトのリストを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

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

interfaceIdCol:SwitchedNetworkInterface に対応する InstanceNameId。

戻り値

NetworkInterface のインスタンス。

getPortsWithLsgAssociations

LinkStateGroupAppliesToSwitchedNetworkInterface アソシエーションを読み込んだスイッチド ネットワーク インターフェイス オブジェクトを戻します。

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

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

interfaceIds に、SwitchedNetworkInterface の無効な InstanceNameId またはヌル値が含まれる場合。

interfaceIds に、特定の InstanceNameId を持つ同等の SwitchedNetworkInterface オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceIds:LinkStateGroupAppliesToSwitchedNetworkInterface アソシエーションが必要な SwitchedNetworkInterface オブジェクトの InstanceNameId オブジェクトのリスト。

戻り値

リンクステート グループ アソシエーションを読み込んだ SwitchedNetworkInterface オブジェクトのリストを戻します。

getPortsWithPortChannelAssociations

ポートチャネル アソシエーションを読み込んだネットワーク インターフェイス オブジェクトを戻します。

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

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

interfaceIds に NetworkInterface の無効な InstanceNameId またはヌル値が含まれる場合。

interfaceIds に、特定の InstanceNameId を持つ同等の NetworkInterface オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceIds:ポートチャネル アソシエーションが必要な SwitchedNetworkInterface オブジェクトと RoutedNetworkInterface オブジェクトの InstanceNameId オブジェクトのリスト。

戻り値

ポートチャネル アソシエーションを読み込んだ SwitchedNetworkInterface オブジェクトと RoutedNetworkInterface オブジェクトのリストを戻します。

getPortsWithSecurityAssociations

すべてのセキュリティ アソシエーションを読み込んだネットワーク インターフェイス オブジェクトのリストを戻します。

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

パラメータ

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

interfaceIdCol:NetworkInterface に対応する InstanceNameId。

戻り値

セキュリティ アソシエーションを読み込んだ NetworkInterface インスタンスのリスト。

インターフェイスごとに、次のアソシエーションが読み込まれます(指定したインターフェイスに対しアソシエーションが存在する場合)。

CtsNetworkInterfaceSetting

Dot1xNetworkInterfaceSetting

IpSourceGuardSetting

TrafficStormControlSetting

ポート セキュリティ設定。このアソシエーションでは、VLAN 詳細は読み込まれません。

getPortsWithSpanAssocations

指定したネットワーク インターフェイスに関連する SPAN アソシエーションを読み込んだネットワーク インターフェイス オブジェクトを戻します。

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

パラメータ

opContext:動作コンテキスト

interfaceIdCol:NetworkInterface に対応する InstanceNameId。

戻り値

SPAN アソシエーションを読み込んだ NetworkInterface のインスタンス。

getPortsWithVlanAssociations

VLAN アソシエーションを読み込んだスイッチド ネットワーク インターフェイス オブジェクトのリストを戻します。

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

パラメータ

opContext:動作コンテキスト

interfaceIdCol:SwitchedNetworkInterface に対応する InstanceNameId。

戻り値

SwitchedNetworkInterface のインスタンス

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

アクセス VLAN、ネイティブ VLAN、Voice VLAN を含む SwitchedNetworkInterfaceBelongsToVlan

PromiscuousPvlanMapping プライマリ VLAN および対応するセカンダリ VLAN

上記のアソシエーションの一部として使用できる VLAN ごとに、次のアソシエーションが読み込まれます。

プライマリ VLAN の場合は VLAN コレクション

セカンダリ VLAN の場合は VLAN リファレンス

getPortUsedForDiscovery

neInstanceNameId に対応するネットワーク要素の管理 IP アドレスと等しい IP アドレス(IPv4 または IPv6 プライマリ アドレス)を持つネットワーク インターフェイスのインスタンスを戻します。

neInstanceNameId がヌルの場合、ValidationException がスローされます。

パラメータ

opContext:動作コンテキスト

eInstanceNameId:NetworkElement のインスタンス ID。

戻り値

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

getRoutedPortsInModule

指定したスロットのモジュールに存在するすべてのルーテッド物理ポートを戻します。ネットワーク要素のインスタンス名 ID およびモジュールのスロット番号を指定すると、指定したモジュールに対応するルーテッド インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

slotNo:ポートが必要なモジュールのスロット番号。

戻り値

モジュールに存在する RoutedNetworkInterface インスタンスのリスト

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

ルーテッド ポートの場合、ルーテッド サブネットワーク インターフェイス

ルーテッド サブネットワーク インターフェイスの場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

カプセル化 VLAN

getRoutedPortsInNetworkElement

デバイスに存在するすべてのルーテッド物理ポートを戻します。ネットワーク要素のインスタンス名 ID を指定すると、デバイスに存在するルーテッド インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId。

戻り値

モジュールに存在する RoutedNetworkInterface インスタンスのセット

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

ルーテッド ポートの場合、ルーテッド サブネットワーク インターフェイス

ルーテッド サブネットワーク インターフェイスの場合、次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

カプセル化 VLAN

getRoutedPortsWithSecurityAssociations

すべてのセキュリティ アソシエーションを読み込んだルーテッド ネットワーク インターフェイス オブジェクトを戻します。

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

パラメータ

opContext:動作コンテキスト

interfaceIdCol:RoutedNetworkInterface に対応する InstanceNameId。

戻り値

セキュリティ アソシエーションを読み込んだ RoutedNetworkInterface のインスタンス。インターフェイスごとに、次のアソシエーションが読み込まれます。

CtsNetworkInterfaceSetting

Dot1xNetworkInterfaceSetting

getRoutedSubNetworkInterfacesInNetworkElement

ネットワーク要素に存在するすべてのルーテッド サブインターフェイス オブジェクトを戻します。ネットワーク要素のインスタンス名 ID を指定すると、ルーテッド サブインターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

void

getSubInterfacesForRoutedNetworkInterface

ルーテッド ポートに関連付けられているすべてのルーテッド サブインターフェイス オブジェクトを戻します。物理ルーテッド ポートのインスタンス名 ID を指定すると、それに関連付けられているルーテッド サブインターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

routedInfId:ルーテッド インターフェイスの InstanceNameId。

戻り値

ルーテッド ポートに関連付けられているすべての RoutedSubNetworkInterface オブジェクトのリスト。

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

NetworkInterfaceName

NetworkInterfaceStatus

Vlan

getSviServiceStateForNetworkElements

指定したデバイス ID に関連する SVI サービスの状態(イネーブルまたはディセーブル)を表すブールのコレクションを戻します。Cat6k デバイスの場合、SVI サービス状態はヌルです。

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

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

neInstanceNameIdCol コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId。

戻り値

指定したリスト内のデバイスの SVI サービスの状態を表すブール値のリスト。

getSvsVirtualEthGlobalSetting

1 つまたは複数のネットワーク要素のデバイス レベルの SvsVirtualEthGlobalSetting を戻します。1 つまたは複数のネットワーク要素の InstanceNameId を指定すると、それらのネットワーク要素に対応する SvsVirtualEthGlobalSetting オブジェクトを戻します。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:1 つまたは複数の AbstractNetworkElement オブジェクトの InstanceNameId

戻り値

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

getSwicthedPortsCountInModule

指定したスロットのデバイスに存在するすべてのスイッチド ポートを戻します。ネットワーク要素のインスタンス名 ID およびモジュールのスロット番号を指定すると、指定したモジュールに対応するスイッチド インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

slotNo:ポートが必要なモジュールのスロット番号

戻り値

モジュールに存在する SwitchedNetworkInterface インスタンスのセット。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getSwitchedPortsInModule

指定したスロットのデバイスに存在するすべてのスイッチド ポートを戻します。ネットワーク要素のインスタンス名 ID およびモジュールのスロット番号を指定すると、指定したモジュールに対応するスイッチド インターフェイス オブジェクトのコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

slotNo:ポートが必要なモジュールのスロット番号

戻り値

モジュールに存在する SwitchedNetworkInterface インスタンスのセット。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getSwitchedPortsInModuleByMode

指定したスロットのモジュールに存在する特定スイッチド ポートを戻します。ネットワーク要素のインスタンス名 ID、モジュールのスロット番号、およびスイッチポート モードを指定すると、指定したモジュールおよびモードに対応するスイッチド インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

slotNo:ポートが必要なモジュールのスロット番号

mode:スイッチ ポート モード。mode がヌルの場合、モジュールに存在する、すべてのモードのスイッチ ポートが戻されます。

戻り値

モジュールに存在する SwitchedNetworkInterface インスタンスのリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getSwitchedPortsInNetworkElement

指定したモードのモジュールに存在する特定スイッチド ポートを戻します。ネットワーク要素のインスタンス名 ID およびスイッチポート モードを指定すると、指定したモードのスイッチド インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

mode:スイッチ ポート モード。mode がヌルの場合、モジュールに存在する、すべてのモードのスイッチ ポートが戻されます。

戻り値

モジュールに存在する SwitchedNetworkInterface インスタンスのリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

getSwitchedPortsWithSecurityAssociations

すべてのセキュリティ アソシエーションを読み込んだスイッチド ネットワーク インターフェイス オブジェクトのリストを戻します。

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

パラメータ

opContext:動作コンテキスト

interfaceIdCol:SwitchedNetworkInterface に対応する InstanceNameId

戻り値

セキュリティ アソシエーションを読み込んだ SwitchedNetworkInterface のインスタンス。

インターフェイスごとに、次のアソシエーションが読み込まれます。

CtsNetworkInterfaceSetting

Dot1xNetworkInterfaceSetting

IpSourceGuardSetting

TrafficStormControlSetting

ポート セキュリティ設定。このアソシエーションでは、VLAN 詳細は読み込まれません。

getSystemDefaultSettings

指定したリスト内のデバイス ID に関連するシステム デフォルト設定のコレクションを戻します。

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

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

neInstanceNameIds コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId

戻り値

指定したリスト内のデバイスの SystemDefaultSettings のリスト。

getTotalPortsCountInNetworkElement

デバイスに存在する物理ポートの数を戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId

戻り値

物理ポートの数。

getTotalRoutedPortsCountInNetworkElement

デバイスに存在するルーテッド ポートの数を戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId

戻り値

物理ポートの数。

getTotalSwitchedPortsCountInNetworkElement

デバイスに存在する、指定したスイッチ ポート モードのスイッチド ポートの数を戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId

mode:スイッチド ネットワーク インターフェイス モード

戻り値

物理ポートの数。

getTunnelInterfacesInNetworkElement

ネットワーク要素に存在するすべてのトンネル インターフェイスを戻します。ネットワーク要素のインスタンス名 ID を指定すると、トンネル インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId

戻り値

ネットワーク要素に存在するすべてのトンネルのリスト。

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

NetworkInterfaceName

NetworkInterfaceStatus

getUdldServiceStateForNetworkElements

指定したデバイス ID に関連する UDLD サービスの状態(イネーブルまたはディセーブル)を表すブールのコレクションを戻します。Cat6k デバイスの場合、UDLD サービス状態はヌルです。

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

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

neInstanceNameIdCol コレクションが空の場合、またはこのコレクションに、ネットワーク要素の有効な InstanceNameId ではないオブジェクトが含まれる場合

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId

戻り値

指定したリスト内のデバイスに関連する UDLD サービスの状態を表すブールのリスト。

getVirtualEthernetPortsInNetworkElement

ネットワーク要素に存在する、指定したモードの特定仮想イーサネット ポートを戻します。ネットワーク要素のインスタンス名 ID およびスイッチポート モードを指定すると、指定したモードの仮想インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

neInstanceNameIds:ネットワーク要素に対応する InstanceNameId

mode:スイッチ ポート モード。mode がヌルの場合、モジュールに存在する、すべてのモードの仮想スイッチド ポートが戻されます。

戻り値

モジュールに存在する SwitchedNetworkInterface インスタンスのリスト。

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

NetworkInterfaceName

NetworkInterfaceStatus

getVirtualPortsInCard

指定したリスト内のカードに存在する仮想イーサネット ポートのリストを戻します。

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

渡された引数がヌルの場合、または有効な InstanceNameId ではない場合

有効だが、存在しないカード InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト

cardIdCol:リスト内のカードに対応する InstanceNameId

戻り値

カードに存在する VirtualSwitchedNetworkInterface インスタンスのリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

VirtualLink

仮想リンクでは、次のアソシエーションが使用可能です。

NetworkInterface コレクション。

getVirtualPortsInVirtualComputerSystem

指定したリスト内の仮想コンピュータ システムに関連付けられている仮想イーサネット ポートのリストを戻します。

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

渡された引数がヌルの場合、または有効な InstanceNameId ではない場合

有効だが、存在しないカード InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト

vmIdCol:リスト内の仮想コンピュータ システム ID に対応する InstanceNameId

戻り値

指定した VM(VirtualComputerSystem)に関連付けられている VirtualSwitchedNetworkInterface インスタンスのリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

VirtualLink

仮想リンクでは、次のアソシエーションが使用可能です。

NetworkInterface コレクション。

getVirtualPortsWithNoCardAssoc

カード アソシエーションを含まない仮想イーサネット ポートのリストを戻します。これらは、ユーザが作成した仮想イーサネット ポートです。

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

渡された引数がヌルの場合、または有効な InstanceNameId ではない場合

有効だが、存在しないカード InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト

neIdCol:リスト内の ANE に対応する InstanceNameId

戻り値

カード参照がヌルの VirtualSwitchedNetworkInterface インスタンスのリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

VirtualLink

仮想リンクでは、次のアソシエーションが使用可能です。

NetworkInterface コレクション。

getVlanNetworkInterfacesInNetworkElement

ネットワーク要素に存在するすべての VLAN ネットワーク インターフェイス(SVI)を戻します。ネットワーク要素のインスタンス名 ID を指定すると、VLAN インターフェイス オブジェクトのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

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

戻り値

ネットワーク要素に存在するすべての VlanNetworkInterface のリスト。

次のアソシエーションが使用可能です。

NetworkInterfaceName

NetworkInterfaceStatus

modifyAdminStateForNetworkInterfaces

ネットワーク インターフェイスの管理状態を指定した状態にアップデートします。パラメータとしてポート チャネル ネットワーク インターフェイスを渡すと、この API は、そのメンバー ポートの管理状態を同じ状態にアップデートします。

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

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

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

パラメータ

opContext:動作コンテキスト

niInstanceNameIds:InstanceNameId

status:管理ステータス

戻り値

void

modifyErrorDetectionSettingInNetworkElement

指定したネットワーク要素 ID に関連する既存のエラー検出設定を変更します。

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

neInstanceNameId がヌルの場合。

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

modifiedErrorDetection がヌルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

modifiedErrorDetection:変更対象の PortErrorDisableDetectionSetting

戻り値

void

modifyErrorRecoverySettingInNetworkElement

指定したネットワーク要素 ID に関連する既存のエラー検出設定を変更します。

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

neInstanceNameId がヌルの場合。

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

modifiedErrorRecovery がヌルの場合。

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

recoveryInterval で、アトリビュートが無効の場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

modifiedErrorRecovery:変更対象の PortErrorDisableRecoverySetting。

戻り値

void

modifyNetworkInterfaces

1 つまたは複数の物理および論理インターフェイス(ポートチャネルを除く)オブジェクトを変更します。インターフェイスが IpNetworkInterface の一種の場合、セカンダリおよびヘルパー IP アドレス コレクションがアップデートされます。インターフェイスでモードが変更される場合(スイッチドからルーテッド、またはルーテッドからスイッチド)、AbstractNetworkElement リファレンスを設定する必要があります。

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

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

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

modifiedNetworkInterfaceCol に、AbstractNetworkElement アソシエーションを含まない 1 つまたは複数の NetworkInterface オブジェクトが含まれる場合。

modifiedNetworkInterfaceCol に、SwitchedEtherChannelNetworkInterface タイプまたは RoutedEtherChannelNetworkInterface タイプのオブジェクトが含まれる場合。ポートチャネルは、この API ではサポートされていません。

設定対象の IP アドレス(Ipv4AddressPrefix)が、デバイスに存在する他のレイヤ 3 インターフェイスのプライマリまたはセカンダリ IP アドレスと重複する場合。

変更対象のインターフェイスが RoutedSubNetworkInterface の場合、次の状況では ValidationException が発生します。

カプセル化 VLAN(Vlan)アソシエーションを作成せずに、インターフェイスに IP アドレス(Ipv4AddressPrefix)を設定しようとした場合。

設定対象のカプセル化 VLAN(Vlan)が使用できない場合、または他のインターフェイスですでに使用されている場合。

カプセル化 VLAN を指定せずに、カプセル化方式(SubInterfaceEncapsulationType)を設定した場合。

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

modifiedNetworkInterfaceCol コレクションで、NetworkInterface アトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

modifiedNetworkInterfaceCol:

戻り値

void

modifyNetworkInterfaceSetting

指定したネットワーク要素 ID に関連するネットワーク インターフェイスのグローバル設定を変更します。

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

neInstanceNameId がヌルの場合。

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

modifiedNetInt がヌルの場合。

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

jumboMtu で、アトリビュートが無効の場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素に対応する InstanceNameId

modifiedNetInt:

戻り値

void

modifyPortModeToRouted

指定したネットワーク インターフェイスのポート モードをスイッチドからルーテッドに変更します。サーバでこのメソッドを呼び出すと、すべてのレイヤ 2 アソシエーションが、デバイス プラットフォームに基づきクリアまたは保持されます。残りのアソシエーションは、新しいオブジェクトに再度関連付けられます。古いオブジェクトに存在するすべてのアトリビュートが新しいオブジェクトに割り当てられます。

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

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

switchedInterfaceNameIdCol コレクションに、SwitchedNetworkInterface InstanceName id タイプではないオブジェクトが含まれる場合。

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

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

jumboMtu で、アトリビュートが無効の場合。

パラメータ

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

switchedInterfaceNameIdCol:ネットワーク要素に対応する InstanceNameId

戻り値

新しく作成されたルーテッド ポートのリスト。

modifyPortModeToSwitched

指定したネットワーク インターフェイスのポート モードをルーテッドからスイッチドに変更します。サーバでこのメソッドを呼び出すと、すべてのレイヤ 3 アソシエーションが、デバイス プラットフォームに基づきクリアまたは保持されます。残りのアソシエーションは、新しいオブジェクトに再度関連付けられます。古いオブジェクトに存在するすべてのアトリビュートが新しいオブジェクトに割り当てられます。

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

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

routedInterfaceNameIdCol コレクションに、RoutedNetworkInterface InstanceName id タイプではないオブジェクトが含まれる場合。

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

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

jumboMtu で、アトリビュートが無効の場合。

パラメータ

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

routedInterfaceNameIdCol:ルーテッド ポートのインスタンス名 ID のリスト。

switchPortMode:スイッチポート モード。

trunkMode:トランク ポート モード。このモードに基づいて、トランクのカプセル化と非ネゴシエーションは対応するデフォルトに設定されます。トランク モードがスタティックの場合、カプセル化は dot1q に変更され、非ネゴシエーションは true に変更されます。

戻り値

新しく作成されたルーテッド ポートのリスト。

modifyRoutedSubNetworkInterfaces

1 つまたは複数の既存のルーテッド サブインターフェイス オブジェクトを変更します。

次のアソシエーションがアップデートされます。

ポート設定

カプセル化 VLAN

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

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

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

カプセル化 VLAN(Vlan)アソシエーションを作成せずに、インターフェイスに IP アドレス(Ipv4AddressPrefix)を設定しようとした場合。

設定対象の IP アドレス(Ipv4AddressPrefix)が、デバイスに存在する他のレイヤ 3 インターフェイスのプライマリまたはセカンダリ IP アドレスと重複する場合。

設定対象のカプセル化 VLAN(Vlan)が使用できない場合、または他のインターフェイスですでに使用されている場合。

カプセル化 VLAN を指定せずに、カプセル化方式(SubInterfaceEncapsulationType)を設定した場合。

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

subInfs コレクションで、RoutedSubNetworkInterface アトリビュートが有効ではない場合。

パラメータ

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

modifiedRoutedSubNetworkInfs:変更対象の RoutedSubNetworkInterface オブジェクトのリスト。

戻り値

void

modifySvsVethGlobalSettingInNetworkElement

指定したネットワーク要素 ID に関連する SvsVirtualEthGlobalSetting を変更します。

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

neInstanceNameId がヌルの場合。

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

modifiedSetting がヌルの場合。

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

subInfs コレクションで、RoutedSubNetworkInterface アトリビュートが有効ではない場合。

パラメータ

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

neInstanceNameId

modifiedSetting:

戻り値

void

modifySwitchPortMode

指定したリスト内のスイッチ ポートのスイッチ ポート モードを変更します。これにより、新しいスイッチ ポート モードを指定できます。この API は、新しいインスタンス名 ID を再作成しません。この API は、指定した新しいアトリビュートを既存のオブジェクトに適用します。ポート モードをトランク モードに変更する場合、トランク モードを指定できます。トランク モードを指定しないと、デフォルト トランク モードはスタティック モードに変更されます。ポート モードをトランク以外のモードに変更する場合、トランク モードは無視されます。

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

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

switchedInterfaceNameIdCol コレクションに、SwitchedNetworkInterface InstanceName id タイプではないオブジェクトが含まれる場合。

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

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

subInfs コレクションで、RoutedSubNetworkInterface アトリビュートが有効ではない場合。

パラメータ

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

switchedInterfaceNameIdCol:ルーテッド ポートのインスタンス名 ID のリスト

switchPortMode:新しいスイッチポート モード

trunkMode:トランク ポート モード。これは、モードをトランク モードに変更する場合に限り適用できます。このモード セットに基づいて、トランクのカプセル化と非ネゴシエーションは対応するデフォルトに設定されます。トランク モードがスタティックの場合、カプセル化は dot1q(インターフェイスでサポートされている場合)に変更され、非ネゴシエーションは true に変更されます。同様に、トランク モードを dynamic auto または desirable に変更する場合、非ネゴシエーションは false に設定され、カプセル化は negotiate(インターフェイスでサポートされている場合)に設定されます。

戻り値

void

modifySystemDefaultSetting

指定したネットワーク要素 ID に関連するシステム デフォルト設定を変更します。システム デフォルト状態の変更は、次のタイプのネットワーク要素のインスタンスに影響します。

SwitchedNetworkInterface

SwitchedEtherChannelNetworkInterface

RoutedNetworkInterface


) SystemDefaultSetting の switchPortModeEnabled アトリビュートを変更すると、その特定デバイスの再検出がトリガーされます。


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

sysDefaultSettingsCol がヌルの場合。

sysDefaultSettingsCol が空の場合。

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

subInfs コレクションで、RoutedSubNetworkInterface アトリビュートが有効ではない場合。

パラメータ

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

sysDefaultSettingsCol:保持する変更対象設定のコレクション

戻り値

void