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

FabricPathTopologyApp Service

Table Of Contents

FabricPathTopologyApp Service

Information About FabricPathTopologyApp Service

bindInterfacesToFabricPathTopologySetting

createFabricPathTopologyInNetworkElements

createFpTopologyInNetworkElementsWithVlans

deleteFabricPathTopologySettings

getFabricPathNetworkInterfacesummaryObjects

getFabricPathTopologySettingForInterfaces

getFabricPathTopologySettingForTopoId

getFabricPathTopologySettingForVlanRange

getFabricPathTopologySettings

getFpTopologySettingInNetworkElements

getFptopologySettingWithInterfaceAssociation

getFabricPathNetworkInterfacesummaryObjects

getSniBelongsToTopologyStatuses

modifyFabricPathTopologySettings

modifySniBelongsToFpTopologySettings

unbindInterfaceFromFabricPathTopologySetting


FabricPathTopologyApp Service


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

Information About FabricPathTopologyApp Service

Routing Topology Manager (RTM) allows you to create, delete, and manage FabricPath Topologies. You can configure multiple FabricPath topologies on a given device. Each FabricPathTopology represents a mapping of one or more VLANs. A port in the device can be associated with multiple Layer2 topologies. One VLAN cannot be a part of more than one Layer 2 topology.

This interface defines all the APIs exposed by the RTM feature service facade. APIs are defined with the following categories:

Query/Get APIs—Used to query data from the persisted database.

Create APIs—Used to create new FabricPath Topologies.

Modify APIs—Used to modify basic attributes of existing FabricPath topologies.

Delete APIs—Used to delete existing FabricPath topologies.

bindInterfacesToFabricPathTopologySetting

Associate an instance to one or more instances that are existing in the same device.

ValidationException is thrown if any of the following situation occurs:

If fpTopologySettingInstanceNameIdCol is null or it is empty.

If fpTopologySettingInstanceNameIdCol contains invalid FabricPathTopologySetting InstanceNameId or null value.

If there is no equivalent FabricPathTopologySetting object with the given InstanceNameId in the fpTopologySettingInstanceNameIdCol.

If niInstanceNameId is invalid NetworkInterface InstanceNameId or null value.

If there is no equivalent NetworkInterface object with the given InstanceNameId for the niInstanceNameId.

If InstanceNameId for NetworkInterface instance and InstanceNameId corresponding to any FabricPathTopologySetting instance in fpTopologySettingInstanceNameIdCol doesnt belongs to same devices.

Parameters

opContext—Operational context.

sniInstanceNameIds—InstanceNameIds of network interfaces which need to be associated to multiple topologies.

fpTopologySettingInstanceNameIdCol—List of InstanceNameId of instances.

Return Value

List of newly created SniBelongsToTopologySetting instances corresponding to each NetworkInterface with FabricPathTopologySetting.

createFabricPathTopologyInNetworkElements

Creates a instance in all the Network Elements present in neInstanceNameIdCol.

IntegrityException is thrown if any of the following situation occurs:

If the FabricPathTopologySetting already exists in the database.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol is null or empty.

If neInstanceNameIdCol contains invalid NetworkElement InstanceNameId value.

If there is no equivalent NetworkElement object with the given InstanceNameId in the neInstanceNameIdCol.

If the topoName is null.

Parameters

opContext—Operational context.

neInstanceNameIdCol—List of InstanceNameId of network element.

topoName—name to be created.

Return Value

List of newly created FabricPathTopologySetting instances corresponding to each Network Element with FabricPathTopologySetting name as topologyId.

createFpTopologyInNetworkElementsWithVlans

Creates a instance in all the network elements present in neInstanceNameIdCol with the VLAN range passed in argument. If the topologySetting instance for the device is present in the database, the method modifies the VLAN range and sets the mapped VLAN for the topology instance to the passed value. If the object already exist, it will not throw nonUniqueElementCreation instance exception.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol is null or empty.

If neInstanceNameIdCol contains invalid NetworkElement InstanceNameId value.

