ARarubanetworks
Switch

Returns VSX details for a specified switch serial number.

This API provides Virtual Switching Extension (VSX) configuration and operational details for a specific switch identified by its serial number. If the switch does not support VSX or VSX is not configured, the API returns a 200 response with an empty VSX object (all fields null).

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

Request

Path parameters

serial-numberstring required
Example:SG9ZKN5018

The serial number of the switch

Response

Object containing VSX information. If the switch does not support VSX or VSX is not configured, an empty VSX object is returned with all fields set to null.

role'primary' | 'secondary'

The role of this device in the VSX pair (primary or secondary)

peerRole'primary' | 'secondary'

The role of the VSX peer device

islPortstring

The Inter-Switch Link port on this device

peerIslPortstring

The Inter-Switch Link port on the peer device

keepaliveStatus'established' | 'failed' | 'not-configured' | 'unknown'

The status of the VSX keepalive connection

keepaliveHealth'healthy' | 'unhealthy' | 'unknown'

The health status of the keepalive connection

keepaliveSourceIpstring

The source IP address used for keepalive messages

keepalivePeerIpstring

The peer IP address for keepalive messages

keepalivePortstring

The port number used for keepalive communication

macstring

MAC address of this device

peerMacstring

MAC address of the VSX peer device

configSyncDisableboolean

Indicates if configuration synchronization is disabled. Defaults to false when not reported by the device.

configSyncStateValue'synchronized' | 'out-of-sync' | 'in-progress' | 'failed' | 'disabled'

State of configuration synchronization

configHealth'ok' | 'warning' | 'error' | 'unknown'

Overall health status of the configuration

islMgmtStateValue'up' | 'down' | 'unknown'

State of the ISL management connection

naeStateValue'enabled' | 'disabled' | 'unknown'

Network Analytics Engine state

httpsServerStateValue'running' | 'stopped' | 'unknown'

HTTPS server state for VSX

islpDeviceStateValue'active' | 'inactive' | 'unknown'

ISL protocol device state

vsxPeerNamestring

Hostname or name of the VSX peer device

vsxPeerSerialstring

Serial number of the VSX peer device

vsxPeerSiteIdstring

Site ID where the VSX peer is located

lastSyncTimestampstring

Timestamp of the last successful synchronization (epoch milliseconds). This field may be null if VSX synchronization has not occurred yet or if the device does not report this information.

Example response

{
  "role": "primary",
  "peerRole": "secondary",
  "islPort": "1/1/49",
  "peerIslPort": "1/1/50",
  "keepaliveStatus": "established",
  "keepaliveHealth": "healthy",
  "keepaliveSourceIp": "192.168.1.1",
  "keepalivePeerIp": "192.168.1.2",
  "keepalivePort": "7678",
  "mac": "aa:bb:cc:dd:ee:ff",
  "peerMac": "11:22:33:44:55:66",
  "configSyncStateValue": "synchronized",
  "configHealth": "ok",
  "islMgmtStateValue": "up",
  "naeStateValue": "enabled",
  "httpsServerStateValue": "running",
  "islpDeviceStateValue": "active",
  "vsxHealth": {
    "health": "ok",
    "healthDescription": "All VSX components are healthy"
  },
  "vsxPeerName": "switch-secondary",
  "vsxPeerSerial": "SNSECONDARY123",
  "vsxPeerSiteId": "site-456",
  "lastSyncTimestamp": "1707919492646"
}

Changes

No recorded changes to this operation across all 1 revision of this API.