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

PathLatencyApp Service

Table Of Contents

PathLatencyApp Service

Information About PathLatencyApp Service

createPathLatencySession

deletePathLatencySession

disablePongService

enablePongService

fetchPathLatencyStatistics

fetchPortStaticMacAddress

getAllPathLatencySessions

getAllPathLatencySessionsByUserId

getAllPathsInSessionsByDays

getAllPathsInSessionsByTimeRange

getPathLatencyStatisticsSummary

getPathLatencyStatisticsSummaryDetails

getPongGlobalSettting

getSessionStatisticalDataByDays

getSessionStatisticalDataByTimeRange

modifyPathLatencySessions

validatePathLatencySessionConnectivity


PathLatencyApp Service


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

Information About PathLatencyApp Service

This interface defines all the APIs exposed by the PathLatencyApp service facade.

createPathLatencySession

Creates one or more PathLatencySession objects.

Parameters

opContext—Operational context.

pathLatencyCol—List of PathLatencySession objects.

Return Value

A list of the PathLatencySessions that are created inthe server.

deletePathLatencySession

Deletes one or more PathLatencySession objects of the given InstanceNameId.

Parameters

opContext—Operational context.

pathLatencyInsIdCol—A collection that contains InstanceNameId of one or more PathLatencySession objects that needs to be deleted.

Return Value

void

disablePongService

Disables the PONG service on one or more network element. This API is applicable only for devices that are running Cisco NX-OS that supports PONG 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.

Parameters

opContext—Operational context.

neInstanceNameIdCol—A list of InstanceNameIds of the Network Elements for which you want to disable the PONG feature.

Return Value

void.

enablePongService

Enables the PONG service on one or more network element. This API is applicable only for devices that are running Cisco NX-OS that supports PONG 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.

Parameters

opContext—Operational context.

neInstanceNameIdCol—A list of InstanceNameIds of the Network Elements for which you want to enable the PONG feature.

Return Value

void.

fetchPathLatencyStatistics

Return the last CollectedData collection of PathLatencyStatistics initilialized with specified collection statistics either NodeLatencyStatistics or LinkLatencyStatistics or both.

Parameters

opContext—Operational context.

collectionInfoId —The instance nameId of the CollectionInfo that refers to the PongLatencySession.

fetchNodeLatency—Initialize the node latency statistics collection.

fetchLinkLatency—Initialize the link latency statistics collection.

Return Value

A list of ExtendedCollectedData that refers to PathLatencyStatistics initialized with node or link statistics or both.

fetchPortStaticMacAddress

Returns the set of MacTableEntry object that is associated with the fetch call.

ValidationException is thrown if any of the following situation occurs:

If the portInstanceNameIds is null or the collection is empty.

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

Parameters

opContext—Operational context.

portInstanceNameIds—A list of InstanceNameId of the Network interface objects.

vlanId—VLANId that is associated with the static MAC address for port.

Return Value

A set of MacTableEntry that contain the static MAC port associated with the VLAN Range.

getAllPathLatencySessions

Returns all the path latency sessions present in the application. Each of the path latency session contains the session details with the following association initialized:

PathLatencySourceSetting—Source details for the PathLatency Session.

PathLatencyDestinationSetting—Destination details for the PathLatency Session.

Parameters

opContext—Operational context

Return Value

All the PathLatencySessions that is persisted in database.

getAllPathLatencySessionsByUserId

Returns all the path latency sessions that are created by the user. Each of the path latency session contains the session details with the following association initialized:

PathLatencySourceSetting—Source details for the PathLatency Session.

PathLatencyDestinationSetting—Destination details for the PathLatency Session.

Parameters

opContext—Operational context.

userId—The name of the user who created the path latency session.

Return Value

All the PathLatencySessions that is created by the particular user.

getAllPathsInSessionsByDays

Returns all the different paths that are associated with each path latency sessions for the specified number of (last) days.

ValidationException is thrown if if any of the following situation occurs:

The argument passed is null

Not a valid InstanceNameId of an CollectionInfo.

Parameters

opContext—Operational context.

collectionInfoIds—InstanceNameId of the CollectionInfo.

noOfDays—Specifies the number of days for which the path details are required.

Return Value

A list of different paths associated with each path latency session.

getAllPathsInSessionsByTimeRange

Returns all the different paths associated with each path latency session for the specified time interval.

NodeLatencyStatistics—If fetchNodeLatency attribute is set to true

LinkLatencyStatistics—If fetchLinkLatency attribute is set to true.

ValidationException is thrown if any of the following situation occurs:

If the argument passed is null.

If the fetchNodeLatency is null.

If the fetchLinkLatency is null.

If the collectionInfoIds is not a valid collection info InstanceNameId.

If the LatencyCriterion is null, this API returns specified number of rows for the collection of PathLatencyStatistics that is initialized with the NodeLatencyStatistics and linkLatencyStatistics.

Parameters

opContext—Operational context.

collectionInfoIds—The list of instance name id of the collectionInfos..

