API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Create a new Tunnel interface by unique id

post
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/tunnel/

Tunnel Interface(s) configuration.
On AOS-CX, VXLAN operates with IPv4 or IPv6 version and GRE, IPsec operate with IPv4 version.

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

Configure Tunnel interface id.

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

interfacebody object

string
length between 1 and 255

Configure user description for the Tunnel interface.

length ≤ 9999

Configure destination address for the Tunnel interface.
Destination address can be IPv4 or IPv6 based on ip-version of the Tunnel interface.

boolean
Defaults to false

Enable or disable Tunnel interface.

string
enum
required

Configure IPv4 or IPv6 Tunnel type.
By default, V6_IN_V4 operates with IPv4 version, while V6_IN_V6 with IPv6 which is implict.

Show Details
IPV4The IPv4 protocol as defined in RFC 791.
IPV6The IPv6 protocol as defined in RFC 2460.
UNKNOWNAn unknown or unspecified version of the Internet protocol.
Allowed:
string
length ≤ 9999

Configure IPv4 prefix for the Tunnel interface.
IPv4 Prefix is applicable only for GRE IPv4 Tunnel.

string
length ≤ 9999

IPv6 address of Tunnel Interface.

ipv6-prefix
array of strings
length ≤ 2147483647
ipv6-prefix
string
enum

Enable transmit and receive counters for the Tunnel interface.
l3-counters is applicable for GRE, V6_IN_V4 and V6_IN_V6 Tunnel.

Show Details
RXRx L3 counters.
RX_TXRx and Tx L3 counters.
TXTx L3 counters.
Allowed:
string
enum
required

Configure Tunnel interface mode.

Show Details
GREGRE (Generic Routing Encapsulation) tunnel mode for the interface. GRE tunnels can encapsulate traffic and creates point to point links over an IP network
IPSECIPsec (IP security) tunnel mode for the interface. IPsec tunnel encrypts the entire original IP packet and encapsulates with an additional IP header.
UNSPECIFIEDThe tunnel to be an unspecified tunnel.
V6_IN_V4IPv6 in IPv4 tunnel mode for the interface. IP6in4 tunnel encapsulates IPV6 traffic over an IPV4 network.
V6_IN_V6IPv6 in IPv6 tunnel mode for the interface. IP6in6 tunnel encapsulates IPV6 traffic over an IPV6 network.
VXLANStatic VXLAN(Virtual Extensible LAN) tunnel mode for the interface. Statically configure source and destination virtual tunnel endpoints (VTEPs) DEPRECATED: This enum value is deprecated and will be removed in a future release.
Allowed:
int64
1024 to 9216
Defaults to 1500

Configure MTU (maximum transmission unit) for the Tunnel interface.
MTU is the largest IP packet that can be sent or received by the Tunnel interface.

secondary-ipv4-prefix
array of strings
length ≤ 2147483647
secondary-ipv4-prefix
enum

Configure source address for the Tunnel interface.
Source address can be IPv4 or IPv6 based on ip-version of the Tunnel interface.

In addition to IPv4 or IPv6 address, Gateway supports following inputs as well:
"SWITCH_IP" - Use Controller IPv4 or IPv6 address as tunnel source.
"LOOPBACK_IP" - Use loopback interface's IPv4 or IPv6 address as tunnel source.
- Use IPv4 or IPv6 address of a VLAN interface as tunnel source.

ttl
object

Time-to-Live (TTL) for the tunnel.

string
length ≤ 9999

Configure VRF for the Tunnel Interface.
VRF is not applicable for Static VXLAN Tunnel.

gre
object

Grouping for GRE Tunnel specific configuration.

int64
0 to 4294967295

Configure Tunnel interface id.

Responses

Updated 11 days ago

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

Updated 11 days ago