API Guide

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
Message in the localized le.
}]
}
5.6 GET /fabric-intents/{fabric-intent-id}/bare-metal-hosts/availability
Retrieve all available vlans and hostlink ports in the fabric for a leaf rack
This API returns all the vlans that have been congured on a leaf rack via the host networks and vxlan segments. IT also
returns all the hostlink ports on the leaf rack that are free, and can be used to connect a bare metal host.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*fabric-intent-id string
Unique identier of the fabric intent
QUERY PARAMETERS
NAME TYPE DESCRIPTION
*switch-1-id string
Unique identier of one of switches in the leaf rack
*switch-2-id string
Unique identier of the other switch in the leaf rack
RESPONSE
STATUS CODE - 200: Response to get all available vlans and ports on a leaf rack, to congure bare metal hosts.
RESPONSE MODEL - application/json
{
All the vlans that are congured on a leaf rack. Also retrieves all the hostlink ports that are free on the leaf rack, that can be used to connect/
congure a bare metal host.
switch_1 {
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.
79 of 340