API Guide

5. BARE-METAL-HOST
Bare Metal Host object within a fabric intent
5.1 GET /fabric-intents/{fabric-intent-id}/bare-metal-hosts
Retrieve all Bare Metal Host objects within a fabric intent.
This API returns all bare metal host objects within a fabric intent identied by 'fabric-intent-Id'.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*fabric-intent-id string
Unique identier of the fabric intent
RESPONSE
STATUS CODE - 200: Response to get all Bare Metal Hosts or service appliances
RESPONSE MODEL - application/json
{
A list of all the congured Bare Metal Hosts or Service Appliances
data [{
Array of object: Represents all the congurations details of a Bare Metal Host or Service Appliance.
host_oid string
Unique identier for the bare metal host.
host_name string
Name of the Bare Metal Host or Service Appliance.
tenant {
Tenant using the Host. This will be available only in the BGP EVPN fabric.
id string
ID of the tenant.
name string
Name of the tenant
}
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 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_ports {
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
}]
}
switch_2_ports {
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
70 of 340