If there is no equivalent NetworkElement object with the given InstanceNameId in the neInstanceNameIdCol.

If the topologyId is null.

If the vlanRange is null or empty.

FeatureException is thrown if any of the following situation occurs:

If fpTopologySettingList contains the FabricPathTopologySetting instance with topology-id as 0 with modified VLAN-range.

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId of network element.

topoName—name to be created.

Return Value

List of newly created FabricPathTopologySetting instances corresponding to each Network Element with FabricPathTopologySetting name as topologyId.

deleteFabricPathTopologySettings

Deletes a FabricPathTopologySetting instance. All the VLANs in the VLAN-range corresponding to the FabricPathTopologySetting instance will be assigned to the default FabricPathTopologySetting instance.

ValidationException is thrown if any of the following situation occurs:

If fpTopologySettingInstanceNameIdCol is null or it is empty.

If fpTopologySettingInstanceNameIdCol collection contains an element that is not of type FabricPathTopologySetting InstanceNameId.

If fpTopologySettingInstanceNameIdCol collection contains a FabricPathTopologySetting that does not exist in the database.

FeatureException is thrown if any of the following situation occurs:

If fpTopologySettingInstanceNameIdCol contains the FabricPathTopologySetting instance with topology-id as 0.

Parameters

opContext—Operational context.

fpTopologySettingInstanceNameIdCol—List of InstanceNameId of instances to be deleted.

Return Value

void

getFabricPathNetworkInterfacesummaryObjects

Return the FabricPathNetworkInterfaceSummary object containing following attributes:

SniBelongsToFpTopologySetting corresponding to each SNI—sniBelongsToFpTopologyState from SniBelongsToFpTopologyStatus for local and remote interface.

NetworkInterfaceOperationStatus from NetworkInterfaceStatus for local and remote interface, if any—Adjacency information from L2IsisAdjacencyState for local and remote interface, if any The first index in List of list will be based on each topologyId in topologyIdRange. The second list will return summarized info for the SNIs in the topologyId.

Parameters

ctx—Current operational context.

sniInstanceNameIds—InstanceNameId of switched network interfaces whose associated status needs to be found.

topologyId—topoId string.

Return Value

L2mpNetworkInterfaceSummary corresponds to each SNI

getFabricPathTopologySettingForInterfaces

Returns list of list Instances corresponding to the given list of SwicthedNetworkInterface InstanceNameIds.

ValidationException is thrown if any of the following situations occurs:

If sniInstanceNameIds is null or it is empty.

If sniInstanceNameIds contains invalid SwitchedNetworkInterface InstanceNameId value.

If there is no equivalent SNI object with the given InstanceNameId in the sniInstanceNameIds.

Parameters

OpContext—operational Context.

sniInstanceNameIds—List of InstanceNameId sniInstanceNameIds, corresponding to the SwitchedNetworkInterface instances.

Returns

List of of FabricPathTopologySetting instance corresponding to the sniInstanceNameIds queried.

getFabricPathTopologySettingForTopoId

Returns List of Instances corresponding to given topology-id for a list of ANEs.If ANE instanceNameId list is null or empty, it will return the FabricPathTopologySetting object for all the devices in the network. If corresponding to topology-Id, a TopologySetting instance doesnt exist in the ANE, a null will be returned.

ValidationException is thrown if any of the following situation occurs:

If topologyId is null.

If neInstanceNameIdCol contains invalid NetworkElement InstanceNameId value.

If there is no equivalent NetworkElement object with the given InstanceNameId in the neInstanceNameIdCol.

Parameters

opContext—Operational context.

topologyId—Integer topology-id, corresponding to the FabricPathTopologySetting instances.

neInstanceNameIdCol—Instance name IDs of network elements for which Layer2Topology are to be returned. If null, returns Layer2Topologies on all managed network elements.

Return Value

List of instance corresponding to the topologyId queried for each ANE.

getFabricPathTopologySettingForVlanRange

