Get

/switches/{id}/

This endpoint returns details of a specified switch.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Switch ID

Responses

200

object

id

integer

guid

string

name

string

Switch hostname

title

string

Switch title

cluster

string

Parent Cluster

mgmt_ip

string

fw_version

string

peer_switch

string

mgmt_gateway

string

hostname

string

username

string

password

string (password)

switch_id

integer

cluster_id

string

configured

boolean

role

string

pair_id

string

configuration_file

string

mgmt_subnet

integer

install

boolean

display_name

string

state

string

Switch state

Valid values[ "UNKNOWN", "HEALTHY", "FAILED", "LOGIN_FAILED", "ACTIVATING", "INACTIVE", "DEACTIVATING", "FAILING", "PHASING_OUT", "ENTER_PHASING_OUT", "EXIT_PHASING_OUT", "ACTIVE", "OK", "ERROR" ]

sn

string

Switch Serial Number

model

string

Switch model

mtu

integer

ip

string

Switch external ip

ipv6

string

Switch discovered ipv6

switch_type

string

Valid values[ "arista", "mellanox", "mellanox-os", "aruba", "cumulus", "unknown" ]

Return Details of a Switch