API Guide

REQUEST BODY - application/json
{
Name and description ref object
tenant_id string
Unique identier of the tenant. This is required in a multi-tenant fabric.
vlan_id* integer between 1 and 4096
Id of the Vlan on host network
type* enum ALLOWED:MANAGEMENT_VLAN, VMOTION_VLAN, STORAGE_VLAN,
TRANSPORT_VLAN, WORKLOAD_VLAN, OTHER
Type of the Vlan 1. MANAGEMENT_VLAN - Management Vlan allows to communicate remotely with a switch.
Management Vlan must be provided for all the switches in SFD. This is mandatory param for NSX and
currently optional for Vcenter. 2. VMOTION_VLAN - VMOTION is used to migrate live VM trac from one
physical server to another. It transfers unencrypted memory content of your live VMs over the network, so an
isolated VLAN/subnet for vMotion is created for all the switches. Its mandatory to provide Vmotion vlan for all
switches for NSX usecase. 3. STORAGE_VLAN - VSAN (Storage) provides distributed storage. VSAN (Storage)
Vlan isolates the storage trac. Its mandatory to provide storage Vlan for all switches for NSX usecase. 4.
TRANSPORT_VLAN - Transport(TEP) Vlan is for sending the VM trac from one node to another node. Its
mandatory to provide Transport Vlan for all switches for NSX usecase. 5. WORKLOAD_VLAN - Workload Vlan
is for sending VM trac for the Vcenter usecase. 6. OTHER - This is optional Vlan added by the user for
Miscellaneous congurations.
data* [{
Array of object: Switch pair Host Network Cong. For L3 fabric without overlay, if the same VLAN is in another rack, it will have a different IP
subnet and they are 2 different bcast domains. So, user needs to provide switch ids and SVI, VRRP VIP per leaf pair if the VLAN is going to span
multiple leaf switches. But for L2 fabric switch ids are not needed a SVI is congured on Spine switches and there are going to be only two spines.
For l3 fabric switch_id_1 and switch_id_2 will be leaf switch ids which are in pair.For l2 fabric these will be spine switches but these are optional
because only 2 spine switches will be there.
switch_id_1 string
Unique identier of the switch 1
switch_id_2 string
Unique identier of the switch 2
svi_ip_1* 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]?)(\/([0-9]|[1-2]
[0-9]|3[0-2]))
SVI interface IP for leaf switch in CIDR notation
svi_ip_2* 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]?)(\/([0-9]|[1-2]
[0-9]|3[0-2]))
SVI interface IP for peer leaf/spine switch in CIDR notation
vrrp_virtual_ip* 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]?)(\/([0-9]|[1-2]
[0-9]|3[0-2]))
Host Network Gateway IP in CIDR notation.
}]
name string PATTERN:^(?!\s*$).+
Name of the object
description string
description of the object
}
RESPONSE
STATUS CODE - 200: 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.
152 of 340