Returns list of Instances corresponding to given VLAN Range. For eg, passed vlan range may be something like 1-10. And it returns 2 topology setting object, where one topology setting object is mapped to 1-3 and other is mapped to 4-9. If there is no equivalent FabricPathTopologySetting object with the given vlanRange then it will return an empty list.

ValidationException is thrown if any of the following situation occurs:

If vlanRange is null or empty.

ParameterException is thrown if any of the following situation occurs:

If vlanRange contains invalid VLAN-id.

Parameters

opContext—Operational context.

vlanRange—IntegerRange vlanRange, corresponding to the list of FabricPathTopologySetting instances.

Return Value

List of instance corresponding to the vlanRange queried.

getFabricPathTopologySettings

Returns Instances corresponding to given InstanceNameIds.

ValidationException is thrown if any of the following situation occurs:

If fpTopologySettingInstanceNameIdCol is null or it is empty.

If fpTopologySettingInstanceNameIdCol contains invalid FabricPathTopologySetting InstanceNameId or null value.

If there is no equivalent FabricPathTopologySetting object with the given InstanceNameId in the fpTopologySettingInstanceNameIdCol.

Parameters

opContext—Operational context

fpTopologySettingInstanceNameIdCol—List of InstanceNameId corresponding to the FabricPathTopologySetting instances.

Return Value

List of instance corresponding to the InstanceNameIds queried.

getFpTopologySettingInNetworkElements

Returns a list of list of FabricPathTopologySetting objects, where each list of FabricPathTopologySetting corresponds to a network element.

InstanceException is thrown if any of the following situation occurs:

If neInstanceNameIdCol contains invalid NetworkElement InstanceNameId value.

If there is no equivalent NetworkElement object with the given InstanceNameId in the neInstanceNameIdCol.

Parameters

opContext—Operational context.

neInstanceNameIdCol—Instance name IDs of network elements for which Layer2Topology are to be returned. If null, returns Layer2Topologies on all managed network elements.

Return Value

List of List of FabricPathTopologySetting.

getFptopologySettingWithInterfaceAssociation

Returns a list of FabricPathTopologySetting objects, where each FabricPathTopologySetting instance is populated with SniBelongsToTopologySettingCol and SniBelongsToTopologyStatusCol.

ValidationException is thrown if any of the following situation occurs:

If fpTopologySettingInstanceNameIdCol is null or it is empty.

If foTopologySettingInstanceNameIdCol contains invalid FabricPathTopologySetting InstanceNameId value.

If there is no equivalent FabricPathTopologySetting object with the given InstanceNameId in the fpTopologySettingInstanceNameIdCol.

Parameters

opContext—Operational context.

fpTopologySettingInstanceNameIdCol—List of InstanceNameId corresponding to the FabricPathTopologySetting instances.

Return Value

List of instance corresponding to the InstanceNameIds queried.

Following associations will be available for each returned FabricPathTopologySetting:

SniBelongsToTopologySettingCol

SniBelongsToTopologyStatusCol

getFabricPathNetworkInterfacesummaryObjects

This API is summarized API which will return the FabricPathNetworkInterfaceSummary object containing following attributes :—SniBelongsToFpTopologySetting corresponding to each SNI—sniBelongsToFpTopologyState from SniBelongsToFpTopologyStatus for local and remote interface, if any—NetworkInterfaceOperationStatus from NetworkInterfaceStatus for local and remote interface, if any—Adjacency information from L2IsisAdjacencyState for local and remote interface, if any The first index in List of list will be based on each topologyId in topologyIdRange. The second list will return summarized info for the SNIs in the topologyId.

Parameters

ctx—Current Operational context.

sniInstanceNameIds—InstanceNameId of switched network interfaces whose associated status needs to be found.

topologyId—topoId string .

Return Value

List<@L2mpNetworkInterfaceSummary> corresponds to each SNI.

getSniBelongsToTopologyStatuses

Returns a list of list of SniBelongsToTopologyStatus objects, where each list of SniBelongsToTopologyStatus corresponds to a FabricPathTopologySetting instance.