startTime—Represents the given start time stamp.

endTime—Represents the given end time stamp.

maxLimits—Specifies the max points to be returned.

fetchNodeLatency—Initialize the node latency statistics collection.

fetchLinkLatency—Initialize the link latency statistics collection.

noOfDays—Specifies the no of days to get collected statistical data.

Return Value

A collection of list of different paths associated with each path latency session. If the specified path does not exist, it returns the empty list.

getPathLatencyStatisticsSummary

Returns a list of PathLatencyStatisticsSummary objects for the given PathLatency Window type (Daily,Weekly,Monthly or Yearly) for the CollectionInfo of the PathLatnecySession.

Parameters

opContext—Operational context.

collectionInfoId—The instanceId of the CollectionInfo refering to PongLatencySession.

windowType—PathLatencyWindowType.

Return Value

List of PathLatencyStatisticsSummary objects.

getPathLatencyStatisticsSummaryDetails

Returns a list of PathLatencyStatisticsSummaryDetail objects for the given PathLatnecy Window type (Daily,Weekly,Monthly or Yearly) for the CollectionInfo of the PathLatnecySession.

Parameters

opContext—Operational context.

collectionInfoId—The instanceId of the CollectionInfo refering to PongLatencySession.

windowType—PathLatencyWindowType.

beginTimestamp—Time from which the PathLatency details are required.

Return Value

A list of PathLatencyStatisticsSummaryDetail objects.

getPongGlobalSettting

Returns a list of PongGlobalSetting objects.

Parameters

opContext—Operational context.

neInstanceNameIdCol—A list of InstanceNameIds of the NetworkElements for which you want to enable or disable the PONG feature.

Return Value

A list of PongGlobalSetting objects.

getSessionStatisticalDataByDays

Returns the CollectedData collection of PathLatencyStatistics measured along the specified path along with fetching the following statisticsCol:

NodeLatencyStatistics—If fetchNodeLatency attribute is set to true

LinkLatencyStatistics—If fetchLinkLatency attribute is set to true.

ValidationException is thrown if any of the following situation occurs:

If the criterion is null.

If the collectionInfoId is null.

If the fetchNodeLatency is null.

If the fetchLinkLatency is null.

If the collectionInfoId is not a valid collection info InstanceNameId.

If the LatencyCriterion is null, this API returns specified number of rows for the collection of PathLatencyStatistics that is initialized with the NodeLatencyStatistics and linkLatencyStatistics.

Parameters

opContext—Operational context.

collectionInfoId—The instance id of the CollectionInfo refering to PongLatencySession.

criterion—The latency criterion for filtering (based on path or node or link).

fetchNodeLatency—Initialize the node latency statistics collection.

fetchLinkLatency—Initialize the link latency statistics collection.

startTime—Starting time stamp.

noOfDays—Specifies the no of days to get collected statistical data.

Return Value

List representing the VLAN range associated to each Firewall module

getSessionStatisticalDataByTimeRange

Returns the CollectedData collection of PathLatencyStatistics measured along the specified path along with fetching the following statisticsCol:

NodeLatencyStatistics—If fetchNodeLatency attribute is set to true

LinkLatencyStatistics—If fetchLinkLatency attribute is set to true.

ValidationException is thrown if any of the following situation occurs:

If the criterion is null.

If the collectionInfoId is null.

If the fetchNodeLatency is null.

If the fetchLinkLatency is null.

If the collectionInfoId is not a valid collection info InstanceNameId.

If the LatencyCriterion is null, this API returns specified number of rows for the collection of PathLatencyStatistics that is initialized with the NodeLatencyStatistics and linkLatencyStatistics.

Parameters

opContext—Operational context.

collectionInfoId—The instance id of the CollectionInfo refering to PongLatencySession.

criterion—The latency criterion for filtering (based on path or node or link).

fetchNodeLatency—Initialize the node latency statistics collection.

fetchLinkLatency—Initialize the link latency statistics collection.

startTime—Starting time stamp.

maxLimits—Specifies the maximum points to be returned.

Return Value

List of CollectedData refering to PathLatencyStatistics If the specified criterion does not match, it will return empty list.

modifyPathLatencySessions

Modify one or more existing PathLatencySession.

ValidationException is thrown if the following situation occurs:

If the modifiedPathLatencySessions is null or the collection is empty.

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

PropertiesException is thrown if the following situation occurs:

In the modifiedPathLatencySessions, if any of the PathLatencySessionsattribute is not valid.

Parameters

opContext—Operational context.

modifiedThresholdSetting—The modified GlobalLatencyThresholdSetting object.

Return Value

void.

validatePathLatencySessionConnectivity

Verifies whether there is a link between given source and destination switches for the path latency sessions. It also checks whether they are able to send packet from source to destination for the PathLatencySession object then returns the appropriate status message in SessionConnectionStatus object.

Parameters

opContext—Operational context.

pathLatencySession—PathLatencySession to test the connectivity

Return Value

SessionConnectionStatus status