interface tunnel

Configure a 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:

Operation Method URI Payload

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: Specify the tunnel interface number.

Type: number

Range: 1-128

Required: Yes

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

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

uuid

Description: uuid of the object

Type: string

ip

Specification
Type object

address

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

Type: Object

generate-membership-query

Description: Enables configuring a timer for IGMPv2 request queries.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

generate-membership-query-val

Description: Sets the time interval after which the ACOS device (using this interface) will initiate an IGMP membership query request.

Type: number

Range: 1-255

Default: 125

max-resp-time

Description: Sets the time interval (in 1/10 of a second) before which receiving devices will send an ICMP query message response to indi­cate intention to join the IGMP group or not. The default response timer is 100. This means that receiving devices have 10 seconds in which to indicate if they will join the IGMP membership group or not.

Type: number

Range: 1-255

Default: 100

ospf

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

Type: Object

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

uuid

Description: uuid of the object

Type: string

ip.address

Specification
Type object

dhcp

Description: Enable Dynamic Host Configuration Protocol (DHCP) to configure multiple IP addresses on an Ethernet data interface.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-cfg

Description: ip-cfg is a JSON List . Please see below for l491_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 l491_ospf-global

Type: Object

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

ospf-ip-list

Description: ospf-ip-list is a JSON List . Please see below for l491_ospf-ip-list

Type: List

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

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

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

Description: message-digest-cfg is a JSON List . Please see below for l491_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

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

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 l491_authentication-cfg

Type: Object

authentication-key

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

Type: string

Format: string-rlx

bfd-cfg

Description: bfd-cfg is a JSON Block . Please see below for l491_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 l491_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

Description: message-digest-cfg is a JSON List . Please see below for l491_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 l491_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

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: 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
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 l491_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

ipv6

Specification
Type object

address-cfg

Description: address-cfg is a JSON List . Please see below for l491_address-cfg

Type: List

ipv6-enable

Description: Enable the interface to process IPv6 traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

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