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

Interface L2IsisApp Service

Table Of Contents

Interface L2IsisApp Service

Information About Interface L2IsisApp Service

bindL2topologyToIsisProcess

createL2IsisProcesses

deleteL2GraphUserRequest

deleteL2IsisProcesses

disableL2Isis

enableL2Isis

fetchM2ribGraph

getAllL2GraphUserRequest

getM2ribGraph

getInterfaceWithL2IsisSettings

getL2IsisProcesForL2TopologySettings

getL2IsisProcesses

getL2IsisProcessesInNetworkElements

getL2IsisProcessWithL2TopologySetting

getL2IsisStateInNetworkElements

getM2ribGraph

getPortsWithL2IsisSettingsInModule

modifyL2IsisAuthenticationSettings

modifyL2IsisProcessSettings

modifyL2IsisSettingsForInterfaces

stopFetchingL2Graph

unbindL2topologyFromIsisProcess


Interface L2IsisApp Service


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

Information About Interface L2IsisApp Service

FabricPath Intermediate System to Intermediate System (ISIS) is a intra-domain routing information exchange protocol. L2ISIS is the control protocol used for constructing and forwarding topologies for all kinds of data traffic such as unicast, multicast, and broadcast.

This interface defines all the APIs to manage Fabricpath-ISIS.

APIs are grouped as the following categories:

Query or Get APIs—Query data from the persisted database.

Create APIs—Create new Fabricpath-ISIS Process.

Modify APIs—Modify Fabricpath-ISIS process level and interface level configurations.

Delete APIs—Delete existing ISIS process.

Enable and Disable APIs—Enable or disable Fabricpath-ISIS service in a switch.

bindL2topologyToIsisProcess

Binds a set of L2 topologies to an ISIS process.

ValidationException is thrown if any of the following situation occurs:

If isisProcessId is null or not valid InstanceNameId of L2IsisProcess.

If L2TopologySettingIdCol is null or the list is empty.

IntegrityException is thrown if any of the following situation occurs:

If the corresponding L2 Isis Process object for the isisProcessId does not exist.

Parameters

opContext—Operational context

isisProcessId—InstanceNameId of L2IsisProcess to which the L2 topology settings are to be binded.

L2TopologySettingIdCol—List of InstanceNameId of L2 topology settings to be binded to the L2 isis process.

Return Value

void

createL2IsisProcesses

Creates one or more L2 isis processes.

ValidationException is thrown if any of the following situation occurs:

If the newIsisProcesses is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the newIsisProcess, if any of the L2 isis settings attribute is not valid.

Parameters

opContext—Operational context

newIsisProcesses—modified list of L2IsisProcess objects.

Return Value

InstanceNameId the instance name id of the CollectionInfo

deleteL2GraphUserRequest

This method is used to delete the DceL2GraphUserRequests. It deletes the graph user request objects corresponding to the given list of InstanceNameId. The corresponding DceL2GraphUserRequest and its following associations will be deleted.

DceL2Graph

DceL2GraphEntry

DceL2GraphNextHopInfo

M2ribGraph

ValidationException is thrown if any of the following situation occurs:

If graphRequestIdCol collection is null or empty.

If graphRequestIdCol collection contains an element that is not of type DceL2GraphUserRequest InstanceNameId.

If graphRequestIdCol collection contains a DceL2GraphUserRequest that does not exist in the database.

Parameters

opContext—Operational context

graphRequestIdCol—is the List of graphRequests that needs to be deleted.

Return Value

void

deleteL2IsisProcesses

Deletes all the given L2 isis processes.

ValidationException is thrown if any of the following situation occurs:

If isisProcessIdCol collection is null or it is empty.

If isisProcessIdCol collection contains an element that is not of type L2IsisProcess InstanceNameId.

IntegrityException is thrown if the given L2 isis process do not exist in the device.

Parameters

opContext—Operational context

isisProcessIdCol—the array of InstanceNameId of L2 isis process.

Return Value

void

disableL2Isis

Disables fabricpath-isis service on one or more network element. This method is applicable only for devices running NX-OS which supports L2ISIS feature.

ValidationException is thrown if any of the following situation occurs:

If the neInstanceNameIdCol is null.

If the neInstanceNameIdCol contains one or more null element, or the collection is empty or it is not type InstanceNameId.

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

Parameters

opContext—Operational context

neInstanceNameIdCol—list of InstanceNameId of the Network Element for which the L2isis should be disabled.

Return Value

void

enableL2Isis

Enables L2isis service on one or more network element. This method is applicable only for devices running DC-OS which supports L2isis feature.

ValidationException is thrown if any of the following situations occurs:

# If the neInstanceNameIdCol is null.

# If the neInstanceNameIdCol contains one or more null element, or the collection is empty or it is not type InstanceNameId.

Parameters

OpContext—operational Context.

neInstanceNameIdCol—list of InstanceNameId of the Network Element for which the L2isis should be enabled.

