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

目次

InventoryApp サービス

InventoryApp サービスについて

deleteHostMappingFromModule

getAllChassisInNetwork

getAllNetworkElements

getAllNetworkElementsInLayers

getAllPhysicalLinkInNetwork

getAllPhysicalLinks

getAllPhysicalLinksInNetworkElements

getAsicChipsInChassis

getCardsInChassis

getCardsInChassisByTypes

getCardsWithComputerSystemAssociations

getCdpNeighbors

getChassis

getChassisForNetworkElements

getExtendedChassisInChassis

fetchCurrentSensorsInCard

fetchCurrentSensorsInChassis

getFansInChassis

getFileSystemsInChassis

getNetworkCardsInChassis

getNetworkElementForCard

getNonPortChannelMemberPhysicalLinks

getNonPortChannelMemberPhysicalLinksInNetworkElements

getPhysicalLinks

getPhysicalPorts

getPhysicalPortsInSlot

getPowerSuppliesInChassis

getProcessorCardsInChassis

getSensorsInChassis

getServiceCardsInChassis

getSlotsInChassis

getSlotsInNetworkElement

getSoftwareIdentitiesInNetwork

getSystemUpTime

getVirtualComputerSystemForComputerSystem

getVirtualComputerSystemsAttachedToVirtualCard

modifyChassisPowerRedundancyMode

refreshPowerUsageInfo

InventoryApp サービス

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

InventoryApp サービスについて

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

deleteHostMappingFromModule

モジュールから 1 つまたは複数のホスト マッピングを削除します。カード オブジェクトの InstanceNameId を指定すると、それらのオブジェクトがサーバから削除されます。

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

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

cardCol コレクションに、カードの InstanceNameId タイプではない要素が含まれる場合。

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

パラメータ

opContext:動作コンテキスト。

cardCol:削除する必要がある 1 つまたは複数のカード オブジェクトの InstanceNameId を含むコレクション。

getAllChassisInNetwork

アプリケーションが管理するすべてのシャーシのコレクションを戻します。アプリケーションがシャーシを管理していない場合、空のコレクションを戻します。

パラメータ

opContext:動作コンテキスト。

戻り値

シャーシ オブジェクトのリスト。

シャーシ オブジェクトごとに、次のアソシエーションが使用可能です。

NetworkElement。

スロット コレクション。

RedundancySetting。

RedundancyStatus。

ChassisPowerSupplySetting。

com.cisco.dcbu.dcm.model.physical.chassisPowerSupplyStatus。

getAllNetworkElements

アプリケーションが管理するすべてのデバイスを戻します。アプリケーションがデバイスを管理していない場合、空のコレクションを戻します。

パラメータ

opContext:動作コンテキスト。

戻り値

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

NetworkElemenet オブジェクトごとに、次のアソシエーションが使用可能です。

その NetworkElement のシャーシ アソシエーション

AbstractNetworkElementStatus

getAllNetworkElementsInLayers

アプリケーションが管理するすべてのデバイスの InstanceNameId を、プラットフォーム タイプおよび隣接に基づき、レイヤで整理して戻します。デバイスは、プラットフォーム タイプに基づき、集約スイッチおよびアクセス スイッチに分類されます。戻されるリスト内の各エントリはレイヤを表し、そのレイヤ内のデバイスのリストが含まれます。

パラメータ

opContext:動作コンテキスト。

戻り値

レイヤでグループ化された AbstractNetworkElement の InstanceNameId のコレクション

getAllPhysicalLinkInNetwork

ネットワーク要素に存在する物理リンクのコレクションを戻します。ネットワーク要素の InstanceNameId を指定すると、物理リンク オブジェクトのコレクションを戻します。

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

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

有効だが、存在しないネットワーク要素 InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

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

戻り値

NetworkElement に対応する PhysicalLink オブジェクトのリスト。

PhysicalLink オブジェクトごとに、次のアソシエーションが使用可能です。

PhysicalPort コレクション。

NetworkInterface。

getAllPhysicalLinks

ネットワークに存在する物理リンクのリストを戻します。

パラメータ

opContext:動作コンテキスト。

戻り値

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

getAllPhysicalLinksInNetworkElements

指定したリスト内のネットワーク要素に存在する物理リンクのコレクションを戻します。ネットワーク要素の InstanceNameId のリストを指定すると、物理リンク オブジェクトのコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

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

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

有効だが、存在しないネットワーク要素 InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

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

戻り値

NetworkElement に対応する PhysicalLink オブジェクトのリストのリスト。

