API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a new UBT profile by unique name

A list of global profile(s) for UBT, each
scope (global, site, site-collection, device, device-collection)
can accept only one profile.

Path Params
string
required
length ≤ 9999

UBT profile name to be configured.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

int32
1 to 4094

This vlan is used when mode is LOCAL_VLAN.
If UBT Client VLAN is configured in VLAN_EXTEND mode, it is ignored.
VLAN-ID assigned to UBT clients for tunneling traffic from
switch to controller.

string
length between 1 and 256

User description for UBT Profile.

string
enum
Defaults to LOCAL_VLAN

UBT VLAN mode configuration

Show Details
LOCAL_VLANClients are assigned to a VLAN that is local to the switch and associated with their UBT-role based VLAN when client traffic reaches the controller. This mode allows for reducing the number of VLANs that need to be instantiated on the switch but can only support VLAN-untagged UBT clients. The 'client-vid' will be used to specify the local_vlan that UBT clients are assigned to.
VLAN_EXTENDClients are assigned to their UBT-role based VLAN in the hardware datapath. This mode allows for UBT to support VLAN-tagged clients like VOIP phones.
Allowed:
string
length between 1 and 256

UBT profile name to be configured.

zone
array of objects
length ≤ 2147483647

A list of UBT zone specific configuration.

zone
Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json