Returns

void.

fetchM2ribGraph

Returns the DceL2GraphUserRequest object that is associated with the fetch method. Using this DceL2GraphUserRequest, the actual graph object call be queried using the getM2ribGraph API. Each graph is identified by the following 3 parameters—Source of the multicast traffic, the IGMP group address for the multicast and the VLAN.

InstanceException is thrown if the argument passed sourceDeviceId is null or it is not a valid network element InstanceNameId.

Parameters

opContext—Operational context

anchorDeviceId—InstanceNameId of the anchor switch from where the graph construction should begin.

ftagId—Forwarding tag identifier

vlanIds—List of VLANs that a reciever has subscribed to

sourceIp—IpAddress of the source of multicast traffic. If this parameter is null, the source input is treated as a wildcard character "*". This means "any source IP"

igmpAddress—IGMP address IpAddress for which multicast traffic is generated

topoId—Identifier for the topology

getLatest—Boolean to indicate whether the fetch call should recalculate the graph with the given input parameters or return the existing information from the database.

Return Value

DceL2GraphUserRequest that is assigned to the graph calculation.

getAllL2GraphUserRequest

Returns List of DceL2GraphUserRequest for the given graphType. If the graphType is null returns all type(unicast or multicast or broadcast) of L2GraphUserRequests.

Parameters

opContext—Operational context

opContext—Current Operational context

graphType—graphType is the type(unicast or multicast or broadcast)of graph which the user needs the list of DceL2GraphUserRequest. graphType might be any of the following:

L2GraphType.UNICAST return all the unicast DceL2GraphUserRequests.

L2GraphType.BROADCAST return all the broadcast DceL2GraphUserRequests.

L2GraphType.MULTICAST return all the multicast DceL2GraphUserRequests.

Return Value

List of DceL2GraphUserRequest corresponding to the given graphType or List of all unicast or broadcast or multicast DceL2GraphUserRequest.

getM2ribGraph

Returns the M2ribGraph object that is associated DceL2GraphUserRequest.

InstanceException is thrown if the argument passed graphRequestId is null

Parameters

opContext—Operational context

graphRequestId—InstanceNameId of the DceL2GraphUserRequest

Return Value

M2ribGraph that is associated with the request object calculation.

getInterfaceWithL2IsisSettings

Return a list of switched network interface objects populated with isis setting association.

ValidationException is thrown if the argument passed is null or it is not a valid switched network interface InstanceNameId.

Parameters

opContext—Operational context

interfaceIdCol—InstanceNameId corresponding to the SwitchedNetworkInterface.

Return Value

Instance of SwitchedNetworkInterface.

Following associations will be populated for the SwitchedNetworkInterface:

L2IsisSettingsForNetworkInterface which includes L2IsisProcess and L2IsisAuthenticationSetting.

getL2IsisProcesForL2TopologySettings

Returns List of L2IsisProcess for the given list of L2 topology setting.

ValidationException is thrown if any of the following situation occurs:

If L2TopologySettingIdCol is null or contains invalid L2 topology setting InstanceNameId or null value.

If there is no equivalent L2 topology setting object with the given InstanceNameId in the L2TopologySettingIdCol.

Parameters

opContext—Operational context

L2TopologySettingIdCol—List of InstanceNameId of L2 topology settings.

Return Value

List of L2IsisProcess corresponding to the given L2 topology settings.

getL2IsisProcesses

Returns List of L2IsisProcess for the given list of L2IsisProcess ids.

ValidationException is thrown if any of the following situation occurs:

If isisProcessIdCol is null or contains invalid L2 Isis process InstanceNameId or null value.

If there is no equivalent L2 isis process object with the given InstanceNameId in the isisProcessIdCol.

Parameters

opContext—Operational context

isisProcessIdCol—List of InstanceNameId of network elements.

Return Value

List of L2IsisProcess corresponding to the given L2 isis process Ids.

Following associations will be available for each L2IsisProcess:

L2IsisBasicSetting

L2IsisAuthenticationSetting

LspSetting

SpfInterval

getL2IsisProcessesInNetworkElements

Returns List of List of L2IsisProcess for the given list of network elements.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIds is null or contains invalid NetworkElement InstanceNameId or null value.

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

Parameters

opContext—Operational context

neInstanceNameIds—List of InstanceNameId of network elements.

Return Value

List of List of L2IsisProcess corresponding to the given network elements.

Following associations will be available for each L2IsisProcess:

L2IsisBasicSetting

L2IsisAuthenticationSetting

LspSetting

SpfInterval

getL2IsisProcessWithL2TopologySetting

Return a list of L2IsisProcess objects populated with L2topologySetting association.

ValidationException is thrown if the argument passed is null or it is not a valid L2 isis process InstanceNameId.

Parameters

opContext—Operational context

isisProcessIdCol—InstanceNameId corresponding to the L2IsisProcess

