overlay-tunnel vtep

Virtual Tunnel end point Configuration

vtep Specification

Type Collection
Object Key(s) id
Collection Name vtep-list
Collection URI /axapi/v3/overlay-tunnel/vtep/
Element Name vtep
Element URI /axapi/v3/overlay-tunnel/vtep/{id}
Element Attributes vtep_attributes
Schema vtep schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/overlay-tunnel/vtep/

vtep Attributes

Create List

POST

/axapi/v3/overlay-tunnel/vtep/

vtep Attributes

Get Object

GET

/axapi/v3/overlay-tunnel/vtep/{id}

vtep Attributes

Get List

GET

/axapi/v3/overlay-tunnel/vtep/

vtep-list

Modify Object

POST

/axapi/v3/overlay-tunnel/vtep/{id}

vtep Attributes

Replace Object

PUT

/axapi/v3/overlay-tunnel/vtep/{id}

vtep Attributes

Replace List

PUT

/axapi/v3/overlay-tunnel/vtep/

vtep-list

Delete Object

DELETE

/axapi/v3/overlay-tunnel/vtep/{id}

vtep Attributes

vtep-list

vtep-list is JSON List of vtep Attributes

vtep-list : [

vtep Attributes

destination-ip-address-list

Description: destination-ip-address-list is a JSON List . Please see below for 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 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

Required: Yes

source-ip-address

Description: source-ip-address is a JSON Block . Please see below for 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

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 l302_vni-list

Type: List

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

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

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

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 l302_vni-list

Type: List

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

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