ValidationException is thrown if any of the following situation occurs:

If fpTopologySettingInstanceNameIdCol is null or it is empty.

If fpTopologySettingInstanceNameIdCol contains invalid FabricPathTopologySetting InstanceNameId value.

If there is no equivalent FabricPathTopologySetting object with the given InstanceNameId in the fpTopologySettingInstanceNameIdCol.

Parameters

opContext—Operational context.

fpTopologySettingInstanceNameIdCol—List of InstanceNameId corresponding to the FabricPathTopologySetting instances.

Return Value

List of List of SniBelongsToTopologySetting.

modifyFabricPathTopologySettings

Modify FabricPathTopologySetting instances. User cannot modify the name in the FabricPathTopologySetting instance. Can modify/set the VLAN-range mapped to each FabricPathTopologySetting instance. FabricPathTopologySetting instance 0, by default, will have all the VLANs mapped. When a VLAN-range is assigned to an instance of FabricPathTopologySetting, VLANs are borrowed from either Topology 0 or from other instance of FabricPathTopologySetting to which this range might be mapped. Similarly, VLAN-range modification for topology-id 0 should throw feature exception.

ValidationException is thrown if any of the following situation occurs:

If fpTopologySettingInstanceNameIdCol is null or it is empty.

If fpTopologySettingInstanceNameIdCol contains invalid FabricPathTopologySetting InstanceNameId value.

If there is no equivalent FabricPathTopologySetting object with the given InstanceNameId in the fpTopologySettingInstanceNameIdCol.

FeatureException is thrown if any of the following situation occurs:

If fpTopologySettingList contains the FabricPathTopologySetting instance with topology-id as 0 with modified VLAN-range.

Parameters

opContext—Operational context.

fpTopologySettingList—List of modified FabricPathTopologySetting.

Return Value

void

modifySniBelongsToFpTopologySettings

Modify SniBelongsToFpTopologySetting instances. User can modify the metric in the SniBelongsToFpTopologySetting instance.

ValidationException is thrown if any of the following situation occurs:

If the sniBelongsToFpTopologySettingList is null or the collection is empty.

If the sniBelongsToFpTopologySettingList contains one or more null element, or the collection contains objects that are not of type SniBelongsToFpTopologySetting.

If the any of the SniBelongsToFpTopologySetting object within sniBelongsToFpTopologySettingList does not have equivalent persisted SniBelongsToFpTopologySetting object.

PropertiesException is thrown if any of the following situation occurs:

If sniBelongsToFpTopologySettingList contains the SniBelongsToFpTopologySetting instance with invalid or out-of-range metric value.

Parameters

opContext—Operational context.

sniBelongsToFpTopologySettingList—List of modified SniBelongsToFpTopologySetting.

Return Value

void

unbindInterfaceFromFabricPathTopologySetting

Disassociate a instance to one or more instances existing in the same device. It will delete SniBelongsToTopologySetting instance and SniBelongsToTopologyStatus instance corresponding to NI and each topology setting object.

ValidationException is thrown if any of the following situation occurs:

If fpTopologySettingInstanceNameIdCol is null or it is empty.

If fpTopologySettingInstanceNameIdCol contains invalid FabricPathTopologySetting InstanceNameId or null value.

If there is no equivalent FabricPathTopologySetting object with the given InstanceNameId in the fpTopologySettingInstanceNameIdCol.

If niInstanceNameId is invalid NetworkInterface InstanceNameId or null value.

If there is no equivalent NetworkInterface object with the given InstanceNameId for the niInstanceNameId.

If InstanceNameId for NetworkInterface instance and InstanceNameId corresponding to any FabricPathTopologySetting instance in fpTopologySettingInstanceNameIdCol doesnt belongs to same devices.

Parameters

opContext—Operational context.

niInstanceNameId—InstanceNameId of network interfaces which need to be associated to multiple topologies.

fpTopologySettingInstanceNameIdCol—List of InstanceNameId of instances.

Return Value

void