API Guide

2) It can be used to get all available ports on a leaf switch, which can then be used to congure a host.
For other cases, it can be use to fetch port information for a switch.
switch_id string
Unique identier of the switch
switch_name string
Name of the switch
ports [{
Array of object:
port_id string
Unique identier of the port
port_name string
Name of the port
}]
}
switch_2 {
A model representing a switch, and some/all of the ports on it. This representation can be reused for a lot of use-cases.. For bare metal hosts,
1) It can be used to get all the leaf switch ports tha are connected to the host.
2) It can be used to get all available ports on a leaf switch, which can then be used to congure a host.
For other cases, it can be use to fetch port information for a switch.
switch_id string
Unique identier of the switch
switch_name string
Name of the switch
ports [{
Array of object:
port_id string
Unique identier of the port
port_name string
Name of the port
}]
}
configured_vlans [integer]
}
STATUS CODE - 401: You are not authorized to perform this operation.
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
Message in the localized le.
}]
}
STATUS CODE - default: success or error response
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
80 of 340