interface ve¶

Virtual ethernet interface

ve Specification¶

Parameter Value

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

Partition Visibility shared

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
POST /axapi/v3/interface/ve/ Payload: { "ve": { "ifnum": 2, "user-tag": "a" } }
Create List	POST	/axapi/v3/interface/ve	ve attributes
Get Object	GET	/axapi/v3/interface/ve/{ifnum}	ve attributes
GET /axapi/v3/interface/ve/2 Reponse: { "ve": { "ifnum": 2, "port-scan-detection": "disable", "ping-sweep-detection": "disable", "l3-vlan-fwd-disable": 0, "mtu": 1500, "trap-source": 0, "action": "enable", "uuid": "eae196d2-500c-11ee-ac8d-3b5bd4b1e0b9", "user-tag": "a", "a10-url": "/axapi/v3/interface/ve/2" } }
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
PUT /axapi/v3/interface/ve/2 Payload: { "ve": { "ifnum": 2, "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/interface/ve	ve-list
Delete Object	DELETE	/axapi/v3/interface/ve/{ifnum}	ve attributes
DELETE /axapi/v3/interface/ve/2 Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

ve-list¶

ve-list is JSON List of ve attributes

ve-list : [

{ ve attributes },

{ ve attributes },

…

]

ve attributes¶

access-list

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

Type: Object

action

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

Type: string

Supported Values: enable, disable

Default: enable

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

gaming-protocol-compliance

Description Enable Gaming Protocol Compliance Check

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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 Virtual ethernet interface number

Type: number

Range: 2-4094

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 Disable L3 forwarding between VLANs for incoming packets on this interface

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

map

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

Type: Object

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

nptv6

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

Type: Object

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

ping-sweep-detection

Description ‘enable’: Enable ping sweep detection; ‘disable’: Disable ping sweep detection(default);

Type: string

Supported Values: enable, disable

Default: disable

port-scan-detection

Description ‘enable’: Enable port scan detection; ‘disable’: Disable port scan detection(default);

Type: string

Supported Values: enable, disable

Default: disable

sampling-enable

Type: List

trap-source

Description The trap source

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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 Value

Type object

address-list

Type: List

allow-promiscuous-vip

Description Allow traffic to be associated with promiscuous VIP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

client

Description Client facing interface for IPv4/v6 traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dhcp

Description Use DHCP to configure IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

generate-membership-query

Description Enable Membership Query

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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 Maximum Response Time (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/ve/{ifnum}/ip/ospf

outside

Description Configure interface as outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

query-interval

Description 1 - 255 (Default is 125)

Type: number

Range: 1-255

Default: 125

rip

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

Type: Object

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

router

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

Type: Object

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

server

Description Server facing interface for IPv4/v6 traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

slb-partition-redirect

Description Redirect SLB traffic across partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stateful-firewall

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

Type: Object

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

syn-cookie

Description Enable SYN-cookie on the interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl-ignore

Description Ignore TTL decrement for a received packet

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

unnumbered

Description Set the interface as unnumbered

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_address-list¶

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

Specification Value

Type object

isis

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

Type: Object

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

ip_router_isis¶

Specification Value

Type object

tag

Description ISO routing area tag

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ip_helper-address-list¶

Specification Value

Type list

Block object keys

helper-address

Description Helper address for DHCP packets (IP address)

Type: string

Format: ipv4-address

ip_stateful-firewall¶

Specification Value

Type object

access-list

Description Access-list for traffic from the outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

acl-id

Description ACL id

Type: number

Range: 1-199

class-list

Description Class List (Class List Name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

inside

Description Inside (private) interface for stateful firewall

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description Outside (public) interface for stateful firewall

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_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 ‘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 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 ‘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_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/ve/{ifnum}/ip/ospf/ospf-global

ospf-ip-list

Type: List

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

ddos¶

Specification Value

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

Maximum Length: 64 characters

Maximum Length: 1 characters

access-list¶

Specification Value

Type object

acl-id

Description ACL id

Type: number

Range: 1-199

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

acl-name

Description Named Access List

Type: string

Maximum Length: 16 characters

Maximum Length: 1 characters

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

bfd¶

Specification Value

Type object

authentication

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

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

bfd_authentication¶

Specification Value

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

Maximum Length: 16 characters

Maximum Length: 1 characters

bfd_interval-cfg¶

Specification Value

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

sampling-enable¶

Specification Value

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 broadcasts; ‘num_multicast_pkts’: Received multicasts; ‘num_tx_pkts’: Transmitted packets; ‘num_total_tx_bytes’: Transmitted bytes; ‘num_unicast_tx_pkts’: Transmitted 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

ipv6¶

Specification Value

Type object

address-list

Type: List

inbound

Description ACL applied on incoming packets to this interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

inside

Description Configure interface as NAT 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/ve/{ifnum}/ipv6/ospf

outside

Description Configure interface as NAT outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rip

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

Type: Object

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

router

Description: router is a JSON Block. Please see below for ipv6_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 ipv6_router-adver

Type: Object

stateful-firewall

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

Type: Object

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

ttl-ignore

Description Ignore TTL decrement for a received packet

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

v6-acl-name

Description Apply ACL rules to incoming packets on this interface (Named Access List)

Type: string

Maximum Length: 16 characters

Maximum Length: 1 characters

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

ipv6_address-list¶

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

Specification Value

Type object

split-horizon-cfg

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

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ipv6_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

ipv6_stateful-firewall¶

Specification Value

Type object

access-list

Description Access-list for traffic from the outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

acl-name

Description Access-list Name

Type: string

Maximum Length: 16 characters

Maximum Length: 1 characters

class-list

Description Class List (Class List Name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

inside

Description Inside (private) interface for stateful firewall

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description Outside (public) interface for stateful firewall

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¶

Specification Value

Type object

isis

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

Type: Object

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

ospf

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

Type: Object

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

Specification Value

Type object

tag

Description ISO routing area tag

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 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

ipv6_router-adver¶

Specification Value

Type object

action

Description ‘enable’: Enable Router Advertisements on this interface; ‘disable’: Disable Router Advertisements on this interface;

Type: string

Supported Values: enable, disable

Default: disable

adver-mtu

Description Set Router Advertisement MTU Option

Type: number

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

adver-mtu-disable

Description Disable Router Advertisement MTU Option

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

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

adver-vrid

Description Vrid

Type: number

Range: 1-31

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

adver-vrid-default

Description Default VRRP-A vrid

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

default-lifetime

Description Set Router Advertisement Default Lifetime (default: 1800) (Default Lifetime (seconds))

Type: number

Range: 0-9000

Default: 1800

floating-ip

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

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

hop-limit

Description Set Router Advertisement Hop Limit (default: 255)

Type: number

Range: 0-255

Default: 255

managed-config-action

Description ‘enable’: Enable the Managed Address Configuration flag; ‘disable’: Disable the Managed Address Configuration flag (default);

Type: string

Supported Values: enable, disable

Default: disable

max-interval

Description Set Router Advertisement Max Interval (default: 600) (Max Router Advertisement Interval (seconds))

Type: number

Range: 4-1800

Default: 600

min-interval

Description Set Router Advertisement Min Interval (default: 200) (Min Router Advertisement Interval (seconds))

Type: number

Range: 3-1350

Default: 200

other-config-action

Description ‘enable’: Enable the Other Stateful Configuration flag; ‘disable’: Disable the Other Stateful Configuration flag (default);

Type: string

Supported Values: enable, disable

Default: disable

prefix-list

Type: List

rate-limit

Description Rate Limit the processing of incoming Router Solicitations (Max Number of Router Solicitations to process per second)

Type: number

Range: 1-100000

Default: 100000

reachable-time

Description Set Router Advertisement Reachable ime (default: 0) (Reachable Time (milliseconds))

Type: number

Range: 0-3600000

Default: 0

retransmit-timer

Description Set Router Advertisement Retransmit Timer (default: 0)

Type: number

Range: 0-4294967295

Default: 0

use-floating-ip

Description Use a floating IP 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 Value

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

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

nptv6¶

Specification Value

Type object

domain-list

Type: List

Reference Object: /axapi/v3/interface/ve/{ifnum}/nptv6/domain/{domain-name}+{bind-type}

nptv6_domain-list¶

Specification Value

Type list

Block object keys

bind-type

Description ‘inside’: This interface is connected to NPTv6 inside networks; ‘outside’: This interface is connected to NPTv6 outside networks;

Type: string

Supported Values: inside, outside

domain-name

Description NPTv6 domain name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

isis¶

Specification Value

Type object

authentication

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

Type: Object

bfd-cfg

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

Type: List

hello-interval-list

Type: List

hello-interval-minimal-list

Type: List

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 isis_mesh-group

Type: Object

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

Type: List

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

Maximum Length: 64 characters

Maximum Length: 1 characters

wide-metric-list

Type: List

isis_priority-list¶

Specification Value

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 Value

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 Value

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

isis_password-list¶

Specification Value

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

Maximum Length: 254 characters

Maximum Length: 1 characters

isis_authentication¶

Specification Value

Type object

key-chain-list

Type: List

mode-list

Type: List

send-only-list

Type: List

isis_authentication_key-chain-list¶

Specification Value

Type list

Block object keys

key-chain

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

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

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 Value

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 Value

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 Value

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 Value

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 Value

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 Value

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 Value

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

icmpv6-rate-limit¶

Specification Value

Type object

lockup-period-v6

Description Lockup period (second)

Type: number

Range: 1-16383

lockup-v6

Description Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)

Type: number

Range: 1-65535

normal-v6

Description Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit

Type: number

Range: 1-65535

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

icmp-rate-limit¶

Specification Value

Type object

lockup

Description Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)

Type: number

Range: 1-65535

lockup-period

Description Lockup period (second)

Type: number

Range: 1-16383

normal

Description Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit

Type: number

Range: 1-65535