API Guide

20. SWITCH INFORMATION
20.1 GET /switches/summary
get summary of all switch
REQUEST
No request parameters
RESPONSE
STATUS CODE - 200: list of switch summary
RESPONSE MODEL - application/json
{
This object represent the list of switch summary.
data [{
Array of object: switch summary
id string
Unique identier of the switch object
name string
name of the switch
service_tag string
service tag of switch
model string
model of the switch
os_version string
os version of the switch
status {
"Describes the state of switch in the topology. If the switch is discovered, reachable etc"
switch_state enum ALLOWED:DEFINED, MAINTENANCE, REACHABLE, PROVISIONED, ACTIVE,
ERROR, UNMANAGED, REBOOT_IN_PROGRESS
The current state of the switch. The switch is Manintenance state if any LCM job is being performed
on this job. The Switch will be in unmanaged state if the this switch is not supported by SFD based on
SFD manifest le. The switch can be in ERROR state becuase of various reasons. Like not reachable,
auth failure, cong errors etc.
error_detail enum ALLOWED:NONE, CREDENTIAL_FAIL, UNREACHABLE, CONFIG_ERROR,
NOT_OPERATIONAL
If the switch state is in error then this enum tells the reason for that error.
}
role enum ALLOWED:LEAF, SPINE, EDGE_LEAF,
EDGE_CLOUD
The Role for a switch, if its a LEAF, SPINE, or an
EDGE_LEAF
}]
}
STATUS CODE - 400: Invalid request.
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
252 of 340