Web Services API Guide, Cisco DCNM for LAN, Release 5.x
InventoryApp Service
Downloads: This chapterpdf (PDF - 164.0KB) The complete bookPDF (PDF - 11.08MB) | Feedback

InventoryApp Service

Table Of Contents

InventoryApp Service

Information About InventoryApp Service

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 Service


This chapter describes the DCNM web services' API methods for the InventoryApp service.

Information About InventoryApp Service

This chapter defines the APIs exposed by the Inventory service feature.

deleteHostMappingFromModule

Deletes one or more Host Mapping from a Modules. Given the InstanceNameId of the Card objects, those objects will be deleted from the server.

ValidationException is thrown if any of the following situation occurs:

If cardCol collection is null or it is empty.

If cardCol collection contains an element that is not of type Card InstanceNameId.

If cardCol collection contains a Card that does not exist in the database.

Parameters

opContext—operational context.

cardCol—a collection that contains InstanceNameId of one or more Card objects that needs to be deleted.

getAllChassisInNetwork

Returns a collection of all the Chassis managed by the application. Return an empty collection when no chassis is managed by the application.

Parameters

opContext—Operational context.

Return Value

List of Chassis object.

Following associations will be available for each Chassis object:

NetworkElement.

Slot collection.

RedundancySetting.

RedundancyStatus.

ChassisPowerSupplySetting.

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

getAllNetworkElements

Returns all the Devices managed by the application. Returns empty collection when no devices are managed by application.

Parameters

opContext—Operational context.

Return Value

A collection of NetworkElement objects.

Following association will be available for each NetworkElemenet object:

Chassis association for that NetworkElement

AbstractNetworkElementStatus

getAllNetworkElementsInLayers

Returns InstanceNameId of all the devices managed by the application, arranged in layers based on platform type and adjacency. The devices are classified as aggregation and access switches based on platform type. Each entry in the returned list represents a layer and contains the list of devices in that layer.

Parameters

opContext—Operation Context

Returns

A collection of InstanceNameId of AbstractNetworkElement grouped in layers

getAllPhysicalLinkInNetwork

Returns a collection of physical links present in a network element. Given InstanceNameId of the network element, returns a collection of physical link objects.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid network element InstanceNameId

If a valid non-existing network element InstanceNameId is passed.

Parameters

opContext—Operational context.

neInstanceNameId—InstanceNameId of the network element.

Return Value

List of PhysicalLink objects corresponding to NetworkElement.

Following association will be available for each PhysicalLink objects:

PhysicalPort collection.

NetworkInterface.

getAllPhysicalLinks

Returns list of Physical Links present in the network.

Parameters

opContext—Operational context.

Return Value

List of PhysicalLink objects.

getAllPhysicalLinksInNetworkElements

Returns a collection of physical links present in the given list of network elements. Given a list of InstanceNameId of the network elements, returns a collection of physical link objects.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid network element InstanceNameId

If a valid non-exixting network element InstanceNameId is passed.

Parameters

opContext—Operational context.

neInstanceNameIdCol—list of InstanceNameId of the network element.

Returns

List of List of PhysicalLink objects corresponding to NetworkElement.

Following association will be available for each PhysicalLink objects:

PhysicalPort collection.

NetworkInterface.

getAsicChipsInChassis

Deprecated. AsicChip can only be obtain on Card level. Use getProcessorCardInChassis() to obtain asic chips in ProcessorCards.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Each Chassis will have a collection of AsicChips. Given the InstanceNameId of the chassis, returns a collection of AsicChips.

Parameters

opContext—Operational context.

chassisId—

Returns

Ordered collection of AsicChips.

Returns null, when a valid non-existing chassis InstanceNameId is passed as input. Returns an empty list, when the chassis doesnot contain any AsicChips.

getCardsInChassis

Returns a collection of cards or modules available in the given chassis. The returned collection of card objects can be any/all of the following card objects:

ProcessorCard.

NetworkCard.

ServiceCard.

When the chassis does not contain any of the above mentioned cards, this API will return a empty collection.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-existing chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of chassis.

Return Value

List of all the Card objects present in the chassis.

Following association will be available for each Card object irrespective of its type:

Slot.

CardStatus.

Sensor collection.

getCardsInChassisByTypes

Returns a collection of cards or modules available in the given chassis that match with the given card types.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later. The returned collection of card objects can be any/all of the following card objects:

ProcessorCard.

NetworkCard.

ServiceCard.

When the chassis does not contain any of the above mentioned cards, this API will return a empty collection.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-exixting chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of chassis.

Returns

List of all the Card objects present in the chassis with the given card types.

