---
title: "Returns VSX details for a specified switch serial number."
method: GET
path: "/network-monitoring/v1/switches/{serial-number}/vsx"
tags: ["Switch"]
---

# Returns VSX details for a specified switch serial number.

`GET /network-monitoring/v1/switches/{serial-number}/vsx`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/switches/{serial-number}/vsx`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`

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).

## Path parameters

- `serial-number` string, required

## Response `200`

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.

- VsxResponse: VSX configuration and operational details for a switch
  - `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
  - `islPort` string: The Inter-Switch Link port on this device
  - `peerIslPort` string: 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
  - `keepaliveSourceIp` string: The source IP address used for keepalive messages
  - `keepalivePeerIp` string: The peer IP address for keepalive messages
  - `keepalivePort` string: The port number used for keepalive communication
  - `mac` string: MAC address of this device
  - `peerMac` string: MAC address of the VSX peer device
  - `configSyncDisable` boolean: 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
  - `vsxHealth` VsxHealth: Health information for VSX components
    - `health` 'ok' | 'warning' | 'critical' | 'unknown': Overall health status
    - `healthDescription` string: Detailed description of the health status
  - `vsxPeerName` string: Hostname or name of the VSX peer device
  - `vsxPeerSerial` string: Serial number of the VSX peer device
  - `vsxPeerSiteId` string: Site ID where the VSX peer is located
  - `lastSyncTimestamp` string: 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.

## Other responses

- `400`: Bad request: invalid or missing serial number
- `401`: Unauthorized request
- `403`: Forbidden: insufficient permissions
- `404`: Switch not found or device offline
- `429`: Too many requests
- `500`: Internal server error

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)