interface ve

Configure the virtual Ethernet interface.

ve Specification

Type Collection
Object Key(s) ifnum
Collection Name ve-list
Collection URI /axapi/v3/interface/ve/
Element Name ve
Element URI /axapi/v3/interface/ve/{ifnum}
Element Attributes ve_attributes
Statistics Data URI /axapi/v3/interface/ve/{ifnum}/stats
Operational Data URI /axapi/v3/interface/ve/{ifnum}/oper
Schema ve schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/interface/ve/

ve Attributes

Create List

POST

/axapi/v3/interface/ve/

ve Attributes

Get Object

GET

/axapi/v3/interface/ve/{ifnum}

ve Attributes

Get List

GET

/axapi/v3/interface/ve/

ve-list

Modify Object

POST

/axapi/v3/interface/ve/{ifnum}

ve Attributes

Replace Object

PUT

/axapi/v3/interface/ve/{ifnum}

ve Attributes

Replace List

PUT

/axapi/v3/interface/ve/

ve-list

Delete Object

DELETE

/axapi/v3/interface/ve/{ifnum}

ve Attributes

Get Stats

GET

/axapi/v3/interface/ve/{ifnum}/stats

stats data

Get Oper

GET

/axapi/v3/interface/ve/{ifnum}/oper

operational data

ve-list

ve-list is JSON List of ve Attributes

