interface tunnel¶

Tunnel interface

tunnel Specification¶

Parameter Value

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

Partition Visibility shared

Statistics Data URI /axapi/v3/interface/tunnel/{ifnum}/stats

Operational Data URI /axapi/v3/interface/tunnel/{ifnum}/oper

Schema tunnel schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/interface/tunnel	tunnel attributes
POST /axapi/v3/interface/tunnel/ Payload: { "tunnel": { "ifnum": 1, "user-tag": "a", "mtu": 1000 } }
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 },

{ tunnel attributes },

…

]

tunnel attributes¶

action

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

Type: string

Supported Values: enable, disable

Default: enable

ifnum

Description Tunnel interface number

Type: number

Range: 1-128

ip

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

Type: Object

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

ipv6

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

Type: Object

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

load-interval

Description Configure Load Interval (Seconds (5-300, Multiple of 5), default 300)

Type: number

Range: 5-300

Default: 300

lw-4o6

Description: lw-4o6 is a JSON Block. Please see below for lw-4o6

Type: Object

Reference Object: /axapi/v3/interface/tunnel/{ifnum}/lw-4o6

map

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

Type: Object

Reference Object: /axapi/v3/interface/tunnel/{ifnum}/map

mtu

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

Type: number

name

Description Name for the interface

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

packet-capture-template

Description Name of the packet capture template to be bind with this object

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/interface-tunnel-tmpl

sampling-enable

Type: List

security-level

Description Configure security level for interface. 100 - Most Secure

Type: number

Range: 0-100

speed

Description Speed in Gbit/Sec (Default 10 Gbps)

Type: number

Range: 1-200

Default: 10

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

map¶

Specification Value

Type object

inside

Description Configure MAP inside interface (connected to MAP domains)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

map-t-inside

Description Configure MAP inside interface (connected to MAP domains)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

map-t-outside

Description Configure MAP outside interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description Configure MAP outside interface

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

ip¶

Specification Value

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

inside

Description Configure interface as inside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

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

outside

Description Configure interface as outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rip

Description: rip is a JSON Block. Please see below for ip_rip

Type: Object

Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ip/rip

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ip_rip¶

Specification Value

Type object

authentication

Description: authentication is a JSON Block. Please see below for ip_rip_authentication

Type: Object

receive-cfg

Description: receive-cfg is a JSON Block. Please see below for ip_rip_receive-cfg

Type: Object

receive-packet

Description Enable receiving packet through the specified interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

send-cfg

Description: send-cfg is a JSON Block. Please see below for ip_rip_send-cfg

Type: Object

send-packet

Description Enable sending packets through the specified interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

split-horizon-cfg

Description: split-horizon-cfg is a JSON Block. Please see below for ip_rip_split-horizon-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ip_rip_receive-cfg¶

Specification Value

Type object

receive

Description Advertisement reception

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

version

Description ‘2’: RIP version 2;

Type: string

Supported Values: 2

ip_rip_split-horizon-cfg¶

Specification Value

Type object

state

Description ‘poisoned’: Perform split horizon with poisoned reverse; ‘disable’: Disable split horizon; ‘enable’: Perform split horizon without poisoned reverse;

Type: string

Supported Values: poisoned, disable, enable

Default: poisoned

ip_rip_authentication¶

Specification Value

Type object

key-chain

Description: key-chain is a JSON Block. Please see below for ip_rip_authentication_key-chain

Type: Object

mode

Description: mode is a JSON Block. Please see below for ip_rip_authentication_mode

Type: Object

str

Description: str is a JSON Block. Please see below for ip_rip_authentication_str

Type: Object

ip_rip_authentication_key-chain¶

Specification Value

Type object

key-chain

Description Authentication key-chain (Name of key-chain)

Type: string

Format: string-rlx

ip_rip_authentication_mode¶

Specification Value

Type object

mode

Description ‘md5’: Keyed message digest; ‘text’: Clear text authentication;

Type: string

Supported Values: md5, text

Default: text

ip_rip_authentication_str¶

Specification Value

Type object

string

Description The RIP authentication string

Type: string

Format: string-rlx

Maximum Length: 16 characters

Maximum Length: 1 characters

ip_rip_send-cfg¶

Specification Value

Type object

send

Description Advertisement transmission

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

version

Description ‘2’: RIP version 2;

Type: string

Supported Values: 2

ip_address¶

Specification Value

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 Value

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 Value

Type object

ospf-global

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

Type: Object

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

ospf-ip-list

Type: List

Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ip/ospf/ospf-ip/{ip-addr}

ip_ospf_ospf-ip-list¶

Specification Value

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 Value

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 Value

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 Value

Type object

broadcast

Description Specify OSPF broadcast multi-access network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: broadcast,non-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-broadcast,broadcast, 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-multipoint,broadcast, 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-point,broadcast, non-broadcast, and point-to-multipoint are mutually exclusive

ip_ospf_ospf-global_authentication-cfg¶

