API Guide

11. HOST-NETWORK
Host Network object with in a fabric intent
11.1 GET /fabric-intents/{fabric-intent-id}/host-networks
Retrieve all Host Network objects within a fabric intent. Optionally, it can be ltered for a single tenant in a multi-tenant
fabric.
This API returns all host network objects within a fabric intent identied by 'fabric-intent-Id'. Optionally, the host networks
can be ltered based on a specic tenant in a multi-tenant fabric.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*fabric-intent-id string
Unique identier of the fabric intent
QUERY PARAMETERS
NAME TYPE DESCRIPTION
tenant-id string
Tenant whose host networks need to be fetched.
RESPONSE
STATUS CODE - 200: Response to get all host networks
RESPONSE MODEL - application/json
{
This object is returned in the GET api of host network object
data [{
Array of object: Name and description ref object
id string
Unique identier of the nfc host network object.
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.
}
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
145 of 340