--- title: "Get a list of Stack Members" method: GET path: "/network-monitoring/v1/stack/{serial-number}/members" tags: ["Switch"] --- # Get a list of Stack Members `GET /network-monitoring/v1/stack/{serial-number}/members` ## Request - Base URL: `https://sso.common.cloud.hpe.com` - URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/stack/{serial-number}/members` - Auth: OAuth 2 - Client credentials - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2` - TypeScript: (a function with typed inputs; its response is checked against the schema) This API retrieves current stack member details for the specified stack-id or conductor serial. ## Path parameters - `serial-number` string, const, required: The device serial number. ## Response `200` Object containing the stack member information - StackMemberResponse: Response containing a list of stack members and the total count. - `items` Stack[], required: List of stack members. - `id` string, required: Unique identifier for the stack. - `type` string, required: Type of the stack. - `topology` string: Topology of the stack. - `stackType` string: Type of the stack configuration. - `members` StackResponse[]: List of switches that are members of the stack. - `id` string, const, required: Serial of the switch. - `type` string, const, required: API type. - `switchLinkType` string: Link type for switch - `recommendation` unknown[]: Recommended actions for the switch - unknown - `switchType` string: Type of the switch, e.g., pvos or cx - `stpEnable` boolean: Indicates if STP (Spanning Tree Protocol) is enabled - `stpMode` string: Mode of the Spanning Tree Protocol - `serialNumber` string, const - `ipv4` string: The switch IP address in IPv4 format - `status` string: The status of the switch - `ipv6` string: The switch IP address in IPv6 format - `macAddress` string: The MAC address of the switch - `publicIp` string: Public IP address of the switch - `model` string: Model of the switch - `stackId` string: Stack ID of the device - `health` string: Health status of the switch - `healthReasons` SwitchHealthReasons - `poorReasons` string[], required: List of reasons why the switch health is considered poor - `fairReasons` string[], required: List of reasons why the switch health is considered fair - `primaryReason` SwitchHealthPrimaryReason, required - `reasonEnum` string: Health Primary Reason Enum. - `typeId` string: Health Primary Reason TypeId. - `totalReasons` integer: Total health reasons. - `siteId` string, const - `uptimeInMillis` number, float: The elapsed time in milliseconds since the last boot. - `rebootTs` number, float: Timestamp of the last reboot - `firmwareVersion` string: Current firmware version of the switch - `deployment` string: Deployment mode of the switch - `firmwareUpdatedTs` number, float: Timestamp of the last firmware update - `firmwareBackupVersion` string: Backup firmware version of the switch - `firmwareStatus` string: Status of the firmware - `firmwareRecommendedVersion` string: Recommended firmware version for the switch - `contact` string: Contact person or email for the switch - `jNumber` string: Job number or identifier - `lastSeenAt` number, float: Timestamp when the switch was last seen online - `managementVlan` integer: Management VLAN ID - `nativeVlan` integer: Native VLAN ID - `configStatus` string: Configuration status of the switch - `deviceName` string: Name of the switch - `switchRole` string: Role of the switch in the network - `manufacturer` string: Manufacturer of the switch - `location` string: Physical location of the switch - `stackMemberId` integer: Member ID of the switch in a stack configuration - `stackMemberStatus` string: Status of the switch within the stack - `stackMemberPriority` integer: Priority of the switch within the stack - `lastConfigChange` number, float: Timestamp of the last configuration change - `lastRestartReason` string: Reason for the last restart - `portLinks` StackPortLinks[]: Port links within the stack. - `serialNumber` string, required: Serial number of the switch. - `links` SwitchInterface[], required: List of switch interfaces. - `id` string, required: Interface name. - `name` string, required: Name of the switch interface. - `index` integer, required: Index of the switch interface. - `alias` string: Alias name for the interface. - `status` string, required: Operational status of the interface. - `errorReason` string: Reason for any error on the interface. - `description` string: Description of the interface. - `adminStatus` string, required: Administrative status of the interface. - `operStatus` string, required: Operational status of the interface. - `mtu` integer: MTU size of the interface. - `speed` number, float: Speed of the interface in Mbps. - `connector` string: Type of connector used by the interface. - `duplex` string: Duplex mode of the interface. - `lag` string: Link Aggregation Group (LAG) associated with the interface. - `vlanMode` string: VLAN mode of the interface. - `allowedVlans` string[]: List of allowed VLAN names on the interface. - `allowedVlanIds` integer[]: List of allowed VLAN IDs on the interface. - `nativeVlan` integer: Native VLAN ID of the interface. - `poeStatus` string: PoE (Power over Ethernet) status of the interface. - `poeClass` string: PoE class of the interface. - `portAlignment` string: Alignment status of the port. - `serialNumber` string: Serial number associated with the interface. - `peerPort` string: Name of the peer port connected to this interface. - `peerMemberId` integer: Member ID of the peer device. - `uplink` boolean: Indicates if the interface is an uplink port. - `type` string, required: Type of the interface. - `portError` string[]: List of errors associated with the port. - `module` string: Module number of the interface. - `neighbour` string: Name of the neighbouring device connected to this interface. - `neighbourPort` string: Port on the neighbouring device connected to this interface. - `neighbourFamily` string: Family of the neighbouring device. - `neighbourFunction` string: Function of the neighbouring device. - `neighbourRole` string: Role of the neighbouring device. - `neighbourHealth` string: Health status of the neighbouring device. - `neighbourSerial` string: Serial number of the neighbouring device. - `neighbourType` string: Type of the neighbouring device. - `isMultipleNeighbourClients` boolean: Indicates if the port is connected to multiple clients on the neighbouring device. - `transceiverType` string: Type of transceiver used in the interface. - `transceiverSerial` string: Serial number of the transceiver. - `transceiverModel` string: Model of the transceiver. - `transceiverProductNumber` string: Product number of the transceiver. - `transceiverStatus` string: Status of the transceiver. - `ipv4` string: IPv4 address assigned to the interface. - `stpInstanceType` string: Type of Spanning Tree Protocol (STP) instance. - `stpInstanceId` integer: Identifier of the STP instance. - `stpPortRole` string: Role of the port within the STP instance. - `stpPortState` string: State of the port within the STP instance. - `stpPortInconsistent` string: Indicates if there is any inconsistency in the STP port. - `count` integer, required: Total number of stack members. ## Other responses - `400`: Invalid input received. - `401`: Unauthorized. Authentication credentials are required or invalid. - `403`: Forbidden: Access is denied. - `404`: Device with serial number not found. - `429`: Too Many Requests. The user has sent too many requests in a given amount of time. - `500`: Internal Server Error. An unexpected error occurred on the server. --- [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)