Following association will be available for each Card object irrespective of its type:

Slot.

CardStatus.

Sensor collection.

getCardsWithComputerSystemAssociations

Returns a list of list of cards or modules available in the given chassis. The returned collection of card objects can be any/all of the following card objects:.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later. The returned collection of card objects can be any/all of the following card objects:

ProcessorCard.

NetworkCard.

ServiceCard.

When the chassis does not contain any of the above mentioned cards, this API will return a empty collection.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-exixting chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of chassis.

Returns

List of all the Card objects present in the chassis with the given card types.

Following association will be available for each Card object irrespective of its type:

Slot.

CardStatus.

AbstractComputerSystem for NetworkCard type.

getCdpNeighbors

Returns a collection of network elements that physically connected to a network element. Given a InstanceNameId of the network element, returns a list of network element objects.

ValidationException is thrown if any of the following situation occurs:

If srcInstanceNameId is null or if it is not a valid network element InstanceNameId

Parameters

opContext—Operational context.

srcInstanceNameId—InstanceNameId of a NetworkElement.

Return Value

List of NetworkElement objects that has a physical link with the input NetworkElement.

Following association will be available for each NetworkElement object:

Chassis.

getChassis

Returns a collection of chassis objects managed by the application. Given the list of chassis InstanceNameId returns collection of Chassis objects.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null

If the chassis InstanceNameId collection is empty or the collection contains invalid chassis InstanceNameId

Parameters

opContext—Operational context.

chassisIds—list of InstanceNameId of the chassis.

Return Value

List of Chassis object.

Following associations will be available for each Chassis object:

NetworkElement.

Slot collection.

RedundancySetting.

ChassisPowerSupplySetting.

getChassisForNetworkElements

Returns a collection of Chassis present in the given list of network elements. Given a list of InstanceNameId of the network elements, returns a collection of Chassis. This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.1(1) or later.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid network element InstanceNameId.

If a valid non-exixting network element InstanceNameId is passed.

Parameters

opContext—Operational context.

neInstanceNameIdCol - list of InstanceNameId of the network element.

Return Value

List of Chassis object.

Following associations will be available for each Chassis object:

NetworkElement.

Slot collection.

RedundancyStatus.

ChassisPowerSupplySetting

ChassisPowerSupplyStatus

getExtendedChassisInChassis

Returns a collection of all the ExtendedChassis objects connected to the given Chassis objects.

When there is no extended chassis connected to a chassis it will return an empty list.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

ValidationException is thrown if any of the following situation occurs:

If the arguement is null or empty list.

If the arguement does not contain a valid chassis InstanceNameId

If a valid non-existing chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisIdCol—List of InstanceNameId of chassis objects.

Returns

List of List of ExtendedChassis objects corresponding to Chassis.

Following association will be available for each ExtendedChassis objects:

ExtendedChassis

fetchCurrentSensorsInCard

Given the InstanceNameId of a Card, returns the Sensors that are associated to it. The Sensors will contain details about current temperature, major threshold, minor threshold and sensor status.

ValidationException is thrown if any of the following situation occurs:

if the argument passed is null.

if Card InstanceNameId is invalid.

if a valid non-existing Card InstanceNameId is passed.

Parameters

opContext—Operational context.

cardInstanceNameId—Card InstanceNameId

Return Value

List of Sensors associated with the Card.

Following associations will be available for each Sensor objects:

Threshold.

SensorStatus.

SensorDataType.

fetchCurrentSensorsInChassis

Given a collection of chassis InstanceNameId, returns the sensors associated to it. The Sensors will contain details about current temperature, major threshold, minor threshold and sensor status.

ValidationException is thrown if any of the following situation occurs:

if the argument passed is null

if the chassisIds collection is empty or the collection contains objects which are not a valid chassis InstanceNameIds

Parameters

opContext—Operational context.

chassisInstanceNameId—List of Chassis InstanceNameId

Return Value

List of Sensors associated with the Chassis.

Following associations will be available for each Sensor objects:

Threshold.

SensorStatus.

SensorDataType.

getFansInChassis

Returns a collection of all fan present in the chassis. Given the InstanceNameId of the chassis, returns a collection of fan objects. When the chassis does not contain any fan units, this API will return a empty collection.

ValidationException is thrown if any of the following situation occurs:

if the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-existing chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of the chassis.

Return Value

List of Fan objects present in the chassis.

Following associations will be available for each Fan objects:

Sensor collection.

Chassis.

FanStatus.

getFileSystemsInChassis

Deprecated.

Returns a collection of all file system present in the chassis. Given the InstanceNameId of the chassis, returns a collection of file system objects. When the chassis does not contain any file systems, this API will return a empty collection.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-existing chassis InstanceNameId is passed.

