overlay-tunnel vtep¶
Virtual Tunnel end point Configuration
vtep Specification¶
Type
Collection
Object Key(s)
id
Collection Name
Collection URI
/axapi/v3/overlay-tunnel/vtep
Element Name
vtep
Element URI
/axapi/v3/overlay-tunnel/vtep/{id}
Element Attributes
vtep_attributes
Statistics Data URI
/axapi/v3/overlay-tunnel/vtep/{id}/stats
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/overlay-tunnel/vtep | ||
Create List | POST | /axapi/v3/overlay-tunnel/vtep | ||
Get Object | GET | /axapi/v3/overlay-tunnel/vtep/{id} | ||
Get List | GET | /axapi/v3/overlay-tunnel/vtep | ||
Modify Object | POST | /axapi/v3/overlay-tunnel/vtep/{id} | ||
Replace Object | PUT | /axapi/v3/overlay-tunnel/vtep/{id} | ||
Replace List | PUT | /axapi/v3/overlay-tunnel/vtep | ||
Delete Object | DELETE | /axapi/v3/overlay-tunnel/vtep/{id} |
vtep-list¶
vtep-list is JSON List of vtep attributes
vtep-list : [
]
vtep attributes¶
dest-port
Description Layer-4 Destination Port (Port Number)
Type: number
Range: 1-65535
encap
Description ‘ip-encap’: Tunnel encapsulation type is IP; ‘gre’: Tunnel encapsulation type is GRE; ‘nvgre’: Tunnel Encapsulation Type is NVGRE; ‘vxlan’: Tunnel Encapsulation Type is VXLAN;
Type: string
Supported Values: ip-encap, gre, nvgre, vxlan
host-list
Type: List
Refernce Object: /axapi/v3/overlay-tunnel/vtep/{id}/host/{ip-addr}+{overlay-mac-addr}+{vni}+{remote-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 local-ip-address
Type: Object
Refernce Object: /axapi/v3/overlay-tunnel/vtep/{id}/local-ip-address
local-ipv6-address
Description: local-ipv6-address is a JSON Block. Please see below for local-ipv6-address
Type: Object
Refernce Object: /axapi/v3/overlay-tunnel/vtep/{id}/local-ipv6-address
remote-ip-address-list
Type: List
Refernce Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}
remote-ipv6-address-list
Type: List
Refernce Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ipv6-address/{ipv6-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
remote-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
gre-keepalive
Description: gre-keepalive is a JSON Block. Please see below for remote-ip-address-list_gre-keepalive
Type: Object
Refernce 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 remote-ip-address-list_use-gre-key
Type: Object
Refernce 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 remote-ip-address-list_use-lif
Type: Object
Refernce 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
Refernce Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ip-address/{ip-address}/vni/{segment}
remote-ip-address-list_gre-keepalive¶
Specification
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
remote-ip-address-list_use-lif¶
Specification
Type
object
lif
Description Logical interface (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
Refernce Object: /axapi/v3/partition
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
remote-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
remote-ip-address-list_use-gre-key¶
Specification
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
local-ipv6-address¶
Specification
Type
object
ipv6-address
Description Source Tunnel End Point IPv6 address
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
remote-ipv6-address-list¶
Specification
Type
list
Block object keys
ipv6-address
Description IPv6 Address of the remote VTEP
Type: string
Format: ipv6-address
use-lif
Description: use-lif is a JSON Block. Please see below for remote-ipv6-address-list_use-lif
Type: Object
Refernce Object: /axapi/v3/overlay-tunnel/vtep/{id}/remote-ipv6-address/{ipv6-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
remote-ipv6-address-list_use-lif¶
Specification
Type
object
lif
Description Logical interface (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
Refernce Object: /axapi/v3/partition
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-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
Type: List
Refernce Object: /axapi/v3/overlay-tunnel/vtep/{id}/local-ip-address/vni/{segment}
local-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 (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
Refernce Object: /axapi/v3/partition
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
host-list¶
Specification
Type
list
Block object keys
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
remote-vtep
Description Configure the VTEP IP address (IPv4 address of the VTEP for the remote host)
Type: string
Format: ipv4-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
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
mcast_pkt_tx |
4 |
Multicast packets out |
|
total_bytes_rx |
4 |
Total packet bytes in |
|
dropped_pkt_rx |
4 |
Dropped received packets |
|
pkts_out |
4 |
Packets out |
|
unhandled_pkt_rx |
4 |
Unhandled packets in |
|
unknown_encap_tx_pkt |
4 |
Encap miss tx pkts |
|
reassembled_pkts_rx |
4 |
Reassembled packets in |
|
frag_drop_pkts_tx |
4 |
Frag dropped packets out |
|
frag_pkts_tx |
4 |
Frag packets out |
|
dropped_pkts_tx |
4 |
Dropped packets out |
|
total_bytes_tx |
4 |
Packet bytes out |
|
large_pkts_rx |
4 |
Too large packets in |
|
invalid_lif_tx |
4 |
Invalid Lif pkts out |
|
encap_miss_pkts_rx |
4 |
Encap missed in received packets |
|
unicast_pkt_rx |
4 |
Total unicast packets in |
|
dot1q_pkts_rx |
4 |
Dot1q packets in |
|
vtep_host_learned |
4 |
Hosts learned |
|
unhandled_pkt_tx |
4 |
Unhandled packets out |
|
unknown_vtep_rx |
4 |
Vtep Unkown rx |
|
invalid_lif_rx |
4 |
Invalid Lif pkts in |
|
unknown_encap_rx_pkt |
4 |
Encap miss rx pkts |
|
bad_chksum_pks_rx |
4 |
Bad checksum in received packets |
|
encap_unresolved_count |
4 |
Encap unresolved failures |
|
bad_inner_ipv6_len_rx |
4 |
Bad inner ipv6 packet len |
|
cfg_err_count |
4 |
Config errors |
|
unknown_vtep_tx |
4 |
Vtep unknown tx |
|
flooded_pkt_count |
4 |
Flooded packet count |
|
total_pkts_rx |
4 |
Total packets out |
|
vtep_host_learn_error |
4 |
Host learn error |
|
requeue_pkts_in |
4 |
Requeued packets in |
|
lif_un_init_rx |
4 |
Lif uninitialized packets in |
|
mcast_pkt_rx |
4 |
Total multicast packets in |
|
bcast_pkt_tx |
4 |
Broadcast packets out |
|
bcast_pkt_rx |
4 |
Total broadcast packets in |
|
unicast_pkt_tx |
4 |
Unicast packets out |
|
bad_inner_ipv4_len_rx |
4 |
bad inner ipv4 packet len |
|
arp_req_sent |
4 |
Arp request sent |