API Guide

}]
}
31.3 GET /wiring-diagrams/{id}/topology
Get topology for a wiring diagram
Retruns the physical topology created from this wiring Diagram
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
Unique identier of the wiring diagram
RESPONSE
STATUS CODE - 200: Response to the fabric topology request
RESPONSE MODEL - application/json
{
This object describes the physical topology of the fabric
id string
Unique identier of the topology
name string
name of the topology
fabric_type enum ALLOWED:L2_VLT, L3_BGP,
BGP_EVPN
The type of fabric based on the Wiring design
switches [{
Array of object: this object describes the switch object in the fabric
id string
This is unique identier of the switch in the fabric
name string
unique name of the switch in the fabric
model string
model number of the switch
serial_number string
serial number of the switch
switch_service_tag string
service tag of the switch
position integer
The position of the switch in the leaf or spine tier
role enum ALLOWED:LEAF, SPINE, EDGE_LEAF,
EDGE_CLOUD
This tells if the switch is Leaf or Spine
peer_switch_id string
Id of other switch which is in VLT or MLAG with
this switch
mgmt_ip_address string
management IP address of the switch
states {
"Describes the state of switch in the topology. If the switch is discovered, reachable etc"
switch_state enum ALLOWED:DEFINED, MAINTENANCE, REACHABLE, PROVISIONED, ACTIVE,
ERROR, UNMANAGED, REBOOT_IN_PROGRESS
The current state of the switch. The switch is Manintenance state if any LCM job is being performed
on this job. The Switch will be in unmanaged state if the this switch is not supported by SFD based on
SFD manifest le. The switch can be in ERROR state becuase of various reasons. Like not reachable,
auth failure, cong errors etc.
error_detail enum ALLOWED:NONE, CREDENTIAL_FAIL, UNREACHABLE, CONFIG_ERROR,
NOT_OPERATIONAL
If the switch state is in error then this enum tells the reason for that error.
}
interfaces [{
Array of object: "this object denes the interface object in fabric topology"
id string
Unique identier of the interface in the switch
name string
Unique name of the interface in the fabric
334 of 340