API Guide

RESPONSE
STATUS CODE - 200: Response to get a list of VxLAN Segments.
RESPONSE MODEL - application/json
{
List of VxLAN segments.
data [{
Array of object: Represents a VxLAN Segment for a tenant
id string
Unique identier of the VxLAN segment
tenant-id string
Unique identier of the tenant whom this segment belongs to.
tenant_name string
Name of the tenant whom this segment belongs to.
fabric-intent-id string
Unique identier of the fabric intent that denes the fabric
conguration used by the tenant.
vni* integer between 1 and 16777215
the Virtual Network Identier for the tenant.
static_anycast_gateway_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]?)(\/([0-9]|
[1-2][0-9]|3[0-2]))
The static anycast gateway ip for a stretched host network. This
will be congured on all leafs where this network stretches.
vlan_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.
switch_pairs* [{
Array of object: The switch pair that will be part of a VxLAN Segment stretch. switch_id_1 and switch_id_2 will be leaf switch ids which are
in pair. The user will input one SVI IP for each leaf in the pair. The static anycast gateway IP will be common for every leaf-pair part of the
VxLAN Segment, and hence it will not be a switch-pair property. It will be dened as a VxLAN Segment property.
switch_id_1 string
Unique identier of switch-1 in the leaf pair.
switch_1_name string
Name of switch-1 in the leaf pair.
switch_id_2 string
Unique identier of switch-2 in the leaf pair.
switch_2_name string
Name of switch-2 in the leaf pair.
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-1 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 leaf switch-2 in CIDR notation
vtep_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]))
VTEP interface IP on leaf-rack in CIDR notation
vlan_id* integer between 2 and 4094
228 of 340