Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Understanding the IP/MPLSView Performance Management API

 

The performance management API root is /IPMPLSView/API/v1/tenant/1/pm/1. It only allows GET requests. Performance management is valid for the live network only. The live network nodes and performance management nodes are disjointed, but they may intersect.

Table 1 lists the performance management-related APIs.

Object

URL

Description

Categories

/

Lists the available performance management categories.

System uptime

/devicePerformance/systemUptime

Returns system uptime information.

  • No parameters: available dates

  • from, to: start/end date in yyyymmdd

  • router: router filtering

  • offset: beginning of data - line number

  • limit: number of lines to be returned, -1 for end of data

CPU temperature

/devicePerformance/CPUTemp

Returns CPU temperature information.

CPU usage

/devicePerformance/CPUUsage

Returns CPU usage (load) data.

Memory usage

/devicePerformance/memoryUsage

Returns memory usage data.

Ping

/networkPerformance/ping

Performs a network ping operation.

Advanced ping

/networkPerformance/advPing

Performs an advanced network ping.

LSP ping

/networkPerformance/LSPPing

Performs an LSP ping.

SLA

/networkPerformance/SLA

Returns network SLA information.

Link latency

/networkPerformance/LinkLatency

Returns link latency information.

Categories

  • categories: List of category

  • category: object, properties :

    • name: The category name, (devicePerformance/systemUptime, …)

Parameters

  • No parameters: Returns available dates

  • from: Start date in yyyymmdd

  • to: End date in yyyymmdd, default is same value as from

  • router: Router filtering

  • offset: Beginning line of the data, must be positive

  • limit: Number of lines to be returned, -1 for end of data

The URL also accepts start/end timestamp, the get totalObject (total number of result).