interface tunnel

Tunnel interface

tunnel Specification

   
Type Collection
Object Key(s) ifnum
Collection Name tunnel-list
Collection URI /axapi/v3/interface/tunnel
Element Name tunnel
Element URI /axapi/v3/interface/tunnel/{ifnum}
Element Attributes tunnel_attributes
Schema tunnel schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/interface/tunnel

tunnel attributes

Create List

POST

/axapi/v3/interface/tunnel

tunnel attributes

Get Object

GET

/axapi/v3/interface/tunnel/{ifnum}

tunnel attributes

Get List

GET

/axapi/v3/interface/tunnel

tunnel-list

Modify Object

POST

/axapi/v3/interface/tunnel/{ifnum}

tunnel attributes

Replace Object

PUT

/axapi/v3/interface/tunnel/{ifnum}

tunnel attributes

Replace List

PUT

/axapi/v3/interface/tunnel

tunnel-list

Delete Object

DELETE

/axapi/v3/interface/tunnel/{ifnum}

tunnel attributes

tunnel-list

tunnel-list is JSON List of tunnel attributes

tunnel-list : [

tunnel attributes

action

Description ‘enable’: Enable; ‘disable’: Disable;

Type: string

Supported Values: enable, disable

ifnum

Description Tunnel interface number

Type: number

Range: 1-128

ip

Description: ip is a JSON Block. Please see below for ip

Type: Object

Refernce Object: /axapi/v3/interface/tunnel/{ifnum}/ip

ipv6

Description: ipv6 is a JSON Block. Please see below for ipv6

Type: Object

Refernce Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6

mtu

Description Interface mtu (Interface MTU, default 1 (min MTU is 1280 for IPv6))

Type: number

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

ip

Specification  
Type object

address

Description: address is a JSON Block. Please see below for ip_address

Type: Object

generate-membership-query

Description Enable Membership Query

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

generate-membership-query-val

Description 1 - 255 (Default is 125)

Type: number

Range: 1-255

Default: 125

max-resp-time

Description Max Response Time (Default is 100)

Type: number

Range: 1-255

Default: 100

ospf

Description: ospf is a JSON Block. Please see below for ip_ospf

Type: Object

Refernce Object: /axapi/v3/interface/tunnel/{ifnum}/ip/ospf

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ip_address

Specification  
Type object

dhcp

Description Use DHCP to configure IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-cfg

Type: List

ip_address_ip-cfg

Specification  
Type list
Block object keys  

ipv4-address

Description IP address

Type: string

Format: ipv4-address

ipv4-netmask

Description IP subnet mask

Type: string

Format: ipv4-netmask

ip_ospf

Specification  
Type object

ospf-global

Description: ospf-global is a JSON Block. Please see below for ip_ospf_ospf-global

Type: Object

Refernce Object: /axapi/v3/interface/tunnel/{ifnum}/ip/ospf/ospf-global

ospf-ip-list

ip_ospf_ospf-ip-list

Specification  
Type list
Block object keys  

authentication

Description Enable authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

authentication-key

Description Authentication password (key) (The OSPF password (key))

Type: string

Format: string-rlx

Maximum Length: 8 characters

Maximum Length: 1 characters

cost

Description Interface cost

Type: number

Range: 1-65535

database-filter

Description ‘all’: Filter all LSA;

Type: string

Supported Values: all

dead-interval

Description Interval after which a neighbor is declared dead (Seconds)

Type: number

Range: 1-65535

Default: 40

hello-interval

Description Time between HELLO packets (Seconds)

Type: number

Range: 1-65535

Default: 10

ip-addr

Description Address of interface

Type: string

Format: ipv4-address

message-digest-cfg

Type: List

mtu-ignore

Description Ignores the MTU in DBD packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

out

Description Outgoing LSA

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

priority

Description Router priority

Type: number

Range: 0-255

Default: 1

retransmit-interval

Description Time between retransmitting lost link state advertisements (Seconds)

Type: number

Range: 1-65535

Default: 5

transmit-delay

Description Link state transmit delay (Seconds)

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description ‘message-digest’: Use message-digest authentication; ‘null’: Use no authentication;

Type: string

Supported Values: message-digest, null

ip_ospf_ospf-ip-list_message-digest-cfg

Specification  
Type list
Block object keys  

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

md5-value

Description The OSPF password (1-16)

Type: string

Format: password

Maximum Length: 16 characters

Maximum Length: 1 characters

message-digest-key

Description Message digest authentication password (key) (Key id)

Type: number

Range: 1-255

ip_ospf_ospf-global

Specification  
Type object

authentication-cfg

Description: authentication-cfg is a JSON Block. Please see below for ip_ospf_ospf-global_authentication-cfg

Type: Object

authentication-key

Description Authentication password (key) (The OSPF password (key))

Type: string

Format: string-rlx

Maximum Length: 8 characters

Maximum Length: 1 characters

bfd-cfg

Description: bfd-cfg is a JSON Block. Please see below for ip_ospf_ospf-global_bfd-cfg

Type: Object

cost

Description Interface cost

Type: number

Range: 1-65535

database-filter-cfg

Description: database-filter-cfg is a JSON Block. Please see below for ip_ospf_ospf-global_database-filter-cfg

Type: Object

dead-interval

Description Interval after which a neighbor is declared dead (Seconds)

Type: number

Range: 1-65535

Default: 40

disable

Description ‘all’: All functionality;

Type: string

Supported Values: all

hello-interval

Description Time between HELLO packets (Seconds)

Type: number

Range: 1-65535

Default: 10

message-digest-cfg

Type: List

mtu

Description OSPF interface MTU (MTU size)

Type: number

Range: 576-65535

mtu-ignore

Description Ignores the MTU in DBD packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

network

Description: network is a JSON Block. Please see below for ip_ospf_ospf-global_network

Type: Object

priority

Description Router priority

Type: number

Range: 0-255

Default: 1

retransmit-interval

Description Time between retransmitting lost link state advertisements (Seconds)

Type: number

Range: 1-65535

Default: 5

transmit-delay

Description Link state transmit delay (Seconds)

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ip_ospf_ospf-global_network

Specification  
Type object

broadcast

Description Specify OSPF broadcast multi-access network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: broadcastnon-broadcast, point-to-point and point-to-multipoint are mutually exclusive

non-broadcast

Description Specify OSPF NBMA network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: non-broadcastbroadcast, point-to-point and point-to-multipoint are mutually exclusive

p2mp-nbma

Description Specify non-broadcast point-to-multipoint network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

point-to-multipoint

Description Specify OSPF point-to-multipoint network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: point-to-multipointbroadcast, non-broadcast and point-to-point are mutually exclusive

point-to-point

Description Specify OSPF point-to-point network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: point-to-pointbroadcast, non-broadcast and point-to-multipoint are mutually exclusive

ip_ospf_ospf-global_authentication-cfg

Specification  
Type object

authentication

Description Enable authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

value

Description ‘message-digest’: Use message-digest authentication; ‘null’: Use no authentication;

Type: string

Supported Values: message-digest, null

ip_ospf_ospf-global_database-filter-cfg

Specification  
Type object

database-filter

Description ‘all’: Filter all LSA;

Type: string

Supported Values: all

out

Description Outgoing LSA

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip_ospf_ospf-global_bfd-cfg

Specification  
Type object

bfd

Description Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description Disable BFD

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip_ospf_ospf-global_message-digest-cfg

Specification  
Type list
Block object keys  

md5

Description: md5 is a JSON Block. Please see below for ip_ospf_ospf-global_message-digest-cfg_md5

Type: Object

message-digest-key

Description Message digest authentication password (key) (Key id)

Type: number

Range: 1-255

ip_ospf_ospf-global_message-digest-cfg_md5

Specification  
Type object

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

md5-value

Description The OSPF password (1-16)

Type: string

Format: password

Maximum Length: 16 characters

Maximum Length: 1 characters

ipv6

Specification  
Type object

address-cfg

Type: List

ipv6-enable

Description Enable IPv6 processing

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

ipv6_address-cfg

Specification  
Type list
Block object keys  

anycast

Description Configure an IPv6 anycast address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6-addr

Description Set the IPv6 address of an interface

Type: string

Format: ipv6-address-plen

link-local

Description Configure an IPv6 link local address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0