Cisco DCNM Web Services API ガイド Release 4.0
InventoryApp サービス
InventoryApp サービス
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

InventoryApp サービス

InventoryApp サービスの概要

getAllChassisInNetwork

getAllNetworkElements

getAllPhysicalLinkInNetwork

getAllPhysicalLinks

getCardsInChassis

getCdpNeighbors

getChassis

getCurrentSensorsInCard

getCurrentSensorsInChassis

getFansInChassis

getFileSystemsInChassis

getNetworkCardsInChassis

getPhysicalLinks

getPhysicalPorts

getPhysicalPortsInSlot

getPowerSuppliesInChassis

getProcessorCardsInChassis

getSensorsInChassis

getServiceCardsInChassis

getSlotsInChassis

getSlotsInNetworkElement

getSoftwareIdentitiesInNetwork

getSystemUpTime

InventoryApp サービス

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

InventoryApp サービスの概要

この章では、インベントリ サービス機能によって公開される API を定義します。

getAllChassisInNetwork

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

パラメータ

opContext ― 動作可能なコンテキスト

戻り値

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

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

NetworkElement

スロット コレクション

RedundancySetting

RedundancyStatus

ChassisPowerSupplySetting

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

getAllNetworkElements

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

パラメータ

opContext ― 動作可能なコンテキスト

戻り値

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

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

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

AbstractNetworkElementStatus

getAllPhysicalLinkInNetwork

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

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

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

戻り値

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

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

PhysicalPort コレクション

NetworkInterface

getAllPhysicalLinks

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

パラメータ

opContext ― 動作可能なコンテキスト

戻り値

PhysicalLink オブジェクトのリスト

getCardsInChassis

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

ProcessorCard

NetworkCard

ServiceCard

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

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

chassisId ― シャーシの InstanceNameId

戻り値

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

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

スロット

CardStatus

センサ コレクション

getCdpNeighbors

ネットワーク要素に物理的に接続されたネットワーク要素のコレクションを戻します。ネットワーク要素の InstanceNameId の場合、ネットワーク要素オブジェクトのコレクションを戻します。

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

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

パラメータ

opContext ― 動作可能なコンテキスト

srcInstanceNameId ― NetworkElement の InstanceNameId

戻り値

入力 NetworkElement と物理リンクがある NetworkElement オブジェクトのリスト

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

シャーシ

getChassis

アプリケーションによって管理されるシャーシ オブジェクトのコレクションを戻します。シャーシ InstanceNameId のリストの場合、シャーシ オブジェクトのコレクションを戻します。

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

chassisIds ― シャーシの InstanceNameId のリスト

戻り値

Chassis オブジェクトのリスト

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

NetworkElement.

スロット コレクション

RedundancySetting

ChassisPowerSupplySetting

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

getCurrentSensorsInCard

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

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

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

Card InstanceNameId が無効の場合

存在しない有効な Card InstanceNameId が渡される場合

パラメータ

opContext ― 動作可能なコンテキスト

cardInstanceNameId ― Card InstanceNameId

戻り値

カードに関連付けられたセンサのリスト

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

しきい値

SensorStatus

SensorDataType

getCurrentSensorsInChassis

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

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

chassisInstanceNameId ― Chassis InstanceNameId のリスト

戻り値

シャーシに関連付けられたセンサのリスト

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

しきい値

SensorStatus

SensorDataType

getFansInChassis

シャーシに存在するすべてのファンのコレクションを戻します。シャーシの InstanceNameId の場合、ファン オブジェクトのコレクションを戻します。シャーシに上記のファン ユニットのいずれも含まれない場合、この API は空のコレクションを戻します。

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

chassisId ― シャーシの InstanceNameId

戻り値

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

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

センサ コレクション

シャーシ

FanStatus

getFileSystemsInChassis

非推奨。

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

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

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

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

Chassis ごとに FileSystems のコレクションがあります。戻されたコレクションには、その入力シャーシ ID の FileSystems のリストが含まれます。

パラメータ

opContext ― 動作可能なコンテキスト

chassisId ― シャーシの InstanceNameId

戻り値

Chassis に対応する FileSystem オブジェクトのリスト

getNetworkCardsInChassis

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

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

chassisId ― シャーシの InstanceNameId

戻り値

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

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

スロット

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

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

NetworkCardEtherChannelLoadBalanceSetting

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 ― 整数のスロット番号

戻り値

Chassis および slotNumber に対応する PhysicalPort オブジェクトのリスト

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

NetworkInterface

カード

getPhysicalPortsInSlot

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

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

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

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

渡されたスロット番号がヌルの場合

パラメータ

opContext ― 動作可能なコンテキスト

aChassisInstanceNameId ― シャーシの InstanceNameId

slotNumber ― 整数のスロット番号

戻り値

Chassis および 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 ― Chassis の InstanceNameId

戻り値

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

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

スロット オブジェクトごとのシャーシ アソシエーション

getSlotsInNetworkElement

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

パラメータ

opContext ― 動作可能なコンテキスト

aneInstanceNameId ― AbstractNetworkElement の InstanceNameId

戻り値

SlotNumbers リスト

getSoftwareIdentitiesInNetwork

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

aneInstanceNameIds ― NetworkElement の InstanceNameId のリスト

戻り値

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

getSystemUpTime

非推奨。

特定のシャーシ InstanceNameIds のデバイスのシステム アップタイムを戻します。システム アップタイムは、シャーシ InstanceNameIds が渡されるのと同じ順で戻されます。

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

chassisInstanceNameIds ― Chassis InstanceNameId のリスト

戻り値

システム アップタイムを含んだリスト