v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Switch

Get hardware trends for a Switch

This API provides hardware trend data for a given site based on a serial number or stack id. When a stack id or conductor serial is provided, the trends are aggregated across for each member of the stack. When a member serial is provided, the trends are aggregated for that specific member. By default, data is aggregated over the last three hours from the current timestamp. Available metrics include CPU utilization, memory utilization, PoE available, PoE consumption, and total power available.

get/network-monitoring/v1/switches/{serial-number}/hardware-trends

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Serial Number of the switch in case of standalone, StackId or conductor serial in case of stack for which the device related information is requested.

Query parameters

site-idstring const

Example:123682

ID of the site for which location analytics trends is requested.

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). By default, aggregation is performed for three hours after the specified timestamp when only the gt operator is used, or up to the specified timestamp when only the lt operator is used. Supported fields, operators and value format are in the below given table.

Field	Operators	Format
timestamp	gt and lt	Date-time (RFC 3339 timestamp in UTC+0) string

The operators are implemented as follows:

gt: Used to indicate the start of the timestamp range.
lt: Used to indicate the end of the timestamp range.

Response

Object containing hardware trends related to the switch.

idstring required

identifier.

typestring required

Device type of monitoring.

metricstring

Trends name.

keysstring[]

Trends list.

unitsstring[]

Units for the trends in the keys list.

Example response

{
  "id": "8",
  "type": "network-monitoring/switch-monitoring",
  "metric": "SwitchNetworkHardwareTrends",
  "keys": [
    "cpuUtilization,memoryUtilization"
  ],
  "switchMetrics": [
    {
      "serialNumber": "CN31HKZ0CN",
      "switchRole": "Member",
      "samples": [
        {
          "data": [
            "27.0,36.0"
          ]
        }
      ]
    }
  ],
  "units": [
    "Frames,B,Packets"
  ]
}