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

FabricPathResourcesApp Service

Table Of Contents

FabricPathResourcesApp Service

Information About FabricPathResourcesApp Service

getFabricPathConflictedPortsInNetworkElements

getFabricPathSettingsInNetworkElements

getFabricPathTopologySettingsInNetworkElements

modifyFabricPathSettings

performFabricPathForceLinkBringupInNetworkElements


FabricPathResourcesApp Service


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

Information About FabricPathResourcesApp Service

FabricPathResources is a resource allocation protocol for FabricPath. The distribution of FabricPath Resources information is processed through Intermediate System to Intermediate System (ISIS). The SwitchId and FTAGs are identifiers in the FabricPath data forwarding plane. The SwitchId is the unique identifier for every FabricPath switch and TopologyId is the identifier to which the switch belongs to. The PathId is the identifier for the shortest path to the next device in the FabricPath cloud. FTAG comprises of TopologyId and the PathId. The APIs are defined with the following categories:

1. Query/Get APIs—Query data from the persisted database.

2. Modify APIs—Modify existing FabricPath Resources Configuration.

3. Perform APIs—Perform FabricPath Resources global Configuration.

getFabricPathConflictedPortsInNetworkElements

Returns FabricPath conflicted ports information corresponding to the network element. If the given InstanceNameId is null, this method returns the SwitchedNetworkInterface objects that contains the FabricPathConflictStatus of all the network elements discovered by the server.

InstanceException is thrown if the argument passed InstanceNameId InstanceNameId is not a valid AbstractNetworkElement.

Parameters

opContext—Operational context

neIds—InstanceNameId of network elements for which the FabricPath conflicted ports information are to be queried.

Return Value

List of SwitchedNetworkInterface objects.

The returned list will contain the list of following instance:

SwitchedNetworkInterface SwitchedNetworkInterface contains the FabricPathConflictStatus FabricPathConflictStatus that has the information about the ports causing the conflicts between devices having the same switch-id.

getFabricPathSettingsInNetworkElements

Returns all the FabricPath settings for the given network element.

InstanceException is thrown if the argument passed InstanceNameId is null or empty or if the element in the collection is not a valid network element InstanceNameId.

Parameters

opContext—Operational context.

neIds—InstanceNameId of network elements for which FabricPath setting information are to be queried.

Return Value

List of FabricPathSetting objects.

The returned list will contain the list of following instances:

FabricPathSetting—FabricPathSetting contains SwitchId, graceful-merge value (enable or disable), the FabricPathTimerSetting, the FabricPathSwitchStatus, the FabricPathSwitchIdCnflctStatus of the switches that are populated.

FabricPathTimerSetting—FabricPathTimerSetting contains various timer intervals populated.

FabricPathSwitchStatus—FabricPathSwitchStatus contains the SwitchIds and the status of the SwitchIds.

FabricPathSwitchIdCnflctStatus—FabricPathSwitchIdCnflctStatus contains the collection of system IDs having the same switch IDs.

getFabricPathTopologySettingsInNetworkElements

Returns FabricPathTopologySetting information corresponding to the network element. This FabricPathTopologySetting contains the FabricPathTopologySetting collection, which contains the information about the FTAG id,graphType,status of the graph-type and the FabricPath Resources Conflicted TopologyIds.

InstanceException is thrown if the argument passed InstanceNameId InstanceNameId is not a valid network element AbstractNetworkElement.

Parameters

opContext—Operational context

neInstanceNameIdCol—InstanceNameId of network elements for which L2TopologySetting information are to be queried.

Return Value

List of FabricPathTopologySetting objects.

The returned list will contain the list of following instance:

FabricPathTopologySetting FabricPathTopologySetting contains the L2IsisFtagStatus L2IsisFtagStatus collection for the queried network element.

modifyFabricPathSettings

Modify a collection of FabricPathSetting objects. The modifiedFabricPathSettingCol is checked if the collection has unique elements. If in case any value is given as null in the FabricPathSetting FabricPathSetting object then the particular timer value alone is set to defaults. .

ValidationException is thrown if any of the following situation occurs:

If the modifiedRscrSettingCol is null or empty.

PropertiesException is thrown if the given collectionInfo does not exist in devices.

If the attribute for FabricPathSetting object modifiedFabricPathSettingCol is not valid / not supported based on the platform type.

IntegrityException is thrown if any of the following situation occurs:

If the corresponding object for the objects in the modifiedFabricPathSettingCol FabricPathSetting collection does not exist.

Parameters

opContext—Operational context.

modifiedFabricPathTimerSettingCol—modified collection of timer settings of a FabricPathTimerSetting object.

Return Value

void

performFabricPathForceLinkBringupInNetworkElements

Performs FabricPath force link-bringup in device.

InstanceException is thrown if the argument passed InstanceNameId InstanceNameId is not a valid network element AbstractNetworkElement.

Parameters

opContext—Operational context.

neIds—List of InstanceNameId of the network elements for which the FabricPath force link-bringup needs to be performed.

Return Value

void