API Guide

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.
}]
}
17.10 PUT /fabric-intents/{fabric-intent-id}/tenants/{tenant-id}/vxlan-
segments/{id}
Updates a VxLAN Segment by ID.
This API will be used to update the properties of a VxLAN segment identied by 'id'. This is only allowed if the fabric-intent
on which the segment's tenant is dened, is in DRAFT state.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*fabric-intent-id string
Unique identier of the fabric intent
*tenant-id string
Unique identier of the tenant
*id string
Unique identier of the VxLAN segment.
REQUEST BODY - application/json
{
Represents a VxLAN Segment for a 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.
237 of 340