Return Value

Instance of L2IsisProcess.

Following associations will be populated for the L2IsisProcess:

L2IsisTopologySettings which includes L2TopologySetting.

getL2IsisStateInNetworkElements

Returns state of isis service whether fabricpath-isis is enabled or disabled in a list of network elements. Given the list of instance name IDs of the network elements, returns the list of Boolean values.

ValidationException is thrown if any of the following situation occurs:

If neInstanceNameIdCol collection contains an element that is null or the collection is empty or it is not type InstanceNameId

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

Parameters

opContext—Operational context

neInstanceNameIdCol—InstanceNameId of the one or more Network Element for which the fabricpath-isis state is required

Return Value

The returned list will contain Boolean instances.

Boolean value TRUE represents fabricpath-isis is enabled in the given network element.

Boolean value FALSE represents fabricpath-isis is disabled in the given network element.

getM2ribGraph

Returns the M2ribGraph object that is associated DceL2GraphUserRequest.

InstanceException is thrown if the argument passed graphRequestId is null

Parameters

opContext—Operational context

graphRequestId—InstanceNameId of the DceL2GraphUserRequest.

Return Value

M2ribGraph that is associated with the request object calculation

getPortsWithL2IsisSettingsInModule

Returns all the fabricpath capable ports with L2ISIS settings if present,in the module for a given slot.Given the instance name ID of a network element and the slot number of a module, returns a collection of physical interface objects corresponding to the module with L2ISIS settings.

ValidationException is thrown if the argument passed is null or it is not a valid routed port InstanceNameId.

Parameters

opContext—Operational context

neInstanceNameId—InstanceNameId corresponding to the network elements

slotNo—the slot number of the module whose ports are required.For example, if AIDA module slot number as a parameter,returns all the ports present in the module with L2ISIS setting. If there is no L2ISIS configurations available for the ports simply it returns all the physical ports present in the module.

Return Value

List of SwitchedNetworkInterface instances and RoutedNetworkInterface instances present in a module.

Following associations are available:

NetworkInterfaceName

NetworkInterfaceStatus

PortSetting

PortCapability

PortStatus

Routed sub-network interfaces in case of routed port

L2IsisProcess

FabricPathTopologySetting

L2IsisAuthenticationSetting

Following associations will be available for routed sub-network interface:

NetworkInterfaceName

NetworkInterfaceStatus

Encapsulation

modifyL2IsisAuthenticationSettings

Modify one or more existing L2isisAuthentication settings for the process.

ValidationException is thrown if any of the following situation occurs:

If the modifiedIsisAuthSettings is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the modifiedIsisAuthSettings, if any of the L2IsisAuthenticationsettings attribute is not valid.

Parameters

opContext—Operational context

modifiedIsisAuthSettings—modified list of L2IsisAuthenticationSetting objects.

Return Value

void.

modifyL2IsisProcessSettings

Modify one or more existing L2 isis process settings.

ValidationException is thrown if any of the following situation occurs:

If the modifiedIsisProcesses is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the modifiedIsisProcess, if any of the L2 isis settings attribute is not valid.

Parameters

opContext—Operational context

modifiedIsisProcesses—modified list of L2IsisProcess objects.

Return Value

void

modifyL2IsisSettingsForInterfaces

Modify L2 isis settings for an Network Interface object.

ValidationException is thrown if any of the following situation occurs:

If the modifiedInterfaces is null or the collection is empty.

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

PropertiesException is thrown if any of the following situation occurs:

In the modifiedInterface, if any of the L2IsisSettingsForInterface attribute is not valid.

Parameters

opContext—Operational context.

modifiedInterfaces—Modified list of L2IsisProcess objects.

Return Value

void

stopFetchingL2Graph

This method is used to stop the L2Graph discovery. It stops the graph discovery for the given list of InstanceNameId user requests. The corresponding DceL2GraphUserRequest L2graph discovery will be stopped.

ValidationException is thrown if any of the following situation occurs:

If graphRequestIdCol collection is null or it is empty.

If graphRequestIdCol collection contains an element that is not of type DceL2GraphUserRequest InstanceNameId.

If graphRequestIdCol collection contains a DceL2GraphUserRequest that does not exist in the database.

Parameters

opContext—Operational context

graphRequestIdCol—is the List of graphRequests,to stop the L2graph discovery.

Return Value

void

unbindL2topologyFromIsisProcess

Unbinds a set of L2 topologies from its Isis process.

ValidationException is thrown if any of the following situation occurs:

If L2TopologySettingIdCol is null or the list is empty.

IntegrityException is thrown if any of the following situation occurs:

If the corresponding L2 topology setting object for the L2TopologySettingId does not exist.

Parameters

collectionInfoId—InstanceId of the collection info.

L2TopologySettingIdCol—List of InstanceNameId of L2 topology settings to be unbinded from the L2 isis process.

Return Value

void