The API provides detailed information of a Gateway

get https://ge1.api.central.arubanetworks.com/network-monitoring/v1alpha1/gateways/{serial-number}

This API retrieves detailed information about a specific gateway linked to a particular site. It provides gateway related details such as MAC address, name, status, uplinks, ports, vlans based on the gateway's serial number associated with the site.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

serial-number

string

required

length ≤ 16

Serial number of an gateway device.

Query Params

filter

string

required

length ≤ 256

OData Version 4.0 filter string (limited functionality). Supported fields and operators are in the below given table.

Field	Operators
`siteId`	`eq`

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.

Responses

Response body

object

serialNumber

string

required

length ≤ 16

Device serial number.

macAddress

string

required

length ≤ 18

The gateway MAC address.

siteId

string

required

length ≤ 128

deviceName

string

required

length ≤ 256

The gateway name.

ipv4

string

length ≤ 15

IP address of the vlan.

ipv6

string

length ≤ 39

IPv6 address of the gateway.

model

string

length ≤ 256

The gateway model.

softwareVersion

string

length ≤ 32

Firmware version currently running on the gateway.

status

string

length ≤ 16

The status of modem, that if it is online or offline.

CONNECTED DISCONNECTED

lastSeenAt

date-time

length ≤ 128

An RFC 3339 date-time indicating the last detected time of the gateway in the system. If the gateway is online, this value will be null.

uptimeInMillis

double

0 to 9223372036854776000

Elapsed time in milliseconds since the gateway's last boot. This value will be null if the gateway is offline.

lastRestartReason

string

length ≤ 256

lastRestartReason description

UNKNOWN: 'Unknown'
GW_RELOAD: 'Reload'
USER_REBOOT: 'User reboot'
WRITE_ERASE_REBOOT: 'Write erase reboot'
WRITE_ERASE_ALL_REBOOT: 'Write erase all reboot'
IMAGE_SYNC_FAILED: 'Image sync failed'
IMAGE_SYNC_SUCCESSFUL: 'Image sync successful'
IMAGE_UPGRADE: 'Image upgrade successful'
IMAGE_DOWNLOAD_FAILURE: 'Image download failure'
OUT_OF_MEMORY: 'Reboot caused by out of memory'
DOWN_UPLINK: 'Current uplink down, no useable uplink.'
CONDUCTOR_TO_LOCAL: 'Conductor transitioned to local'
NETWORK_DISCONNECT_USB_RESET: 'Internet connection lost, reset usb modem'
NETWORK_DISCONNECT: 'Internet connection lost'
UNREACHABLE_GATEWAY: 'Gateway unreachable'
FATAL_EXCEPTION: 'Reboot caused by kernel panic: fatal exception'
FATAL_EXCEPTION_IN_INTERRUPT: 'Reboot caused by kernel panic: fatal exception in interrupt'
SOFTLOCKUP: 'Reboot caused by kernel panic: softlockup: hung tasks'
NTP_SYNC: 'System clock is too far ahead of ntp sync result'
BAD_MESH_LINK: 'Mesh link bad. Rebooting mesh point by sapd'
MESH_TO_PORTAL: 'Mesh point transitioned to portal'
REBOOT_BY_AIRWAVE: 'Reboot by Airwave'
AMP_COMMAND: 'Amp'
VC_COMMAND: 'VC'
REBOOTED_BY_CENTRAL: 'Reboot by Central'
CLOUD_MANAGEMENT_COMMAND: 'Cloud management'
CLI_COMMAND: 'CLI'
CONDUCTOR_IP_FAILURE: 'Failed to get conductor-ip'
NON_FIPS: 'Non-fips --> fips'
FIPS: 'Fips --> non-fips'
TOPOLOGY_CHANGE: 'Rebooting GW due to topology change: hierarchy to flat'
GW_DISCONNECTED: 'GW disconnected from Aruba Central'
VC_DISCONNECTED: 'Virtual controller disconnected from Aruba Central'
COLD_HW_RESET: 'GW reboot caused by cold hw reset(power loss)'
POWER_LOSS: 'GW rebooted due to loss power'
THERMAL_MODE: 'Reboot due to trigger the cooldown event'
OVERHEAT_EVENT: 'Reboot due to trigger the overheat event'
PREEMPTED_BY_CONDUCTOR: 'Preempted by provisioned conductor'

manufacturer

string

length ≤ 32

Manufacturer of the gateway.

role

string

length ≤ 16

Role of the gateway in the network-topology.

deployment

string

Deployment of the switch.

STANDALONE STACK

clusterName

string

length ≤ 256

The cluster to which the gateway is part of.

siteName

string

length ≤ 256

The site to which gateway is assigned.

publicIpv4

string

length ≤ 15

IP address logged by servers when the gateway device is connected through internet connection.

failureReason

string

length ≤ 256

partNumber

string

length ≤ 12

The part number of the gateway

persona

string

length ≤ 20

Persona identifier for the gateway.

uplinks

object

required

Uplinks of gateway attributes

vlanId

int64

1 to 4095

The vlanId configured in gateway

linkTag

string

length ≤ 256

publicIp

string

length ≤ 15

IP address logged by uplink is connected to gateway.

privateIp

string

length ≤ 15

Private IP of the uplink connected to gateway.

uplinkType

string

length ≤ 256

transport

string

length ≤ 256

status

string

length ≤ 16

The status of modem, that if it is online or offline.

CONNECTED DISCONNECTED

wanBackup

string

length ≤ 256

ports

object

required

Ports of gateway attributes

macAddress

string

length ≤ 18

The gateway port MAC address.

name

string

length ≤ 16

portNumber

int32

The port number.

portType

string

length ≤ 50

The port type.

duplex

string

length ≤ 50

The Duplex of the port.

speed

int32

The port speed

vlanMode

string

length ≤ 50

The vlanMode of the port.

status

string

length ≤ 10

The port status of gateway

Up Down

description

string

length ≤ 256

The description of port.

vlan

string

The vlan id assigned to port.

vlanNative

string

The vlan native value of port.

mtu

int32

The value of port mtu.

pcId

int32

The port channel id of the port.

vlans

object

required

Vlans of gateway attributes

vlanId

int64

1 to 4095

The vlanId configured in gateway

name

string

length ≤ 16

type

string

length ≤ 36

The type of the resource.

status

string

length ≤ 16

The status of modem, that if it is online or offline.

CONNECTED DISCONNECTED

adminStatus

string

length ≤ 10

The admin status of vlan

Up Down

ipv4

string

length ≤ 15

IP address of the vlan.

ipv4Subnet

string

length ≤ 15

IP address of the vlans's subnet.

ipv4MaskAddr

string

length ≤ 15

The masked IP address of vlan.

interfaces

string

The interface to which vlan is assigned.

voice

string

The voice traffic of vlan.

ipv6Prefix

string

The prefix of ipv6 address.

string

required

length ≤ 36

Primary identifier for the resource.

type

string

required

length ≤ 36

The type of the resource.

Headers

object

X-RateLimit-Limit

int64

0 to 9223372036854776000

Request limit per hour.

X-RateLimit-Remaining

int64

0 to 9223372036854776000

The number of requests left for the time window.

X-RateLimit-Reset

date-time

length ≤ 20

The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://ge1.api.central.arubanetworks.com/network-monitoring/v1alpha1/gateways/serial-number \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Object containing information about the gateway, such as MAC address, name, status, uplinks, ports, vlans

400Invalid input received.

401Unauthorized request.

403Forbidden: Access is denied.

404Not Found error

429Too Many Requests. Rate limit exceeded.

500Internal Server Error.