API Guide

NAME TYPE DESCRIPTION
*id string
Unique identier of the fabric intent
RESPONSE
STATUS CODE - 200: Success response to retrieve the fabric intent conguration
RESPONSE MODEL - application/json
{
This object represents the generated conguration for the fabric intent.
switches [{
Array of object: This objects represents the network conguration applied on the switch
id string
This is unique identier of the switch in the fabric
name string
The name of the switch.
interfaces [{
Array of object:
id string
Unique identier of the interface in the switch
type enum ALLOWED:ETHERNET, LOOPBACK, ROUTED_VLAN, AGGREGATION, UNDEFINED
Describes the type of interface
role enum ALLOWED:MANAGEMENT, EDGELINK, HOSTLINK, VLTLINK, INTERLINK,
LOOPBACK, UNDEFINED, NOT_APPLICABLE
Describes the type of connection from one interface to another.
name string
Unique name of the interface in the fabric
addresses [{
Array of object: The addressed assigned to this interface.
ip_type enum DEFAULT:IPV4
ALLOWED:IPV4
Type of IP Address
ip_address string PATTERN:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}
(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)
IP Address assigned to this interface
prefix integer
this is prex of the network.
}]
}]
bgp_config {
The BGP conguration on the switch
switch_id string
Id of the switch.
name string
Name of the switch
switch_role enum ALLOWED:LEAF, SPINE, EDGE_LEAF, EDGE_CLOUD
The Role for a switch, if its a LEAF, SPINE, or an EDGE_LEAF
as_number integer
AS number on the switch
ip_address string
The loopback IP address or the physical adjacency IP address of the switch
neighbors [{
Array of object: The BGP neighbors for this switch
peer_switch_id string
Object id of the remote switch
peer_switch_name string
Name of the the remote switch
peer_switch_role enum ALLOWED:LEAF, SPINE, EDGE_LEAF, EDGE_CLOUD
The Role for a switch, if its a LEAF, SPINE, or an EDGE_LEAF
peer_as_number integer
AS (Autonomus System) of the remote switch
peer_address string
Ip Address of the remote switch
}]
}
rstp {
enabled boolean
If enabled RSTP will be congured on leaf switches
}
ufd {
131 of 340