PhysicalLink オブジェクトごとに、次のアソシエーションが使用可能です。

PhysicalPort コレクション。

NetworkInterface。

getAsicChipsInChassis

非推奨。AsicChip は、カード レベルでのみ取得できます。ProcessorCard の ASIC チップを取得するには、getProcessorCardInChassis() を使用します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

各シャーシに AsicChip のコレクションが含まれます。シャーシの InstanceNameId を指定すると、AsicChip のコレクションを戻します。

パラメータ

opContext:動作コンテキスト。

chassisId:

戻り値

AsicChip の順序コレクション。

シャーシの有効な存在しない InstanceNameId を入力として渡すと、ヌルを戻します。シャーシに AsicChip が含まれない場合、空のリストを戻します。

getCardsInChassis

指定したシャーシで使用できるカードまたはモジュールのコレクションを戻します。戻されるカード オブジェクトのコレクションには、次のカード オブジェクトのいずれか、またはすべてが含まれます。

ProcessorCard。

NetworkCard。

ServiceCard。

シャーシに上述のカードのいずれも含まれない場合、この API は空のコレクションを戻します。

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

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

シャーシの有効な存在しない InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに存在するすべてのカード オブジェクトのリスト。

カード オブジェクトのタイプに関係なく、カード オブジェクトごとに、次のアソシエーションが使用可能です。

スロット。

CardStatus。

センサー コレクション。

getCardsInChassisByTypes

指定したカード タイプと一致する、指定したシャーシで使用できるカードまたはモジュールのコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。戻されるカード オブジェクトのコレクションには、次のカード オブジェクトのいずれか、またはすべてが含まれます。

ProcessorCard。

NetworkCard。

ServiceCard。

シャーシに上述のカードのいずれも含まれない場合、この API は空のコレクションを戻します。

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

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

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

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに存在する、指定したカード タイプのすべてのカード オブジェクトのリスト。

カード オブジェクトのタイプに関係なく、カード オブジェクトごとに、次のアソシエーションが使用可能です。

スロット。

CardStatus。

センサー コレクション。

getCardsWithComputerSystemAssociations

指定したシャーシで使用できるカードまたはモジュールのリストのリストを戻します。戻されるカード オブジェクトのコレクションには、次のカード オブジェクトのいずれか、またはすべてが含まれます。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。戻されるカード オブジェクトのコレクションには、次のカード オブジェクトのいずれか、またはすべてが含まれます。

ProcessorCard。

NetworkCard。

ServiceCard。

シャーシに上述のカードのいずれも含まれない場合、この API は空のコレクションを戻します。

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

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

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

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに存在する、指定したカード タイプのすべてのカード オブジェクトのリスト。

カード オブジェクトのタイプに関係なく、カード オブジェクトごとに、次のアソシエーションが使用可能です。

スロット。

CardStatus。

NetworkCard タイプの AbstractComputerSystem。

getCdpNeighbors

ネットワーク要素に物理的に接続されているネットワーク要素のコレクションを戻します。ネットワーク要素の InstanceNameId を指定すると、ネットワーク要素オブジェクトのリストを戻します。

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

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

パラメータ

opContext:動作コンテキスト。

srcInstanceNameId:NetworkElement の InstanceNameId。

戻り値

入力した NetworkElement と物理リンクを持つ NetworkElement オブジェクトのリスト。

NetworkElement オブジェクトごとに、次のアソシエーションが使用可能です。

シャーシ。

getChassis

アプリケーションが管理するシャーシ オブジェクトのコレクションを戻します。シャーシの InstanceNameId のリストを指定すると、シャーシ オブジェクトのコレクションを戻します。

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

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

シャーシの InstanceNameId コレクションが空の場合、またはこのコレクションに、シャーシの無効な InstanceNameId が含まれる場合

パラメータ

opContext:動作コンテキスト。

chassisIds:シャーシの InstanceNameId のリスト。

戻り値

シャーシ オブジェクトのリスト。

シャーシ オブジェクトごとに、次のアソシエーションが使用可能です。

NetworkElement。

スロット コレクション。

RedundancySetting。

ChassisPowerSupplySetting。

getChassisForNetworkElements

指定したリスト内のネットワーク要素に存在するシャーシのコレクションを戻します。ネットワーク要素の InstanceNameId のリストを指定すると、シャーシのコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

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

有効だが、存在しないネットワーク要素 InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

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

戻り値

シャーシ オブジェクトのリスト。

シャーシ オブジェクトごとに、次のアソシエーションが使用可能です。

NetworkElement。

