API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a new VXLAN profile by unique name

(Deprecated) Global profile for VXLAN configuration parameters,
each scope (global, site, site-collection, device, device-collection)
can accept only one profile. This profile creates VXLAN Interface in AOS-CX.
This list is deprecated now, please use the configuration from aruba-interface-vni.yang

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Configure VXLAN profile.

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

VNI specific VXLAN config.

string
enum
Defaults to DENY

Configure Bridging mode for VXLAN.
By default, packets arriving on an L2VNI over a VXLAN tunnel are not forwarded
to another VXLAN tunnel on the same L2VNI. This behavior is known as DENY.
Set the mode to static-evpn to allow communication between static tunnels and dynamic tunnels.
Set the mode to static-all to enable bridging between static tunnels and any other static or dynamic tunnels.

Show Details
DENYDisable traffic bridging between VXLAN tunnels on same L2VNI.
STATIC_ALLEnable traffic bridging between all VXLAN tunnels on same L2VNI.
STATIC_EVPNEnable traffic bridging between static and dynamic VXLAN tunnels on same L2VNI.
Allowed:
boolean
Defaults to false

Enable VXLAN.

boolean
Defaults to false

Enable Aggregate counters for VXLAN.
It records aggregate statistics for packets being sent or received on VXLAN.

string
enum
Defaults to IPV4

Configure IPv4 or IPv6 VXLAN type.

Show Details
IPV4IPV4 VXLAN.
IPV6IPV6 VXLAN.
Allowed:
boolean
Defaults to false

Enable loop-protect on VXLAN, to identify and prevent accidental loops in a network.
Loop-protect is applicable only for IPV4 VXLAN.

loop-protect-vlans
array of int32s
length ≤ 2147483647
loop-protect-vlans
mac-notify-traps
array of strings
length ≤ 2147483647
Show Details
AGEDNotify when a MAC address aged out on VXLAN.
LEARNEDNotify when a MAC address was learned on VXLAN.
MOVEDNotify when a MAC address moved from VXLAN.
REMOVEDNotify when a MAC address was removed from VXLAN.
mac-notify-traps
string
length ≤ 9999

Configure IPv4 source address for VXLAN.
IPv4 source address is applicable only for IPv4 VXLAN.

string
length ≤ 9999

Configure IPv6 source address for VXLAN.
IPv6 source address is applicable only for IPv6 VXLAN.

int64
1 to 65535
Defaults to 4789

Configure UDP port for VxLAN tunnel.

vni
array of objects
length ≤ 2147483647

Configure VNI(s) for VXLAN.
A VNI represents a VXLAN segment and extends the broadcast
domain represented by a VLAN. AOS-CX supports asymmetric routing
by default, symmetric routing is enabled by associating the
VNI with a VRF instead of a VLAN.

vni
string
length between 1 and 64

Configure user description for VXLAN profile.

string
length between 1 and 256

Configure VXLAN profile.

Responses

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