API Guide

allowed VLANs and switched interfaces on the leaf switches during deployment, so that trac from these hosts can be
handled. This operation can only be done on a fabric intent in DRAFT state.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*fabric-intent-id string
Unique identier of the fabric intent
REQUEST BODY - application/json
{
Represents all the input parameters required to congure a Bare Metal Host or Service Appliance.
host_name* string
Name of the Bare Metal Host or Service Appliance.
tenant_oid string
Id of the tenant who is using the Host. This will be needed only for BGP EVPN Fabric.
port_type* enum ALLOWED:TRUNK, ACCESS
Type of switched interface to be created on the leaf switch for VLAN(s).
use_switch_native_vlan boolean
Species if switch native vlan needs to be used
native_vlan integer
VLAN that will handle untagged trac received on TRUNK ports. This will hold the native
Vlan ID if switch native vlan is not being used.
workload_vlan* [integer]
description string
An optional description for the host.
leaf_switch_config* {
Leaf switch rack and the ports on the leaf switches, which the host is connected to.
switch_1_id* string
ID of one switch in the leaf rack.
switch_2_id* string
ID of the other switch in the leaf rack.
switch_1_port_ids* [string]
switch_2_port_ids* [string]
}
}
RESPONSE
STATUS CODE - 201: New entity created successfully.
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 - 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
72 of 340