overlay-tunnel

Virtual tunnel configuration, as well as system and packet behavior related to the tunnel configuration. Multiple virtual tunnels can be configured in the same partition or across different partitions.

overlay-tunnel Specification

Type Intermediate Resource
Element Name overlay-tunnel
Element URI /axapi/v3/overlay-tunnel
Element Attributes overlay-tunnel_attributes
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

Description: vtep-list is a JSON List . Please see below for vtep-list

Type: List

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

options

Specification
Type object

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

nvgre-disable-flow-id

Description: Disable Flow-ID computation for NVGRE

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nvgre-key-mode-lower24

Description: Use the lower 24-bits of the GRE key as the VSID

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

vxlan-dest-port

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

Type: number

Range: 1-65535

vtep-list

Specification
Type list
Block object keys

destination-ip-address-list

Description: destination-ip-address-list is a JSON List . Please see below for l303_destination-ip-address-list

Type: List

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

encap

Description: ‘nvgre’: Tunnel Encapsulation Type is NVGRE; ‘vxlan’: Tunnel Encapsulation Type is VXLAN;

Type: string

Supported Values: nvgre, vxlan

Default: vxlan

host-list

Description: host-list is a JSON List . Please see below for l303_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-64

source-ip-address

Description: source-ip-address is a JSON Block . Please see below for l303_source-ip-address

Type: Object

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

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

vtep-list.destination-ip-address-list

Specification
Type list
Block object keys

encap

Description: ‘nvgre’: Tunnel Encapsulation Type is NVGRE; ‘vxlan’: Tunnel Encapsulation Type is VXLAN;

Type: string

Supported Values: nvgre, vxlan

ip-address

Description: IP Address of the remote VTEP

Type: string

Format: ipv4-address

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

vni-list

Description: vni-list is a JSON List . Please see below for l303_vni-list

Type: List

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

vtep-list.destination-ip-address-list.vni-list

Specification
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

vtep-list.host-list

Specification
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

vni

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

Type: number

Range: 1-16777215

vtep-list.source-ip-address

Specification
Type object

ip-address

Description: Source Tunnel End Point IPv4 address

Type: string

Format: ipv4-address

uuid

Description: uuid of the object

Type: string

vni-list

Description: vni-list is a JSON List . Please see below for l303_vni-list

Type: List

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

vtep-list.source-ip-address.vni-list

Specification
Type list
Block object keys

gateway

Description: This is a Gateway segment id

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lif

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

Type: number

Range: 1-128

partition

Description: Name of the Partition with the L2 segment being extended (Name of the User Partition with the L2 segment being extended)

Type: string

segment

Description: Id of the segment that is being extended

Type: number

Range: 1-16777215

uuid

Description: uuid of the object

Type: string