スロット コレクション。

RedundancyStatus。

ChassisPowerSupplySetting

ChassisPowerSupplyStatus

getExtendedChassisInChassis

指定したシャーシ オブジェクトに接続されているすべての ExtendedChassis オブジェクトのコレクションを戻します。

シャーシに接続されている拡張シャーシがない場合、空のリストを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

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

引数がヌルまたは空のリストの場合。

引数にシャーシの有効な InstanceNameId が含まれない場合

シャーシの有効な存在しない InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

chassisIdCol:シャーシ オブジェクトの InstanceNameId のリスト。

戻り値

シャーシに対応する ExtendedChassis オブジェクトのリストのリスト。

ExtendedChassis オブジェクトごとに、次のアソシエーションが使用可能です。

ExtendedChassis

fetchCurrentSensorsInCard

カードの InstanceNameId を指定すると、それに関連付けられているセンサーを戻します。センサーには、現在の温度、メジャーしきい値、マイナーしきい値、およびセンサー ステータスに関する詳細が含まれます。

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

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

カードの InstanceNameId が無効の場合。

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

パラメータ

opContext:動作コンテキスト。

cardInstanceNameId:カードの InstanceNameId

戻り値

カードに関連付けられているセンサーのリスト。

センサー オブジェクトごとに、次のアソシエーションが使用可能です。

しきい値。

SensorStatus。

SensorDataType。

fetchCurrentSensorsInChassis

シャーシの InstanceNameId のコレクションを指定すると、それに関連付けられているセンサーを戻します。センサーには、現在の温度、メジャーしきい値、マイナーしきい値、およびセンサー ステータスに関する詳細が含まれます。

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

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

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

パラメータ

opContext:動作コンテキスト。

chassisInstanceNameId:シャーシの InstanceNameId のリスト

戻り値

シャーシに関連付けられているセンサーのリスト。

センサー オブジェクトごとに、次のアソシエーションが使用可能です。

しきい値。

SensorStatus。

SensorDataType。

getFansInChassis

シャーシに存在するすべてのファンのコレクションを戻します。シャーシの InstanceNameId を指定すると、ファン オブジェクトのコレクションを戻します。シャーシにファン装置が含まれない場合、この API は空のコレクションを戻します。

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

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

シャーシの有効な存在しない InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに存在するファン オブジェクトのリスト。

ファン オブジェクトごとに、次のアソシエーションが使用可能です。

センサー コレクション。

シャーシ。

FanStatus。

getFileSystemsInChassis

非推奨。

シャーシに存在するすべてのファイル システムのコレクションを戻します。シャーシの InstanceNameId を指定すると、ファイル システム オブジェクトのコレクションを戻します。シャーシにファイル システムが 1 つも含まれない場合、この API は空のコレクションを戻します。

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

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

シャーシの有効な存在しない InstanceNameId が渡された場合。

各シャーシに FileSystems のコレクションが含まれる場合があります。戻されるコレクションには、入力したシャーシ ID に関連する FileSystem のリストが含まれます。

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに対応する FileSystem オブジェクトのリスト。

getNetworkCardsInChassis

シャーシに存在するすべてのネットワーク カードのコレクションを戻します。シャーシの InstanceNameId を指定すると、ネットワーク カード オブジェクトのコレクションを戻します。シャーシにネットワーク カードが含まれない場合、空のコレクションが戻されます。

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

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

シャーシの有効な存在しない InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに存在する NetworkCard オブジェクトのリスト。

NetworkCard オブジェクトごとに、次のアソシエーションが使用可能です。

スロット。

その NetworkCard のカード サブカード コレクション(存在する場合)。

その NetworkCard の AsicChip コレクション(存在する場合)。

NetworkCardEtherChannelLoadBalanceSetting。

getNetworkElementForCard

NetworkElement のコレクションを戻します。カードの InstanceNameId のリストを指定すると、対応するネットワーク要素のコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

パラメータ

opContext:動作コンテキスト

cardInstanceNameIds:カードの InstanceNameId。

戻り値

NetworkElement のコレクションを戻します。

getNonPortChannelMemberPhysicalLinks

ポート チャネルのメンバー ポートを持たない、存在する物理リンクのリストを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

パラメータ

opContext:動作コンテキスト

戻り値

ネットワークで検出された PhysicalLink のリスト

getNonPortChannelMemberPhysicalLinksInNetworkElements

ポート チャネルのメンバー ポートを持たない、指定したリスト内のネットワーク要素に存在する物理リンクのリストのリストを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:NetworkElement の InstanceNameId のリスト。

