API Guide

6. CONFIG
Switch conguration based on fabric intent.
6.1 GET /fabric-intents/{fabric-intent-id}/configurations/vlans
Retrieve host network generated conguration for this Fabric-Intent
This api returns the generated conguration for host networks. This comprises VLANs , port channel and member
interfaces. The port channel information will be returned for the deployed fabric intents. This also return the lag id for leaf-
pairs for the port channel.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*fabric-intent-id string
Unique identier of the fabric intent
RESPONSE
STATUS CODE - 200: Success response to retrieve the VLAN conguration for fabric intent
RESPONSE MODEL - application/json
{
data [{
Array of object: This object represents the host side generated conguration for the fabric intent on the switches. Till fabric intent is not
deployed it will return the intent conguration.
vlan_id integer
VLAN congured on the fabric intent.
tenant {
Represents a tenant using the fabric.
tenant_id string
Unique identier of the tenant.
name* string
Name of the tenant
description string
Optional description for the tenant.
}
description string
Description provided on the fabric intent for this 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_vlan_config [{
Array of object: VLAN conguration on the switches. This covers the VRRP, Vlan interfaces and port channels.
vrrp {
ip_address string
The virtual ip address for the VLAN interface.
}
virtual_intfs [{
Array of object: VLAN virtual interface
switch_id string
The unique identier of the switch. In L3 fabric case this will be leaf switch and in L2 fabric
case this will be Spine switch.
switch_name string
Name of the switch identied by switch_id
82 of 340