v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Switch

Get a list of Stack Members

This API retrieves current stack member details for the specified stack-id or conductor serial.

get/network-monitoring/v1/stack/{serial-number}/members

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 stack member information

countinteger required

Total number of stack members.

Example response

{
  "items": [
    {
      "id": "stack-12345",
      "type": "stack-members",
      "topology": "Ring",
      "stackType": "Virtual",
      "members": [
        {
          "id": "CN31HKZ0CN",
          "type": "switch",
          "switchLinkType": "BPS",
          "recommendation": null,
          "switchType": "pvos",
          "stpEnable": false,
          "stpMode": null,
          "serialNumber": "CN31HKZ0CN",
          "ipv4": "10.21.78.3",
          "status": "Offline",
          "ipv6": null,
          "macAddress": "ec:50:aa:0d:99:30",
          "publicIp": "59.144.73.163",
          "model": "AS-2930F",
          "stackId": null,
          "health": "Poor",
          "healthReasons": {
            "poorReasons": [
              "DEVICE_OFFLINE"
            ],
            "fairReasons": {},
            "primaryReason": {
              "reasonEnum": "None",
              "typeId": "None",
              "totalReasons": 0
            }
          },
          "siteId": "749988555",
          "uptimeInMillis": null,
          "rebootTs": null,
          "firmwareVersion": "WC.16.11.0001",
          "deployment": "Standalone",
          "firmwareUpdatedTs": null,
          "firmwareBackupVersion": null,
          "firmwareStatus": null,
          "firmwareRecommendedVersion": null,
          "contact": "",
          "jNumber": "JL258A",
          "lastSeenAt": 1707919492646,
          "managementVlan": null,
          "nativeVlan": null,
          "configStatus": "Synchronized",
          "deviceName": "Aruba-2930F-8G-PoEP-2SFPP",
          "switchRole": "Standalone",
          "manufacturer": "Aruba",
          "location": "",
          "stackMemberId": 2,
          "stackMemberStatus": null,
          "stackMemberPriority": null,
          "lastConfigChange": 1707907296000,
          "lastRestartReason": null
        }
      ],
      "portLinks": [
        {
          "serialNumber": "CN31HKZ0CN",
          "links": [
            {
              "name": "GigabitEthernet1/0/1",
              "index": 1,
              "alias": "GE1",
              "status": "Up",
              "errorReason": null,
              "description": "Uplink to Core Switch",
              "adminStatus": "Up",
              "operStatus": "Up",
              "mtu": 1500,
              "speed": 1000,
              "connector": "RJ45",
              "duplex": "Full",
              "lag": null,
              "vlanMode": "Access",
              "allowedVlans": [
                "VLAN10",
                "VLAN20"
              ],
              "allowedVlanIds": [
                10,
                20
              ],
              "nativeVlan": 1,
              "poeStatus": "Enabled",
              "poeClass": "Class4",
              "portAlignment": "Aligned",
              "serialNumber": "CN31HKZ0CN",
              "peerPort": "GigabitEthernet1/0/24",
              "peerMemberId": 2,
              "uplink": true,
              "type": "GigabitEthernet",
              "portError": [],
              "module": "1",
              "neighbour": "CoreSwitch",
              "neighbourPort": "GigabitEthernet1/0/24",
              "neighbourFamily": "Aruba",
              "neighbourFunction": "Core",
              "neighbourRole": "Core Switch",
              "neighbourHealth": "Good",
              "neighbourSerial": "CN32HKZ0DN",
              "neighbourType": "Switch",
              "isMultipleNeighbourClients": false,
              "transceiverType": "SFP",
              "transceiverSerial": "SFP123456",
              "transceiverModel": "SFP-1G-LX",
              "transceiverProductNumber": "J4859C",
              "transceiverStatus": "Good",
              "ipv4": "10.1.1.1",
              "stpInstanceType": "RSTP",
              "stpInstanceId": 0,
              "stpPortRole": "Root",
              "stpPortState": "Forwarding",
              "stpPortInconsistent": "None"
            }
          ]
        }
      ]
    }
  ],
  "count": 5
}