ve-list : [

ve Attributes

access-list

Description: access-list is a JSON Block . Please see below for access-list

Type: Object

action

Description: Administrative state of the interface.

Type: string

Supported Values: enable, disable

bfd

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

Type: Object

Reference Object: /axapi/v3/interface/ve/{ifnum}/bfd

ddos

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

Type: Object

Reference Object: /axapi/v3/interface/ve/{ifnum}/ddos

icmp-rate-limit

Description: icmp-rate-limit is a JSON Block . Please see below for icmp-rate-limit

Type: Object

icmpv6-rate-limit

Description: icmpv6-rate-limit is a JSON Block . Please see below for icmpv6-rate-limit

Type: Object

ifnum

Description: Specify the virtual Ethernet interface number.

Type: number

Range: 2-4094

Required: Yes

Reference Object: /axapi/v3/network/vlan

ip

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

Type: Object

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

ipv6

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

Type: Object

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

isis

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

Type: Object

Reference Object: /axapi/v3/interface/ve/{ifnum}/isis

l3-vlan-fwd-disable

Description: Disables Layer 3 forwarding between VLANs for incoming traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lw-4o6

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

Type: Object

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

mtu

Description: Maximum Transmission Unit (MTU) for packets transmitted on the interface. Note: Jumbo support must be enabled in order to set the MTU to a higher value than the default.

Type: number

name

Description: Create a name for the virtual Ethernet interface.

Type: string

Format: string-rlx

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

trap-source

Description: Specifies whether to use this interface as the source of SNMP traps.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

icmp-rate-limit

Specification
Type object

lockup

Description: Maximum number of ICMP or ICMPv6 packets allowed per second before the ACOS device locks up ICMP or ICMPv6 traffic on the interface. When ICMP or ICMPv6 traffic is locked up, all ICMP or ICMPv6 packets are dropped until the lockup expires.

Type: number

Range: 1-65535

lockup-period

Description: Number of seconds for which the ACOS device drops all ICMP or ICMPv6 traffic on the interface, after the maximum rate is exceeded.

Type: number

Range: 1-16383

normal

Description: Maximum number of ICMP or ICMPv6 packets allowed per second on the interface. If the ACOS interface receives more than the normal rate of ICMP or ICMPv6 packets, the excess packets are dropped until the next one-second interval begins.

Type: number

Range: 1-65535

isis

Specification
Type object

authentication

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

Type: Object

bfd-cfg

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

Type: Object

circuit-type

Description: ‘level-1’: Level-1 only adjacencies are formed; ‘level-1-2’: Level-1-2 adjacencies are formed; ‘level-2-only’: Level-2 only adjacencies are formed;

Type: string

Supported Values: level-1, level-1-2, level-2-only

Default: level-1-2

csnp-interval-list

Description: csnp-interval-list is a JSON List . Please see below for l511_csnp-interval-list

Type: List

hello-interval-list

Description: hello-interval-list is a JSON List . Please see below for l511_hello-interval-list

Type: List

hello-interval-minimal-list

Description: hello-interval-minimal-list is a JSON List . Please see below for l511_hello-interval-minimal-list

Type: List

hello-multiplier-list

Description: hello-multiplier-list is a JSON List . Please see below for l511_hello-multiplier-list

Type: List

lsp-interval

Description: Set LSP transmission interval (LSP transmission interval (milliseconds))

Type: number

Range: 1-4294967295

Default: 33

mesh-group

Description: mesh-group is a JSON Block . Please see below for l511_mesh-group

Type: Object

metric-list

Description: metric-list is a JSON List . Please see below for l511_metric-list

Type: List

network

Description: ‘broadcast’: Specify IS-IS broadcast multi-access network; ‘point-to-point’: Specify IS-IS point-to-point network;

Type: string

Supported Values: broadcast, point-to-point

padding

Description: Add padding to IS-IS hello packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

password-list

Description: password-list is a JSON List . Please see below for l511_password-list

Type: List

priority-list

Description: priority-list is a JSON List . Please see below for l511_priority-list

Type: List

retransmit-interval

Description: Set per-LSP retransmission interval (Interval between retransmissions of the same LSP (seconds))

Type: number

Range: 0-65535

Default: 5

uuid

Description: uuid of the object

Type: string

wide-metric-list

Description: wide-metric-list is a JSON List . Please see below for l511_wide-metric-list

Type: List

isis.priority-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify priority for level-1 routing; ‘level-2’: Specify priority for level-2 routing;

Type: string

Supported Values: level-1, level-2

priority

Description: Set priority for Designated Router election (Priority value)

Type: number

Range: 0-127

Default: 64

isis.hello-interval-minimal-list

Specification
Type list
Block object keys

hello-interval-minimal

Description: Set Hello holdtime 1 second, interval depends on multiplier

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

level

Description: ‘level-1’: Specify hello-interval for level-1 IIHs; ‘level-2’: Specify hello-interval for level-2 IIHs;

Type: string

Supported Values: level-1, level-2

isis.mesh-group

Specification
Type object

blocked

Description: Block LSPs on this interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: blocked and value are mutually exclusive

value

Description: Mesh group number

Type: number

Range: 1-4294967295

Mutual Exclusion: value and blocked are mutually exclusive

isis.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

isis.password-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify password for level-1 PDUs; ‘level-2’: Specify password for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

password

Description: Configure the authentication password for interface

Type: string

Format: string-rlx

isis.authentication

Specification
Type object

key-chain-list

Description: key-chain-list is a JSON List . Please see below for l511_key-chain-list

Type: List

mode-list

Description: mode-list is a JSON List . Please see below for l511_mode-list

Type: List

send-only-list

Description: send-only-list is a JSON List . Please see below for l511_send-only-list

Type: List

isis.authentication.key-chain-list

Specification
Type list
Block object keys

key-chain

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

Type: string

level

Description: ‘level-1’: Specify authentication key-chain for level-1 PDUs; ‘level-2’: Specify authentication key-chain for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

isis.authentication.mode-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify authentication mode for level-1 PDUs; ‘level-2’: Specify authentication mode for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

mode

Description: ‘md5’: Keyed message digest;

Type: string

Supported Values: md5

isis.authentication.send-only-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify authentication send-only for level-1 PDUs; ‘level-2’: Specify authentication send-only for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

send-only

Description: Authentication send-only

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

isis.wide-metric-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Apply metric to level-1 links; ‘level-2’: Apply metric to level-2 links;

Type: string

Supported Values: level-1, level-2

wide-metric

Description: Configure the wide metric for interface

Type: number

Range: 1-16777214

Default: 10

isis.hello-interval-list

Specification
Type list
Block object keys

hello-interval

Description: Set Hello interval in seconds (Hello interval value)

Type: number

Range: 1-65535

Default: 10

level

Description: ‘level-1’: Specify hello-interval for level-1 IIHs; ‘level-2’: Specify hello-interval for level-2 IIHs;

Type: string

Supported Values: level-1, level-2

isis.hello-multiplier-list

Specification
Type list
Block object keys

hello-multiplier

Description: Set multiplier for Hello holding time (Hello multiplier value)

Type: number

Range: 2-100

Default: 3

level

Description: ‘level-1’: Specify hello multiplier for level-1 IIHs; ‘level-2’: Specify hello multiplier for level-2 IIHs;

Type: string

Supported Values: level-1, level-2

isis.metric-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Apply metric to level-1 links; ‘level-2’: Apply metric to level-2 links;

Type: string

Supported Values: level-1, level-2

metric

Description: Configure the metric for interface (Default metric)

Type: number

Range: 1-63

Default: 10

isis.csnp-interval-list

Specification
Type list
Block object keys

csnp-interval

Description: Set CSNP interval in seconds (CSNP interval value)

Type: number

Range: 1-65535

Default: 10

level

Description: ‘level-1’: Speficy interval for level-1 CSNPs; ‘level-2’: Specify interval for level-2 CSNPs;

Type: string

Supported Values: level-1, level-2

bfd

Specification
Type object

authentication

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

Type: Object

demand

Description: Demand mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

echo

Description: Enable BFD Echo

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interval-cfg

Description: interval-cfg is a JSON Block . Please see below for l511_interval-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

bfd.authentication

Specification
Type object

encrypted

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

key-id

Description: Key ID

Type: number

Range: 0-255

method

Description: ‘md5’: Keyed MD5; ‘meticulous-md5’: Meticulous Keyed MD5; ‘meticulous-sha1’: Meticulous Keyed SHA1; ‘sha1’: Keyed SHA1; ‘simple’: Simple Password;

Type: string

Supported Values: md5, meticulous-md5, meticulous-sha1, sha1, simple

password

Description: Key String

Type: string

Format: password

bfd.interval-cfg

Specification
Type object

interval

Description: Transmit interval between BFD packets (Milliseconds)

Type: number

Range: 48-1000

min-rx

Description: Minimum receive interval capability (Milliseconds)

Type: number

Range: 48-1000

multiplier

Description: Multiplier value used to compute holddown (value used to multiply the interval)

Type: number

Range: 3-50

ip

Specification
Type object

address-list

Description: address-list is a JSON List . Please see below for l511_address-list

Type: List

allow-promiscuous-vip

Description: Enables client traffic received on this interface and addressed to TCP port 80 to be load balanced for any VIP address. This feature also requires configuration of a virtual server that has IP address 0.0.0.0.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

generate-membership-query

Description: Enables configuring a timer for IGMPv2 request queries.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

helper-address-list

Description: helper-address-list is a JSON List . Please see below for l511_helper-address-list

Type: List

inside

Description: Configure interface as inside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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 l511_ospf

Type: Object

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

outside

Description: Configure interface as outside.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

query-interval

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

rip

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

Type: Object

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

router

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

Type: Object

Reference Object: /axapi/v3/interface/ve/{ifnum}/ip/router

slb-partition-redirect

Description: Redirect your SLB traffic across partitions.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stateful-firewall

Description: stateful-firewall is a JSON Block . Please see below for l511_stateful-firewall

Type: Object

Reference Object: /axapi/v3/interface/ve/{ifnum}/ip/stateful-firewall

uuid

Description: uuid of the object

Type: string

ip.address-list

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.helper-address-list

Specification
Type list
Block object keys

helper-address

Description: Helper address for DHCP packets (IP address)

Type: string

Format: ipv4-address

ip.stateful-firewall

Specification
Type object

access-list

Description: Apply an access list to traffic from the outside.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

acl-id

Description: Specify the ID of a configured ACL to use.

Type: number

Range: 1-199

class-list

Description: Class List (Class List Name)

Type: string

Format: string-rlx

inside

Description: Apply stateful firewall to inside (private) IPv4 traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description: Apply stateful firewall to outside (public) IPv4 traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

ip.rip

Specification
Type object

authentication

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

Type: Object

receive-cfg

Description: receive-cfg is a JSON Block . Please see below for l511_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 l511_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 l511_split-horizon-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

ip.rip.receive-cfg

Specification
Type object

receive

Description: Advertisement reception

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

version

Description: ‘1’: RIP version 1; ‘2’: RIP version 2; ‘1-2’: RIP version 1 & 2;

Type: string

Supported Values: 1, 2, 1-2

ip.rip.split-horizon-cfg

Specification
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
Type object

key-chain

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

Type: Object

mode

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

Type: Object

str

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

Type: Object

ip.rip.authentication.key-chain

Specification
Type object

key-chain

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

Type: string

Format: string-rlx

ip.rip.authentication.mode

Specification
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
Type object

string

Description: The RIP authentication string

Type: string

Format: string-rlx

ip.rip.send-cfg

Specification
Type object

send

Description: Advertisement transmission

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

version

Description: ‘1’: RIP version 1; ‘2’: RIP version 2; ‘1-compatible’: RIPv1-compatible; ‘1-2’: RIP version 1 & 2;

Type: string

Supported Values: 1, 2, 1-compatible, 1-2

ip.router

Specification
Type object

isis

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

Type: Object

Reference Object: /axapi/v3/interface/ve/{ifnum}/ip/router/isis

ip.router.isis

Specification
Type object

tag

Description: ISO routing area tag

Type: string

uuid

Description: uuid of the object

Type: string

ip.ospf

Specification
Type object

ospf-global

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

Type: Object

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

ospf-ip-list

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

Type: List

Reference Object: /axapi/v3/interface/ve/{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 l511_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 l511_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 l511_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 l511_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 l511_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 l511_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 l511_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

icmpv6-rate-limit

Specification
Type object

lockup-period-v6

Description: Number of seconds for which the ACOS device drops all ICMPv6 traffic on the interface, after the maximum rate is exceeded.

Type: number

Range: 1-16383

lockup-v6

Description: Maximum number of ICMPv6 packets allowed per second before the ACOS device locks up ICMPv6 traffic on the interface. When ICMPv6 traffic is locked up, all ICMPv6 packets are dropped until the lockup expires.

Type: number

Range: 1-65535

normal-v6

Description: Maximum number of ICMPv6 packets allowed per second before the ACOS device locks up ICMPv6 traffic on the interface. When ICMPv6 traffic is locked up, all ICMPv6 packets are dropped until the lockup expires.

Type: number

Range: 1-65535

access-list

Specification
Type object

acl-id

Description: Specify the ID of a configured ACL.

Type: number

Range: 1-199

Reference Object: /axapi/v3/access-list/standard

acl-name

Description: Specify the name of a configured ACL.

Type: string

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘num_pkts’: Input packets; ‘num_total_bytes’: Input bytes; ‘num_unicast_pkts’: Received unicasts; ‘num_broadcast_pkts’: Received braodcasts; ‘num_multicast_pkts’: Received multicasts; ‘num_tx_pkts’: Transmitted packtes; ‘num_total_tx_bytes’: Transmitte bytes; ‘num_unicast_tx_pkts’: Trasnmitted unicasts; ‘num_broadcast_tx_pkts’: Transmitted broadcasts; ‘num_multicast_tx_pkts’: Transmitted multicasts; ‘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; ‘load_interval’: Load Interval;

Type: string

Supported Values: all, num_pkts, num_total_bytes, num_unicast_pkts, num_broadcast_pkts, num_multicast_pkts, num_tx_pkts, num_total_tx_bytes, num_unicast_tx_pkts, num_broadcast_tx_pkts, num_multicast_tx_pkts, rate_pkt_sent, rate_byte_sent, rate_pkt_rcvd, rate_byte_rcvd, load_interval

lw-4o6

Specification
Type object

inside

Description: Enable Lightweight 4over6 (LW-4over6) for inside interface.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description: Enable Lightweight 4over6 (LW-4over6) for external interface.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

ipv6

Specification
Type object

address-list

Description: address-list is a JSON List . Please see below for l511_address-list

Type: List

inbound

Description: Specify the name of an ACL to use to filter inbound packets on the interface.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

inside

Description: Configure the interface as inside.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6-enable

Description: Enable the interface to process IPv6 traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf

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

Type: Object

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

outside

Description: Configure the interface as outside.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rip

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

Type: Object

Reference Object: /axapi/v3/interface/ve/{ifnum}/ipv6/rip

router

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

Type: Object

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

router-adver

Description: router-adver is a JSON Block . Please see below for l511_router-adver

Type: Object

stateful-firewall

Description: stateful-firewall is a JSON Block . Please see below for l511_stateful-firewall

Type: Object

Reference Object: /axapi/v3/interface/ve/{ifnum}/ipv6/stateful-firewall

uuid

Description: uuid of the object

Type: string

v6-acl-name

Description: Specify the name of an ACL to use to filter inbound packets on this interface.

Type: string

Reference Object: /axapi/v3/ipv6/access-list

ipv6.address-list

Specification
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.rip

Specification
Type object

split-horizon-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

ipv6.rip.split-horizon-cfg

Specification
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

ipv6.stateful-firewall

Specification
Type object

access-list

Description: Apply an access list to traffic from the outside.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

acl-name

Description: Specify the name of an ACL.

Type: string

class-list

Description: Class List (Class List Name)

Type: string

Format: string-rlx

inside

Description: Apply stateful firewall to inside (private) IPv6 traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description: Apply stateful firewall to outside (public) IPv6 traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

ipv6.router

Specification
Type object

isis

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

Type: Object

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

ospf

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

Type: Object

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

ripng

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

Type: Object

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

ipv6.router.ripng

Specification
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

ipv6.router.ospf

Specification
Type object

area-list

Description: area-list is a JSON List . Please see below for l511_area-list

Type: List

uuid

Description: uuid of the object

Type: string

ipv6.router.ospf.area-list

Specification
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

ipv6.router.isis

Specification
Type object

tag

Description: ISO routing area tag

Type: string

uuid

Description: uuid of the object

Type: string

ipv6.ospf

Specification
Type object

bfd

Description: Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cost-cfg

Description: cost-cfg is a JSON List . Please see below for l511_cost-cfg

Type: List

dead-interval-cfg

Description: dead-interval-cfg is a JSON List . Please see below for l511_dead-interval-cfg

Type: List

disable

Description: Disable BFD

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hello-interval-cfg

Description: hello-interval-cfg is a JSON List . Please see below for l511_hello-interval-cfg

Type: List

mtu-ignore-cfg

Description: mtu-ignore-cfg is a JSON List . Please see below for l511_mtu-ignore-cfg

Type: List

neighbor-cfg

Description: neighbor-cfg is a JSON List . Please see below for l511_neighbor-cfg

Type: List

network-list

Description: network-list is a JSON List . Please see below for l511_network-list

Type: List

priority-cfg

Description: priority-cfg is a JSON List . Please see below for l511_priority-cfg

Type: List

retransmit-interval-cfg

Description: retransmit-interval-cfg is a JSON List . Please see below for l511_retransmit-interval-cfg

Type: List

transmit-delay-cfg

Description: transmit-delay-cfg is a JSON List . Please see below for l511_transmit-delay-cfg

Type: List

uuid

Description: uuid of the object

Type: string

ipv6.ospf.cost-cfg

Specification
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
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
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
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
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
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
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
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
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

ipv6.router-adver

Specification
Type object

action

Description: Enable or disable IPv6 router discovery.

Type: string

Supported Values: enable, disable

Default: enable

adver-ha-group-id

Description: Configure HA group ID.

Type: number

Range: 1-31

adver-mtu

Description: Configure the Maximum Transmission Unit (MTU).

Type: number

Mutual Exclusion: adver-mtu and adver-mtu-disable are mutually exclusive

adver-mtu-disable

Description: Disable Maximum Transmission Unit (MTU) for packets transmitted on the interface.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: adver-mtu-disable and adver-mtu are mutually exclusive

adver-vrid

Description: Specify a VRRP-A VRID.

Type: number

Range: 1-31

Mutual Exclusion: adver-vrid and adver-vrid-default are mutually exclusive

adver-vrid-default

Description: Enables the use of the default VRID to send router advertisements.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: adver-vrid-default and adver-vrid are mutually exclusive

default-lifetime

Description: Specifies the number of seconds for which router advertisements sent on this interface are valid.

Type: number

Range: 0-9000

Default: 1800

floating-ip

Description: Specify a floating IPv6 address to use as the source address for router advertisements for the VRID. The address must be a link-local address on this interface.

Type: string

Format: ipv6-address

floating-ip-default-vrid

Description: Use a floating IP as the source address for Router advertisements

Type: string

Format: ipv6-address

ha-floating-ip

Description: Specify a floating IPv6 address to use as the source address for router advertisements for the HA group. The address must be a link-local address on this interface.

Type: string

Format: ipv6-address

ha-use-floating-ip

Description: Enable the use of a floating IP address as the source address for router advertisements.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hop-limit

Description: Specifies the default hop count value that should be used by hosts. For a given packet, the hop count is decremented at each router hop. If the hop count reaches 0, the packet becomes invalid.

Type: number

Range: 0-255

Default: 255

max-interval

Description: Specifies the maximum number of seconds between transmission of unsolicited router advertisement messages on this interface.

Type: number

Range: 4-1800

Default: 600

min-interval

Description: Specifies the minimum number of seconds between transmission of unsolicited router advertisement messages on this interface.

Note:

  • The value can not be less than the maximum advertisement interval.
  • If you specify 0, the host will not use this interface (IPv6 router) as a default route.

Type: number

Range: 3-1350

Default: 200

prefix-list

Description: prefix-list is a JSON List . Please see below for l511_prefix-list

Type: List

rate-limit

Description: Specifies the maximum number of router solicitation requests per second that will be processed on the interface.

Type: number

Range: 1-100000

Default: 100000

reachable-time

Description: Specifies the number of milliseconds (ms) for which the host should assume a neighbor is reachable, after receiving a reachability confirmation from the neighbor.

Note: If you specify 0, the value is unspecified by this IPv6 router.

Type: number

Range: 0-3600000

Default: 0

retransmit-timer

Description: Specifies the number of seconds a host should wait between sending neighbor solicitation messages

Note: If you specify 0, the value is unspecified by this IPv6 router.

Type: number

Range: 0-4294967295

Default: 0

use-floating-ip

Description: Enable the use of a floating IP address as the source address for router advertisements.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-floating-ip-default-vrid

Description: Use a floating IP as the source address for Router advertisements

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6.router-adver.prefix-list

Specification
Type list
Block object keys

not-autonomous

Description: Specify that the Prefix is not usable for autoconfiguration (default:autonomous)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

not-on-link

Description: Specify that the Prefix is not On-Link (default: on-link)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

preferred-lifetime

Description: Specify Prefix Preferred Lifetime (default:604800) (Prefix Advertised Preferred Lifetime (default: 604800))

Type: number

Range: 0-4294967295

Default: 604800

prefix

Description: Set Router Advertisement On-Link Prefix (IPv6 On-Link Prefix)

Type: string

Format: ipv6-address-plen

valid-lifetime

Description: Specify Valid Lifetime (default:2592000) (Prefix Advertised Valid Lifetime (default: 2592000))

Type: number

Range: 0-4294967295

Default: 2592000

ddos

Specification
Type object

inside

Description: DDoS inside (trusted) or outside (untrusted) interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description: DDoS inside (trusted) or outside (untrusted) interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

stats data

Counter Size Description
num_tx_pkts 8 Transmitted packtes
rate_byte_rcvd 8 Byte received rate bits/sec
num_total_tx_bytes 8 Transmitte bytes
rate_pkt_rcvd 8 Packet received rate packets/sec
num_multicast_pkts 8 Received multicasts
num_unicast_pkts 8 Received unicasts
num_broadcast_tx_pkts 8 Transmitted broadcasts
num_broadcast_pkts 8 Received braodcasts
num_multicast_tx_pkts 8 Transmitted multicasts
rate_byte_sent 8 Byte sent rate bits/sec
num_unicast_tx_pkts 8 Trasnmitted unicasts
num_total_bytes 8 Input bytes
load_interval 8 Load Interval
num_pkts 8 Input packets
rate_pkt_sent 8 Packet sent rate packets/sec

operational data

Name Type Description
line_protocol enum Output contains one of the following values: - UP, DOWN
ipv4-netmask ipv4-netmask IP subnet mask
mac mac-address mac
state enum Output contains one of the following values: - UP, DISABLED, DOWN
ipv4-address ipv4-address IP address
link_type string link_type