Each Chassis may have a collection of FileSystems. The returned collection will contain a list of FileSystems for that input chassis id.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of the chassis.

Return Value

List of FileSystem objects corresponding to Chassis.

getNetworkCardsInChassis

Returns a collection of all network cards present in the chassis. Given the InstanceNameId of the chassis, returns a collection of network card objects. Empty collection is returned when the chassis does not contain any network cards.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-existing chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of the chassis.

Return Value

List of NetworkCard objects present in the chassis.

Following associations will be available for each NetworkCard objects:

Slot.

Card sub-card collection for that NetworkCard if present.

AsicChip collection for that NetworkCard if present.

NetworkCardEtherChannelLoadBalanceSetting.

getNetworkElementForCard

Returns a collection of NetworkElement. Given a list of InstanceNameId od card, returns a collection of corresponding Netowork Element.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—Operational context

cardInstanceNameIds—InstanceNameId of Card.

Returns

Returns a collection of NetworkElement.

getNonPortChannelMemberPhysicalLinks

Returns list of Physical Links present which are not having member ports of port channel.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—OpContext

Returns

List of PhysicalLink discovered in the network

getNonPortChannelMemberPhysicalLinksInNetworkElements

Returns list of list of Physical Links present in the given list of network elements which are not having member ports of port channel.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Parameters

opContext—OpContext

neInstanceNameIdCol—List of InstanceNameId of the NetworkElement.

Returns

List of PhysicalLink present within the given network elements

getPhysicalLinks

Returns a collection of physical links that exist between two network elements. Given the InstanceNameId of two network elements, this API will return a collection of physical link objects.

ValidationException is thrown if any of the following situation occurs:

If both srcInstanceNameId, destInstanceNameId are null or is not a valid InstanceNameId of the network element.

Parameters

opContext—Operational context.

srcInstanceNameId—InstanceNameId of a NetworkElement.

destInstanceNameId—InstanceNameId of a NetworkElement.

Return Value

List of PhysicalLink objects corresponding to the physical link that exist between the network elements.

Following associations will be available for each physical link objects:

PhysicalPort collection for that PhysicalLink object.

getPhysicalPorts

Returns a collection of physical ports present in a particular slot of the chassis. Given theInstanceNameId of the chassis and the slot number, returns a collection of physical port objects.

ValidationException is thrown if any of the following situation occurs:

If the passed chassis InstanceNameId is null or it is not a valid chassis InstanceNameId.

If a valid non-existing chassis InstanceNameId is passed

If the slot number passed is null.

Parameters

opContext—Operational context.

aChassisInstanceNameId—InstanceNameId of the chassis.

slotNumber—An Integer slot number.

Return Value

List of PhysicalPort objects corresponding to Chassis and the slotNumber.

Following associations will be available for each PhysicalPort objects:

NetworkInterface

Card

getPhysicalPortsInSlot

Returns a collection of physical ports present in a particular slot of the chassis. Given the InstanceNameId of the chassis and the slot number, returns a collection of physical port objects.

ValidationException is thrown if any of the following situation occurs:

If the passed chassis InstanceNameId is null or it is not a valid chassis InstanceNameId.

If a valid non-existing chassis InstanceNameId is passed.

If the slot number passed is null.

Parameters

opContext—Operational context.

aChassisInstanceNameId—InstanceNameId of the chassis.

slotNumber—an Integer slot number.

Return Value

List of PhysicalPort objects corresponding to Chassis and the slotNumber.

Following associations will be available for each PhysicalPort objects:

NetworkInterface.

Card.

getPowerSuppliesInChassis

Returns a collection of all power supplies present in the chassis. Given the InstanceNameId of the chassis, returns a collection of power supply objects. When the chassis does not contain any power supply, this API will return a empty collection.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-existing chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of the chassis.

Return Value

List of PowerSupply objects present in the chassis.

Following associations will be available for each PowerSupply objects:

Sensor collection.

Chassis.

PowerSupplyStatus collection.

getProcessorCardsInChassis

Returns a collection of all processor cards present in the chassis. Given the InstanceNameId of the chassis, returns a collection of processor card objects. When the chassis does not contain any processor cards, this API will return a empty collection.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-existing chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of chassis.

Return Value

List of ProcessorCard objects in the chassis.

Following association will be available for each ProcessorCard object:

SoftwareIdentity.

Slot.

Card sub-card collection for that ProcessorCard if present.

AsicChip collection for that ProcessorCard if present.

getSensorsInChassis

