overlay-tunnel¶

Configure a Tunnel end point

overlay-tunnel Specification¶

Parameter Value

Type Intermediate Resource

Element Name overlay-tunnel

Element URI /axapi/v3/overlay-tunnel

Element Attributes overlay-tunnel_attributes

Partition Visibility shared

Schema overlay-tunnel schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/overlay-tunnel	overlay-tunnel_attributes

overlay-tunnel attributes¶

options

Description: options is a JSON Block. Please see below for options

Type: Object

Reference Object: /axapi/v3/overlay-tunnel/options

vtep-list

Type: List

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}

options¶

Specification Value

Type object

fragmentation-mode-inner

Description Enable the inner-fragmentation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gateway-mac

Description MAC to be used with Gateway segment Id (MAC Address for the Gateway segment)

Type: string

Format: mac-address

ip-dscp-preserve

Description Copy DSCP bits from inner IP to outer IP header

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

src-port-range

Description: src-port-range is a JSON Block. Please see below for options_src-port-range

Type: Object

Reference Object: /axapi/v3/overlay-tunnel/options/src-port-range

tcp-mss-adjust-disable

Description Disable TCP MSS adjustment in SYN packet for tunnels

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vxlan-dest-port

Description VXLAN UDP Destination Port (UDP Port Number (default 4789))

Type: number

Range: 1-65535

options_src-port-range¶

Specification Value

Type object

max-port

Description Maximum Port Number

Type: number

Range: 1-65535

Default: 65535

min-port

Description Minimum Port Number

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vtep-list¶

Specification Value

Type list

Block object keys

encap

Description ‘gre’: Tunnel encapsulation type is GRE; ‘vxlan’: Tunnel Encapsulation Type is VXLAN;

Type: string

Supported Values: gre, vxlan

host-list

Type: List

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{destination-vtep}

id

Description VTEP Identifier

Type: number

Range: 1-190

local-ip-address

Description: local-ip-address is a JSON Block. Please see below for vtep-list_local-ip-address

Type: Object

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/local-ip-address

remote-ip-address-list

Type: List

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}

src-port-range

Description: src-port-range is a JSON Block. Please see below for vtep-list_src-port-range

Type: Object

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/src-port-range

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vtep-list_src-port-range¶

Specification Value

Type object

max-port

Description Maximum Port Number

Type: number

Range: 1-65535

Default: 65535

min-port

Description Minimum Port Number

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vtep-list_remote-ip-address-list¶

Specification Value

Type list

Block object keys

gre-keepalive

Description: gre-keepalive is a JSON Block. Please see below for vtep-list_remote-ip-address-list_gre-keepalive

Type: Object

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/gre-keepalive

ip-address

Description IP Address of the remote VTEP

Type: string

Format: ipv4-address

use-gre-key

Description: use-gre-key is a JSON Block. Please see below for vtep-list_remote-ip-address-list_use-gre-key

Type: Object

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/use-gre-key

use-lif

Description: use-lif is a JSON Block. Please see below for vtep-list_remote-ip-address-list_use-lif

Type: Object

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/use-lif

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vni-list

Type: List

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/vni/{segment}

vtep-list_remote-ip-address-list_gre-keepalive¶

Specification Value

Type object

retry-count

Description Keepalive multiplier

Type: number

Range: 2-100

retry-time

Description Keepalive interval in seconds

Type: number

Range: 1-60

Default: 10

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vtep-list_remote-ip-address-list_use-lif¶

Specification Value

Type object

lif

Description Logical interface binding the Provider Partition to the User Partition (logical interface name)

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vtep-list_remote-ip-address-list_vni-list¶

Specification Value

Type list

Block object keys

segment

Description VNI configured for the remote VTEP

Type: number

Range: 1-16777215

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vtep-list_remote-ip-address-list_use-gre-key¶

Specification Value

Type object

gre-key

Description key

Type: number

Range: 0-4294967295

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vtep-list_local-ip-address¶

Specification Value

Type object

ip-address

Description Source Tunnel End Point IPv4 address

Type: string

Format: ipv4-address

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vni-list

Type: List

Reference Object: /axapi/v3/overlay-tunnel/vtep/{id}/local-ip-address/vni/{segment}

vtep-list_local-ip-address_vni-list¶

Specification Value

Type list

Block object keys

lif

Description Logical interface binding the Provider Partition to the User Partition (logical interface name)

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

segment

Description Id of the segment that is being extended

Type: number

Range: 1-16777215

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vtep-list_host-list¶

Specification Value

Type list

Block object keys

destination-vtep

Description Configure the VTEP IP address (IPv4 address of the VTEP for the remote host)

Type: string

Format: ipv4-address

ip-addr

Description IPv4 address of the overlay host

Type: string

Format: ipv4-address

overlay-mac-addr

Description MAC Address of the overlay host

Type: string

Format: mac-address

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vni

Description Configure the segment id ( VNI of the remote host)

Type: number

Range: 1-16777215