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

FcApp Service

Table Of Contents

FcApp Service

Information About FcApp Service

addServers

deleteLogicalEndDeviceEnclosures

getAllLogicalEndDeviceEnclosures

getAllLogicalEndDeviceEnclosuresOfType

getAllLogicalEndDevices

getAllLogicalEndDevicesOfType

getAllMdsSwitches

getConnectedSwitches

getLogicalEndDeviceNeighbors

getPhysicalLinksForLogicalEndDevices

getPhysicalLinksForLogicalEndDevicesFromSource

modifyLogicalEndDevices

performEndDevicesCorrelation


FcApp Service


This chapter describes the DCNM web services' API methods for the FcApp service. This API is available for Cisco Nexus 7000 Series switches that run Cisco NX-OS Release 5.0(3) or later.

Information About FcApp Service

This interface defines all the APIs exposed by the FC feature service facade.

addServers

Adds a list of servers to the device list. If a server with the specified IP address already exists in the device list, this method will throw AppException.

Parameters

opContext - OpContext

neCol - List of identifiers corresponding to the servers to be added to the device list.

Returns

List of LogicalEndDeviceEnclosure

deleteLogicalEndDeviceEnclosures

Deletes the LogicalEndDeviceEnclosures whose InstanceNameIds are passed. The member LogicalEndDevices will not be deleted.

Parameters

opContext - Operational context

Returns

void

getAllLogicalEndDeviceEnclosures

Returns List of LogicalEndDeviceEnclosures in the network.

Parameters

opContext - Operational context

deviceType - the device type

Returns

List of LogicalEndDeviceEnclosure

getAllLogicalEndDeviceEnclosuresOfType

Returns List of LogicalEndDevices in the network. Given a EndDeviceType all the LogicalEndDevices of that type are returned. If the EndDeviceType passed is null, then all the LogicalEndDevices in the network are returned. Pass deviceType as EndDeviceType.HOST to get all Server Enclosures. Pass deviceType as EndDeviceType.JBOD to get all JBOD Enclosures.

Parameters

opContext - Operational context

deviceType - the device type

Returns

List of LogicalEndDeviceEnclosure

getAllLogicalEndDevices

Returns List of LogicalEndDevice in the network.

Parameters

opContext - Operational context.

deviceType - the device type.

Returns

List of LogicalEndDevice.

getAllLogicalEndDevicesOfType

Returns List of LogicalEndDevices in the network. Given a EndDeviceType all the LogicalEndDevices of that type are returned.

If the EndDeviceType passed is null, then all the LogicalEndDevices in the network are returned.

Parameters

opContext - Operational context

deviceType - the device type

Returns

List of LogicalEndDevice

getAllMdsSwitches

Returns List of AbstractNetworkElement. Returns all the MDS switches discovered in the network.

Parameters

opContext - Operational context.

Returns

List of AbstractNetworkElement.

getConnectedSwitches

Returns List of AbstractNetworkElement. Given an InstanceNameId of a LogicalEndDevice all the switches connected to it are returned.

ValidationException is thrown if any of the following situations occur:

Argument passed is null

A LogicalendDeviceInstanceNameId is not a valid InstanceNameId of a LogicalEndDevice

Parameters

opContext - Operational context

aLogicalendDeviceInstanceNameId - InstanceNameId of a LogicalEndDevice

Returns

List of AbstractNetworkElement

getLogicalEndDeviceNeighbors

Returns List of LogicalEndDevice. Given an InstanceNameId of a AbstractNetworkElement all the end devices connected to it are returned.

ValidationException is thrown if any of the following situation occurs:

Argument passed is null

networkElementInstanceNameIds is not a valid InstanceNameId of a AbstractNetworkElement

Parameters

opContext - Operational context

networkElementInstanceNameIds - the network element instance name ids

Returns

List of LogicalEndDevice

getPhysicalLinksForLogicalEndDevices

Gets the physical links for logical end devices.

ValidationException is thrown if any of the following situation occurs:

Argument passed is null

ledInstanceNameIds is not a valid InstanceNameId of a LogicalEndDevice

Parameters

opContext - the op context

ledInstanceNameIds - the led instance name ids

Returns

The physical links for logical end devices.

getPhysicalLinksForLogicalEndDevicesFromSource

Gets the physical links from the source, for logical end devices.

ValidationException is thrown if any of the following situation occurs:

Argument passed is null

ledInstanceNameIds is not a valid InstanceNameId of a LogicalEndDevice

Parameters

opContext - the op context

ledInstanceNameIds - the led instance name ids

srcInstanceNameId - the src instance name id

Returns

The physical links for logical end devices.

modifyLogicalEndDevices

Modifies the LogicalEndDevice. Creates, Deletes and Updates LogicalEndDeviceEnclosure as per the requirement.

Parameters

opContext - Operational context

logicalEndDevices - List of LogicalEndDevice

Returns

void

performEndDevicesCorrelation

Performs the end device correlation and maps the end devices into respective Enclosures

Parameters

opContext - Operational context

serverList - The list of IP Addresses/DNS Name of the various servers on which automatic correlation needs to be performed.

Returns

void