Returns a collection of all sensors present in the chassis. Given the InstanceNameId of the chassis, returns a collection of sensor objects. When the chassis does not contain any sensors, this API will returns an empty collection.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-exixting chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of the chassis.

Return Value

List of Sensor objects corresponding to Chassis.

Following associations will be available for each Sensor objects:

Threshold.

SensorStatus.

SensorDataType.

getServiceCardsInChassis

Returns a collection of all service cards present in the chassis. Given the InstanceNameId of the chassis, returns a collection of service card objects. When the chassis does not contain any service cards, this API will return a empty collection.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid chassis InstanceNameId

If a valid non-existing chassis InstanceNameId is passed.

Parameters

opContext—Operational context.

chassisId—InstanceNameId of chassis.

Return Value

List of ServiceCard objects present in the chassis.

Following association will be available for each ServiceCard object:

Slot.

Card sub-card collection for that ServiceCard if present

AsicChip collection for that ServiceCard if present

getSlotsInChassis

Returns a collection of slots available in the given chassis. When the chassis does not contain any slots, this API will return an empty collection.

ValidationException is thrown if any of the following situation occurs:

If InstanceNameId of chassis is null or if it is not a valid chassis InstanceNameId

Parameters

opContext—Operational context.

chassisInstanceNameId—InstanceNameId of a Chassis.

Return Value

List of Slot objects corresponding to the input chassis InstanceNameId.

Following association will be available for each Slot object:

Chassis association for each Slot object.

getSlotsInNetworkElement

In case of Catalyst 6500 series switches, slots present in the device will be returned. In case of Nexus 7000 series switch, slots present in the VDC will be returned Returns a collection of slot number of the slots present in Virtual Network Element for Nexus 7000 series switch. Ccollection of slot number of the slots present in Device is returned for Catalyst 6500 series switches.

Parameters

opContext—Operational context.

aneInstanceNameId—InstanceNameId of AbstractNetworkElement.

Return Value

List of SlotNumbers

getSoftwareIdentitiesInNetwork

Returns a collection of all software identities from the active processor cards present in the network elements. Given a list of InstanceNameId of the network elements, this API returns a collection of software identities collected from the active processor cards.

ValidationException is thrown if any of the following situation occurs:

If network element InstanceNameId collection is null, empty or if the collection does not contain InstanceNameId of the network element or virtual network element.

Parameters

opContext—Operational context.

aneInstanceNameIds—List of InstanceNameId of the NetworkElement.

Return Value

List of SoftwareIdentity objects corresponding to NetworkElement or VirtualNetworkElement

getSystemUpTime

Deprecated.

Returns the System uptime of the device for the given chassis InstanceNameIds. System up time returned is in the same order of chassis InstanceNameIds passed.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null

If the chassisIds collection is empty or the collection contains objects which are not a valid chassis InstanceNameIds

Parameters

opContext—Operational context.

chassisInstanceNameIds—List of Chassis InstanceNameId

Return Value

List containing System up time.

getVirtualComputerSystemForComputerSystem

Returns a collection of Virtual Computer Systems present in the given list of computer systems.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid InstanceNameId

If a valid non-exixting computer system InstanceNameId is passed.

Parameters

opContext—Operational context.

compSystemsIdCol—list of InstanceNameId of the computer system

Returns

List of List of VirtualComputerSystem object.

Following associations will be available for each VirtualComputerSystem object:

NetworkInterface collection.

AbstractComputerSystemStatus.

getVirtualComputerSystemsAttachedToVirtualCard

Returns a collection of VirtualComputerSystem attached to the given list of of cards.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null or it is not a valid InstanceNameId

If a valid non-exixting card InstanceNameId is passed.

Parameters

opContext—Operational context

cardIdCol—InstanceNameId of Card.

Returns

Returns a collection of VirtualComputerSystem.

Following associations will be available for each object:

ComputerSystem

AbstractComputerSystemStatus

NetworkInterface collection.

modifyChassisPowerRedundancyMode

Modifies the power redundancy mode for Chassis PowerSupply.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

ValidationException is thrown if any of the following situation occurs:

argument passed is null

chassisId collection is empty or the collection contains objects which are not a valid chassis objects

Parameters

opContext—Operational context.

chassisCol—List of Chassis object with the modified power supply redundancy mode.

Returns

List of Chassis containting modified redundancy mode.

refreshPowerUsageInfo

Updates the latest power usage information for the given devices.This method is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

ValidationException is thrown if any of the following situation occurs:

argument passed is null

chassisId collection is empty or the collection contains objects which are not a valid chassis objects

Parameters:

opContext—Operational context.

chassisInstanceNameIds—List of Chassis InstanceNameId