overlay-tunnel

Configure a Tunnel end point

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:

OperationMethodURIPayload

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

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

vtep-list

Type: List

Refernce 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

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

vtep-list

Specification  
Type list
Block object keys  

destination-ip-address-list

encap

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

Type: string

Supported Values: nvgre, vxlan

Default: vxlan

host-list

id

Description VTEP Identifier

Type: number

Range: 1-64

source-ip-address

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

Type: Object

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

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_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

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

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

Maximum Length: 64 characters

Maximum Length: 1 characters

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

Maximum Length: 64 characters

Maximum Length: 1 characters

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

Maximum Length: 64 characters

Maximum Length: 1 characters

vni-list

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

Maximum Length: 127 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