戻り値

指定したネットワーク要素内に存在する PhysicalLink のリスト

getPhysicalLinks

2 つのネットワーク要素間に存在する物理リンクのコレクションを戻します。2 つのネットワーク要素の InstanceNameId を指定すると、この API は、物理リンク オブジェクトのコレクションを戻します。

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

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

パラメータ

opContext:動作コンテキスト。

srcInstanceNameId:NetworkElement の InstanceNameId。

destInstanceNameId:NetworkElement の InstanceNameId。

戻り値

ネットワーク要素間に存在する物理リンクに対応する PhysicalLink オブジェクトのリスト。

物理リンク オブジェクトごとに、次のアソシエーションが使用可能です。

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

getPhysicalPorts

シャーシの特定スロットに存在する物理ポートのコレクションを戻します。シャーシの InstanceNameId およびスロット番号を指定すると、物理ポート オブジェクトのコレクションを戻します。

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

渡したシャーシの InstanceNameId がヌルの場合、またはシャーシの有効な InstanceNameId ではない場合。

シャーシの有効な存在しない InstanceNameId を渡した場合

渡したスロット番号がヌルの場合。

パラメータ

opContext:動作コンテキスト。

aChassisInstanceNameId:シャーシの InstanceNameId。

slotNumber:整数のスロット番号。

戻り値

シャーシおよび slotNumber に対応する PhysicalPort オブジェクトのリスト。

PhysicalPort オブジェクトごとに、次のアソシエーションが使用可能です。

NetworkInterface

カード

getPhysicalPortsInSlot

シャーシの特定スロットに存在する物理ポートのコレクションを戻します。シャーシの InstanceNameId およびスロット番号を指定すると、物理ポート オブジェクトのコレクションを戻します。

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

渡したシャーシの InstanceNameId がヌルの場合、またはシャーシの有効な InstanceNameId ではない場合。

シャーシの有効な存在しない InstanceNameId が渡された場合。

渡したスロット番号がヌルの場合。

パラメータ

opContext:動作コンテキスト。

aChassisInstanceNameId:シャーシの InstanceNameId。

slotNumber:整数のスロット番号。

戻り値

シャーシおよび slotNumber に対応する PhysicalPort オブジェクトのリスト。

PhysicalPort オブジェクトごとに、次のアソシエーションが使用可能です。

NetworkInterface。

カード。

getPowerSuppliesInChassis

シャーシに存在するすべての電源装置のコレクションを戻します。シャーシの InstanceNameId を指定すると、電源装置オブジェクトのコレクションを戻します。シャーシに電源装置が含まれない場合、この API は空のコレクションを戻します。

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

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

シャーシの有効な存在しない InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに存在する PowerSupply オブジェクトのリスト。

PowerSupply オブジェクトごとに、次のアソシエーションが使用可能です。

センサー コレクション。

シャーシ。

PowerSupplyStatus コレクション。

getProcessorCardsInChassis

シャーシに存在するすべてのプロセッサ カードのコレクションを戻します。シャーシの InstanceNameId を指定すると、プロセッサ カード オブジェクトのコレクションを戻します。シャーシにプロセッサ カードが含まれない場合、この API は空のコレクションを戻します。

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

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

シャーシの有効な存在しない InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシ内の ProcessorCard オブジェクトのリスト。

ProcessorCard オブジェクトごとに、次のアソシエーションが使用可能です。

SoftwareIdentity。

スロット。

その ProcessorCard のカード サブカード コレクション(存在する場合)。

その ProcessorCard の AsicChip コレクション(存在する場合)。

getSensorsInChassis

シャーシに存在するすべてのセンサーのコレクションを戻します。シャーシの InstanceNameId を指定すると、センサー オブジェクトのコレクションを戻します。シャーシにセンサーが含まれない場合、この API は空のコレクションを戻します。

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

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

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

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに対応するセンサー オブジェクトのリスト。

センサー オブジェクトごとに、次のアソシエーションが使用可能です。

しきい値。

SensorStatus。

SensorDataType。

getServiceCardsInChassis

シャーシに存在するすべてのサービス カードのコレクションを戻します。シャーシの InstanceNameId を指定すると、サービス カード オブジェクトのコレクションを戻します。シャーシにサービス カードが含まれない場合、この API は空のコレクションを戻します。

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

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

シャーシの有効な存在しない InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

chassisId:シャーシの InstanceNameId。

戻り値

シャーシに存在する ServiceCard オブジェクトのリスト。

ServiceCard オブジェクトごとに、次のアソシエーションが使用可能です。

