overlay-tunnel vtep remote-ip-address¶

Configure remote tunnel end point parameters

remote-ip-address Specification¶

Parameter Value

Type Collection

Object Key(s) ip-address

Collection Name remote-ip-address-list

Collection URI /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address

Element Name remote-ip-address

Element URI /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}

Element Attributes remote-ip-address_attributes

Partition Visibility shared

Schema remote-ip-address schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address	remote-ip-address attributes
Create List	POST	/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address	remote-ip-address attributes
Get Object	GET	/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}	remote-ip-address attributes
Get List	GET	/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address	remote-ip-address-list
Modify Object	POST	/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}	remote-ip-address attributes
Replace Object	PUT	/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}	remote-ip-address attributes
Replace List	PUT	/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address	remote-ip-address-list
Delete Object	DELETE	/axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}	remote-ip-address attributes

remote-ip-address-list¶

remote-ip-address-list is JSON List of remote-ip-address attributes

remote-ip-address-list : [

{ remote-ip-address attributes },

{ remote-ip-address attributes },

…

]

remote-ip-address attributes¶

class-list

Description Name of the class-list

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/class-list

encap

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

Type: string

Supported Values: nvgre, vxlan

gre-keepalive

Description: gre-keepalive is a JSON Block. Please see below for 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 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 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}

gre-keepalive¶

Specification Value

Type object

retry-count

Description Keepalive multiplier

Type: number

Range: 2-100

retry-time

Description Keepalive retry 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

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

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

Reference Object: /axapi/v3/partition

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

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

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