Specification Value

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 Value

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 Value

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 Value

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 Value

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

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘num-rx-pkts’: received packets; ‘num-total-rx-bytes’: received bytes; ‘num-tx-pkts’: sent packets; ‘num-total-tx-bytes’: sent bytes; ‘num-rx-err-pkts’: received error packets; ‘num-tx-err-pkts’: sent error packets; ‘rate_pkt_sent’: Packet sent rate packets/sec; ‘rate_byte_sent’: Byte sent rate bits/sec; ‘rate_pkt_rcvd’: Packet received rate packets/sec; ‘rate_byte_rcvd’: Byte received rate bits/sec;

Type: string

Supported Values: all, num-rx-pkts, num-total-rx-bytes, num-tx-pkts, num-total-tx-bytes, num-rx-err-pkts, num-tx-err-pkts, rate_pkt_sent, rate_byte_sent, rate_pkt_rcvd, rate_byte_rcvd

lw-4o6¶

Specification Value

Type object

inside

Description Configure LW-4over6 outside interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description Configure LW-4over6 inside interface

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¶

Specification Value

Type object

address-cfg

Type: List

inside

Description Configure interface as inside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6-enable

Description Enable IPv6 processing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf

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

Type: Object

Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6/ospf

outside

Description Configure interface as outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

router

Description: router is a JSON Block. Please see below for ipv6_router

Type: Object

Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6/router

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ipv6_address-cfg¶

Specification Value

Type list

Block object keys

address-type

Description ‘anycast’: Configure an IPv6 anycast address; ‘link-local’: Configure an IPv6 link local address;

Type: string

Supported Values: anycast, link-local

ipv6-addr

Description Set the IPv6 address of an interface

Type: string

Format: ipv6-address-plen

ipv6_router¶

Specification Value

Type object

ospf

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

Type: Object

Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6/router/ospf

ripng

Description: ripng is a JSON Block. Please see below for ipv6_router_ripng

Type: Object

Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6/router/ripng

ipv6_router_ripng¶

Specification Value

Type object

rip

Description RIP Routing for IPv6

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_router_ospf¶

Specification Value

Type object

area-list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ipv6_router_ospf_area-list¶

Specification Value

Type list

Block object keys

area-id-addr

Description OSPF area ID in IP address format

Type: string

Format: ipv4-address

area-id-num

Description OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

instance-id

Description Set the interface instance ID

Type: number

Range: 0-255

Default: 0

tag

Description Set the OSPFv3 process tag

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

ipv6_ospf¶

Specification Value

Type object

bfd

Description Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cost-cfg

Type: List

dead-interval-cfg

Type: List

disable

Description Disable BFD

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hello-interval-cfg

Type: List

mtu-ignore-cfg

Type: List

neighbor-cfg

Type: List

network-list

Type: List

priority-cfg

Type: List

retransmit-interval-cfg

Type: List

transmit-delay-cfg

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ipv6_ospf_cost-cfg¶

Specification Value

Type list

Block object keys

cost

Description Interface cost

Type: number

Range: 1-65535

instance-id

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

ipv6_ospf_hello-interval-cfg¶

Specification Value

Type list

Block object keys

hello-interval

Description Time between HELLO packets (Seconds)

Type: number

Range: 1-65535

Default: 10

instance-id

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

ipv6_ospf_priority-cfg¶

Specification Value

Type list

Block object keys

instance-id

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

priority

Description Router priority

Type: number

Range: 0-255

Default: 1

ipv6_ospf_mtu-ignore-cfg¶

Specification Value

Type list

Block object keys

instance-id

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

mtu-ignore

Description Ignores the MTU in DBD packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6_ospf_retransmit-interval-cfg¶

Specification Value

Type list

Block object keys

instance-id

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

retransmit-interval

Description Time between retransmitting lost link state advertisements (Seconds)

Type: number

Range: 1-65535

Default: 5

ipv6_ospf_network-list¶

Specification Value

Type list

Block object keys

broadcast-type

Description ‘broadcast’: Specify OSPF broadcast multi-access network; ‘non-broadcast’: Specify OSPF NBMA network; ‘point-to-point’: Specify OSPF point-to-point network; ‘point-to-multipoint’: Specify OSPF point-to-multipoint network;

Type: string

Supported Values: broadcast, non-broadcast, point-to-point, point-to-multipoint

network-instance-id

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

p2mp-nbma

Description Specify non-broadcast point-to-multipoint network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6_ospf_transmit-delay-cfg¶

Specification Value

Type list

Block object keys

instance-id

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

transmit-delay

Description Link state transmit delay (Seconds)

Type: number

Range: 1-65535

Default: 1

ipv6_ospf_neighbor-cfg¶

Specification Value

Type list

Block object keys

neig-inst

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

neighbor

Description OSPFv3 neighbor (Neighbor IPv6 address)

Type: string

Format: ipv6-address

Default: ::

neighbor-cost

Description OSPF cost for point-to-multipoint neighbor (metric)

Type: number

Range: 1-65535

neighbor-poll-interval

Description OSPF dead-router polling interval (Seconds)

Type: number

Range: 0-4294967295

neighbor-priority

Description OSPF priority of non-broadcast neighbor

Type: number

Range: 0-255

ipv6_ospf_dead-interval-cfg¶

Specification Value

Type list

Block object keys

dead-interval

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

Type: number

Range: 1-65535

Default: 40

instance-id

Description Specify the interface instance ID

Type: number

Range: 0-255

Default: 0