v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Switch

Get Switch details

This API retrieves current switch information for the specified serial number or stack id. Conductor serial may also be used instead of a stack id. In the case of stacked switches, logical switch details and trend data are also provided. Member-level information can be obtained using the listStackMember API.

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

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.

Response

Object containing the switch information

idstring const required

Serial of the switch.

typestring const required

API type.

switchLinkTypestring

Link type for switch

switchTypestring

Type of the switch, e.g., pvos or cx

serialNumberstring const

ipv4string

The switch IP address in IPv4 format

statusstring

The status of the switch

ipv6string

The switch IP address in IPv6 format

macAddressstring

The MAC address of the switch

publicIpstring

Public IP address of the switch

modelstring

Model of the switch

healthstring

Health status of the switch

siteNamestring

SiteName

siteIdstring const

uptimeInMillisnumber float

The elapsed time in milliseconds since the last boot.

firmwareVersionstring

Current firmware version of the switch

deploymentstring

Deployment mode of the switch

jNumberstring

Job number or identifier

lastSeenAtnumber float

Timestamp when the switch was last seen online

deviceNamestring

Name of the switch

switchRolestring

Role of the switch in the network

manufacturerstring

Manufacturer of the switch

lastConfigChangenumber float

Timestamp of the last configuration change

lastRestartReasonstring

Reason for the last restart

Example response

{
  "id": "CN31HKZ0CN",
  "type": "switch",
  "switchLinkType": "BPS",
  "switchType": "pvos",
  "serialNumber": "CN31HKZ0CN",
  "ipv4": "10.21.78.4",
  "status": "Offline",
  "ipv6": null,
  "macAddress": "ec:50:aa:0d:99:30",
  "publicIp": "59.144.73.163",
  "model": "AS-2930F",
  "health": "Poor",
  "healthReasons": {
    "poorReasons": [
      "DEVICE_OFFLINE"
    ],
    "fairReasons": {}
  },
  "siteId": "749988555",
  "siteName": "PVOS_MON_Troubleshooting",
  "uptimeInMillis": null,
  "firmwareVersion": "WC.16.11.0001",
  "deployment": "Standalone",
  "contact": "",
  "jNumber": "JL258A",
  "lastSeenAt": 1707919492646,
  "configStatus": "Synchronized",
  "deviceName": "Aruba-2930F-8G-PoEP-2SFPP",
  "switchRole": "Standalone",
  "manufacturer": "Aruba",
  "lastConfigChange": 1707907296000,
  "lastRestartReason": null,
  "switchTrends": [
    {
      "serialNumber": "CN09HKW38R",
      "switchRole": "Conductor",
      "cpuUtilization": 10,
      "memoryUtilization": 36,
      "systemTemperature": 70,
      "poeAvailable": 370,
      "powerConsumption": 0,
      "upLinkPorts": "1/8",
      "usage": 14345.45
    }
  ]
}