スロット。

その ServiceCard のカード サブカード コレクション(存在する場合)

その ServiceCard の AsicChip コレクション(存在する場合)

getSlotsInChassis

指定したシャーシで使用できるスロットのコレクションを戻します。シャーシにスロットが含まれない場合、この API は空のコレクションを戻します。

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

シャーシの InstanceNameId がヌルの場合、またはシャーシの有効な InstanceNameId ではない場合

パラメータ

opContext:動作コンテキスト。

chassisInstanceNameId:シャーシの InstanceNameId。

戻り値

入力したシャーシの InstanceNameId に対応するスロット オブジェクトのリスト。

スロット オブジェクトごとに、次のアソシエーションが使用可能です。

各スロット オブジェクトに対応するシャーシ アソシエーション。

getSlotsInNetworkElement

Catalyst 6500 シリーズ スイッチの場合、デバイスに存在するスロットが戻されます。Nexus 7000 シリーズ スイッチの場合、VDC に存在するスロットが戻されます。Nexus 7000 シリーズ スイッチの場合、仮想ネットワーク要素に存在するスロットのスロット番号のコレクションが戻されます。Catalyst 6500 シリーズ スイッチの場合、デバイスに存在するスロットのスロット番号のコレクションが戻されます。

パラメータ

opContext:動作コンテキスト。

aneInstanceNameId:AbstractNetworkElement の InstanceNameId。

戻り値

SlotNumbers のリスト

getSoftwareIdentitiesInNetwork

ネットワーク要素に存在するアクティブ プロセッサ カードからすべてのソフトウェア ID のコレクションを戻します。ネットワーク要素の InstanceNameId のリストを指定すると、この API は、アクティブ プロセッサ カードから収集されたソフトウェア ID のコレクションを戻します。

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

ネットワーク要素の InstanceNameId コレクションがヌルまたは空の場合、あるいはこのコレクションに、ネットワーク要素または仮想ネットワーク要素の InstanceNameId が含まれない場合。

パラメータ

opContext:動作コンテキスト。

aneInstanceNameIds:NetworkElement の InstanceNameId のリスト。

戻り値

NetworkElement または VirtualNetworkElement に対応する SoftwareIdentity オブジェクトのリスト

getSystemUpTime

非推奨。

指定したシャーシの InstanceNameId に関連するデバイスのシステム動作時間を戻します。シャーシの InstanceNameId を渡した順番と同じ順番で、システム動作時間が戻されます。

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

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

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

パラメータ

opContext:動作コンテキスト。

chassisInstanceNameIds:シャーシの InstanceNameId のリスト

戻り値

システム動作時間を含むリスト。

getVirtualComputerSystemForComputerSystem

指定したリスト内のコンピュータ システムに存在する仮想コンピュータ システムのコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

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

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

有効だが、存在しないコンピュータ システム InstanceNameId が渡された場合。

パラメータ

opContext:動作コンテキスト。

compSystemsIdCol:コンピュータ システムの InstanceNameId のリスト

戻り値

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

VirtualComputerSystem オブジェクトごとに、次のアソシエーションが使用可能です。

NetworkInterface コレクション。

AbstractComputerSystemStatus。

getVirtualComputerSystemsAttachedToVirtualCard

指定したリスト内のカードに対応付けられている VirtualComputerSystem のコレクションを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

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

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

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

パラメータ

opContext:動作コンテキスト

cardIdCol:カードの InstanceNameId。

戻り値

VirtualComputerSystem のコレクションを戻します。

オブジェクトごとに、次のアソシエーションが使用可能です。

ComputerSystem

AbstractComputerSystemStatus

NetworkInterface コレクション。

modifyChassisPowerRedundancyMode

シャーシの電源装置の電源冗長性モードを変更します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

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

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

chassisId コレクションが空の場合、またはこのコレクションに、有効なシャーシ オブジェクトではないオブジェクトが含まれる場合

パラメータ

opContext:動作コンテキスト。

chassisCol:変更対象の電源装置冗長性モードを含むシャーシ オブジェクトのリスト。

戻り値

変更済みの冗長性モードを含むシャーシのリスト。

refreshPowerUsageInfo

指定したデバイスの最新の電源使用情報をアップデートします。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチに対して使用できます。

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

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

chassisId コレクションが空の場合、またはこのコレクションに、有効なシャーシ オブジェクトではないオブジェクトが含まれる場合

パラメータ

opContext:動作コンテキスト。

chassisInstanceNameIds:シャーシの InstanceNameId のリスト