interface¶
Select an interface to configure
interface Specification¶
Parameter Value Type Intermediate Resource Element Name interface Element URI /axapi/v3/interface Element Attributes interface_attributes Partition Visibility shared Schema interface schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/interface | interface_attributes |
interface attributes¶
available-eth-list
Description: available-eth-list is a JSON Block. Please see below for available-eth-list
Type: Object
Reference Object: /axapi/v3/interface/available-eth-list
brief
Description: brief is a JSON Block. Please see below for brief
Type: Object
Reference Object: /axapi/v3/interface/brief
common
Description: common is a JSON Block. Please see below for common
Type: Object
Reference Object: /axapi/v3/interface/common
driver-statistic
Description: driver-statistic is a JSON Block. Please see below for driver-statistic
Type: Object
Reference Object: /axapi/v3/interface/driver-statistic
ethernet-list
Type: List
Reference Object: /axapi/v3/interface/ethernet/{ifnum}
lif-list
Type: List
Reference Object: /axapi/v3/interface/lif/{ifname}
loopback-list
Type: List
Reference Object: /axapi/v3/interface/loopback/{ifnum}
management
Description: management is a JSON Block. Please see below for management
Type: Object
Reference Object: /axapi/v3/interface/management
packet-size-bucket
Description: packet-size-bucket is a JSON Block. Please see below for packet-size-bucket
Type: Object
Reference Object: /axapi/v3/interface/packet-size-bucket
switch-drop-reason
Description: switch-drop-reason is a JSON Block. Please see below for switch-drop-reason
Type: Object
Reference Object: /axapi/v3/interface/switch-drop-reason
trunk-list
Type: List
Reference Object: /axapi/v3/interface/trunk/{ifnum}
tunnel-list
Type: List
Reference Object: /axapi/v3/interface/tunnel/{ifnum}
ve-list
Type: List
Reference Object: /axapi/v3/interface/ve/{ifnum}
tunnel-list¶
Specification Value Type list Block object keys action
Description ‘enable’: Enable; ‘disable’: Disable;
Type: string
Supported Values: enable, disable
Default: enable
ifnum
Description Tunnel interface number
Type: number
Range: 1-128
ip
Description: ip is a JSON Block. Please see below for tunnel-list_ip
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ip
ipv6
Description: ipv6 is a JSON Block. Please see below for tunnel-list_ipv6
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6
load-interval
Description Configure Load Interval (Seconds (5-300, Multiple of 5), default 300)
Type: number
Range: 5-300
Default: 300
lw-4o6
Description: lw-4o6 is a JSON Block. Please see below for tunnel-list_lw-4o6
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/lw-4o6
map
Description: map is a JSON Block. Please see below for tunnel-list_map
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/map
mtu
Description Interface mtu (Interface MTU, default 1 (min MTU is 1280 for IPv6))
Type: number
name
Description Name for the interface
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
packet-capture-template
Description Name of the packet capture template to be bind with this object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/packet-capture/object-templates/interface-tunnel-tmpl
sampling-enable
Type: Listsecurity-level
Description Configure security level for interface. 100 - Most Secure
Type: number
Range: 0-100
speed
Description Speed in Gbit/Sec (Default 10 Gbps)
Type: number
Range: 1-200
Default: 10
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tunnel-list_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
tunnel-list_ip¶
Specification Value Type object address
Description: address is a JSON Block. Please see below for tunnel-list_ip_address
Type: Object
generate-membership-query
Description Enable Membership Query
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
generate-membership-query-val
Description 1 - 255 (Default is 125)
Type: number
Range: 1-255
Default: 125
inside
Description Configure interface as inside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
max-resp-time
Description Max Response Time (Default is 100)
Type: number
Range: 1-255
Default: 100
ospf
Description: ospf is a JSON Block. Please see below for tunnel-list_ip_ospf
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ip/ospf
outside
Description Configure interface as outside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rip
Description: rip is a JSON Block. Please see below for tunnel-list_ip_rip
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ip/rip
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tunnel-list_ip_rip¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for tunnel-list_ip_rip_authentication
Type: Object
receive-cfg
Description: receive-cfg is a JSON Block. Please see below for tunnel-list_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 tunnel-list_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 tunnel-list_ip_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tunnel-list_ip_rip_receive-cfg¶
Specification Value Type object receive
Description Advertisement reception
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
version
Description ‘2’: RIP version 2;
Type: string
Supported Values: 2
tunnel-list_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
tunnel-list_ip_rip_authentication¶
Specification Value Type object key-chain
Description: key-chain is a JSON Block. Please see below for tunnel-list_ip_rip_authentication_key-chain
Type: Object
mode
Description: mode is a JSON Block. Please see below for tunnel-list_ip_rip_authentication_mode
Type: Object
str
Description: str is a JSON Block. Please see below for tunnel-list_ip_rip_authentication_str
Type: Object
tunnel-list_ip_rip_authentication_key-chain¶
Specification Value Type object key-chain
Description Authentication key-chain (Name of key-chain)
Type: string
Format: string-rlx
tunnel-list_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
tunnel-list_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
tunnel-list_ip_rip_send-cfg¶
Specification Value Type object send
Description Advertisement transmission
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
version
Description ‘2’: RIP version 2;
Type: string
Supported Values: 2
tunnel-list_ip_address¶
Specification Value Type object dhcp
Description Use DHCP to configure IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-cfg
Type: List
tunnel-list_ip_address_ip-cfg¶
Specification Value Type list Block object keys ipv4-address
Description IP address
Type: string
Format: ipv4-address
ipv4-netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask
tunnel-list_ip_ospf¶
Specification Value Type object ospf-global
Description: ospf-global is a JSON Block. Please see below for tunnel-list_ip_ospf_ospf-global
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ip/ospf/ospf-global
ospf-ip-list
Type: List
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ip/ospf/ospf-ip/{ip-addr}
tunnel-list_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: Listmtu-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
tunnel-list_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
tunnel-list_ip_ospf_ospf-global¶
Specification Value Type object authentication-cfg
Description: authentication-cfg is a JSON Block. Please see below for tunnel-list_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 tunnel-list_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 tunnel-list_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: Listmtu
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 tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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 tunnel-list_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
tunnel-list_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
tunnel-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘num-rx-pkts’: received packets; ‘num-total-rx-bytes’: received bytes; ‘num-tx-pkts’: sent packets; ‘num-total-tx-bytes’: sent bytes; ‘num-rx-err-pkts’: received error packets; ‘num-tx-err-pkts’: sent error packets; ‘rate_pkt_sent’: Packet sent rate packets/sec; ‘rate_byte_sent’: Byte sent rate bits/sec; ‘rate_pkt_rcvd’: Packet received rate packets/sec; ‘rate_byte_rcvd’: Byte received rate bits/sec;
Type: string
Supported Values: all, num-rx-pkts, num-total-rx-bytes, num-tx-pkts, num-total-tx-bytes, num-rx-err-pkts, num-tx-err-pkts, rate_pkt_sent, rate_byte_sent, rate_pkt_rcvd, rate_byte_rcvd
tunnel-list_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
tunnel-list_ipv6¶
Specification Value Type object address-cfg
Type: Listinside
Description Configure interface as inside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6-enable
Description Enable IPv6 processing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ospf
Description: ospf is a JSON Block. Please see below for tunnel-list_ipv6_ospf
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6/ospf
outside
Description Configure interface as outside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
router
Description: router is a JSON Block. Please see below for tunnel-list_ipv6_router
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6/router
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tunnel-list_ipv6_address-cfg¶
Specification Value Type list Block object keys address-type
Description ‘anycast’: Configure an IPv6 anycast address; ‘link-local’: Configure an IPv6 link local address;
Type: string
Supported Values: anycast, link-local
ipv6-addr
Description Set the IPv6 address of an interface
Type: string
Format: ipv6-address-plen
tunnel-list_ipv6_router¶
Specification Value Type object ospf
Description: ospf is a JSON Block. Please see below for tunnel-list_ipv6_router_ospf
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6/router/ospf
ripng
Description: ripng is a JSON Block. Please see below for tunnel-list_ipv6_router_ripng
Type: Object
Reference Object: /axapi/v3/interface/tunnel/{ifnum}/ipv6/router/ripng
tunnel-list_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
tunnel-list_ipv6_router_ospf¶
Specification Value Type object area-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tunnel-list_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
tunnel-list_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: Listdead-interval-cfg
Type: Listdisable
Description Disable BFD
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hello-interval-cfg
Type: Listmtu-ignore-cfg
Type: Listneighbor-cfg
Type: Listnetwork-list
Type: Listpriority-cfg
Type: Listretransmit-interval-cfg
Type: Listtransmit-delay-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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
tunnel-list_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
management¶
Specification Value Type object access-list
Description: access-list is a JSON Block. Please see below for management_access-list
Type: Object
action
Description ‘enable’: Enable Management Port; ‘disable’: Disable Management Port;
Type: string
Supported Values: enable, disable
Default: enable
broadcast-rate-limit
Description: broadcast-rate-limit is a JSON Block. Please see below for management_broadcast-rate-limit
Type: Object
duplexity
Description ‘Full’: Full; ‘Half’: Half; ‘auto’: Auto;
Type: string
Supported Values: Full, Half, auto
Default: auto
flow-control
Description Enable 802.3x flow control on full duplex port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip
Description: ip is a JSON Block. Please see below for management_ip
Type: Object
ipv6
Type: Listlldp
Description: lldp is a JSON Block. Please see below for management_lldp
Type: Object
Reference Object: /axapi/v3/interface/management/lldp
mtu
Description Interface mtu (Interface MTU, default 1 (min MTU is 1280 for IPv6))
Type: number
sampling-enable
Type: Listsecondary-ip
Description: secondary-ip is a JSON Block. Please see below for management_secondary-ip
Type: Object
speed
Description ‘10’: 10 Mbs/sec; ‘100’: 100 Mbs/sec; ‘1000’: 1 Gb/sec; ‘auto’: Auto Negotiate Speed; (Interface Speed)
Type: string
Supported Values: 10, 100, 1000, auto
Default: auto
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
management_lldp¶
Specification Value Type object enable-cfg
Description: enable-cfg is a JSON Block. Please see below for management_lldp_enable-cfg
Type: Object
notification-cfg
Description: notification-cfg is a JSON Block. Please see below for management_lldp_notification-cfg
Type: Object
tx-dot1-cfg
Description: tx-dot1-cfg is a JSON Block. Please see below for management_lldp_tx-dot1-cfg
Type: Object
tx-tlvs-cfg
Description: tx-tlvs-cfg is a JSON Block. Please see below for management_lldp_tx-tlvs-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
management_lldp_tx-dot1-cfg¶
Specification Value Type object link-aggregation
Description Interface link aggregation information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tx-dot1-tlvs
Description Interface lldp tx IEEE 802.1 Organizationally specific TLVs configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vlan
Description Interface vlan information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
management_lldp_notification-cfg¶
Specification Value Type object notif-enable
Description Interface lldp notification enable
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
notification
Description Interface lldp notification configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
management_lldp_tx-tlvs-cfg¶
Specification Value Type object exclude
Description Configure which TLVs excluded. All basic TLVs will be included by default
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
management-address
Description Interface lldp management address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-description
Description Interface lldp port description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
system-capabilities
Description Interface lldp system capabilities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
system-description
Description Interface lldp system description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
system-name
Description Interface lldp system name
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tx-tlvs
Description Interface lldp tx TLVs configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
management_lldp_enable-cfg¶
Specification Value Type object rt-enable
Description Interface lldp enable/disable
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rx
Description Enable lldp rx
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tx
Description Enable lldp tx
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
management_broadcast-rate-limit¶
Specification Value Type object bcast-rate-limit-enable
Description Rate limit the l2 broadcast packet on mgmt port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rate
Description packets per second. Default is 500. (packets per second. Please specify an even number. Default is 500)
Type: number
Range: 50-5000
Default: 500
management_ipv6¶
Specification Value Type list Block object keys address-type
Description ‘link-local’: Configure an IPv6 link local address;
Type: string
Supported Values: link-local
default-ipv6-gateway
Description Set default gateway (Default gateway address)
Type: string
Format: ipv6-address
inbound
Description ACL applied on incoming packets to this interface
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
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
management_secondary-ip¶
Specification Value Type object control-apps-use-mgmt-port
Description Control applications use management port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
default-gateway
Description Set default gateway (Default gateway address)
Type: string
Format: ipv4-address
dhcp
Description Use DHCP to configure IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: dhcp and ipv4-address are mutually exclusive
ipv4-address
Description IP address
Type: string
Format: ipv4-address
Mutual Exclusion: ipv4-address and dhcp are mutually exclusive
ipv4-netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask
secondary-ip
Description Global IP configuration subcommands
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
management_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘packets_input’: Input packets; ‘bytes_input’: Input bytes; ‘received_broadcasts’: Received broadcasts; ‘received_multicasts’: Received multicasts; ‘received_unicasts’: Received unicasts; ‘input_errors’: Input errors; ‘crc’: CRC; ‘frame’: Frames; ‘input_err_short’: Runts; ‘input_err_long’: Giants; ‘packets_output’: Output packets; ‘bytes_output’: Output bytes; ‘transmitted_broadcasts’: Transmitted broadcasts; ‘transmitted_multicasts’: Transmitted multicasts; ‘transmitted_unicasts’: Transmitted unicasts; ‘output_errors’: Output errors; ‘collisions’: Collisions;
Type: string
Supported Values: all, packets_input, bytes_input, received_broadcasts, received_multicasts, received_unicasts, input_errors, crc, frame, input_err_short, input_err_long, packets_output, bytes_output, transmitted_broadcasts, transmitted_multicasts, transmitted_unicasts, output_errors, collisions
management_ip¶
Specification Value Type object control-apps-use-mgmt-port
Description Control applications use management port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
default-gateway
Description Set default gateway (Default gateway address)
Type: string
Format: ipv4-address
dhcp
Description Use DHCP to configure IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: dhcp and ipv4-address are mutually exclusive
ipv4-address
Description IP address
Type: string
Format: ipv4-address
Mutual Exclusion: ipv4-address and dhcp are mutually exclusive
ipv4-netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask
management_access-list¶
Specification Value Type object acl-id
Description ACL id
Type: number
Range: 1-199
acl-name
Description Apply an access list (Named Access List)
Type: string
Maximum Length: 16 characters
Maximum Length: 1 characters
packet-size-bucket¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-list¶
Specification Value Type list Block object keys access-list
Description: access-list is a JSON Block. Please see below for trunk-list_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 trunk-list_bfd
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/bfd
ddos
Description: ddos is a JSON Block. Please see below for trunk-list_ddos
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ddos
do-auto-recovery
Description (Only for LACP trunks) Attempt auto-recovery after ports-treshold is triggered
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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 trunk-list_icmp-rate-limit
Type: Object
icmpv6-rate-limit
Description: icmpv6-rate-limit is a JSON Block. Please see below for trunk-list_icmpv6-rate-limit
Type: Object
ifnum
Description Trunk interface number
Type: number
Range: 1-4096
ip
Description: ip is a JSON Block. Please see below for trunk-list_ip
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip
ipv6
Description: ipv6 is a JSON Block. Please see below for trunk-list_ipv6
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ipv6
isis
Description: isis is a JSON Block. Please see below for trunk-list_isis
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/isis
l3-vlan-fwd-disable
Description Disable L3 forwarding between VLANs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lw-4o6
Description: lw-4o6 is a JSON Block. Please see below for trunk-list_lw-4o6
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/lw-4o6
mac-learning
Description ‘enable’: Enable MAC learning; ‘disable’: Disable MAC learning; ‘dmac-only’: Enable destination MAC learning only;
Type: string
Supported Values: enable, disable, dmac-only
map
Description: map is a JSON Block. Please see below for trunk-list_map
Type: Object
Reference Object: /axapi/v3/interface/trunk/{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 trunk-list_nptv6
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/nptv6
ports-threshold
Description Threshold for the minimum number of ports that need to be UP for the trunk to remain UP
Type: number
sampling-enable
Type: Listspanning-tree
Description: spanning-tree is a JSON Block. Please see below for trunk-list_spanning-tree
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/spanning-tree
sync-modify-disable
Description Disable SYNC bit modify for ports-threshold do-auto-recovery
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
timer
Description Timer to re-check the threshold under certain conditions (Time in seconds (Default: 10))
Type: number
Range: 1-300
Default: 10
trap-source
Description The trap source
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
update-l2-info
Description Update and use received L2 information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-hw-hash
Description Enable HW based load balacing decision rule
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
virtual-wire
Description Mark trunk as a virtual wire interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vlan-learning
Description ‘enable’: Enable VLAN learning; ‘disable’: Disable VLAN learning;
Type: string
Supported Values: enable, disable
trunk-list_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
trunk-list_ip¶
Specification Value Type object address-list
Type: Listallow-promiscuous-vip
Description Allow traffic to be associated with promiscuous VIP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cache-spoofing-port
Description This interface connects to spoofing cache
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: Listmax-resp-time
Description Maximum Response Time (Max Response Time (Default is 100))
Type: number
Range: 1-255
Default: 100
nat
Description: nat is a JSON Block. Please see below for trunk-list_ip_nat
Type: Object
ospf
Description: ospf is a JSON Block. Please see below for trunk-list_ip_ospf
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/ospf
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 trunk-list_ip_rip
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/rip
router
Description: router is a JSON Block. Please see below for trunk-list_ip_router
Type: Object
Reference Object: /axapi/v3/interface/trunk/{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 trunk-list_ip_stateful-firewall
Type: Object
Reference Object: /axapi/v3/interface/trunk/{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
trunk-list_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
trunk-list_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
trunk-list_ip_rip¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for trunk-list_ip_rip_authentication
Type: Object
receive-cfg
Description: receive-cfg is a JSON Block. Please see below for trunk-list_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 trunk-list_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 trunk-list_ip_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-list_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
trunk-list_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
trunk-list_ip_rip_authentication¶
Specification Value Type object key-chain
Description: key-chain is a JSON Block. Please see below for trunk-list_ip_rip_authentication_key-chain
Type: Object
mode
Description: mode is a JSON Block. Please see below for trunk-list_ip_rip_authentication_mode
Type: Object
str
Description: str is a JSON Block. Please see below for trunk-list_ip_rip_authentication_str
Type: Object
trunk-list_ip_rip_authentication_key-chain¶
Specification Value Type object key-chain
Description Authentication key-chain (Name of key-chain)
Type: string
Format: string-rlx
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_ip_nat¶
Specification Value Type object inside
Description Configure interface as inside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
outside
Description Configure interface as outside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
trunk-list_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
trunk-list_ip_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for trunk-list_ip_router_isis
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/router/isis
trunk-list_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
trunk-list_ip_ospf¶
Specification Value Type object ospf-global
Description: ospf-global is a JSON Block. Please see below for trunk-list_ip_ospf_ospf-global
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/ospf/ospf-global
ospf-ip-list
Type: List
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/ospf/ospf-ip/{ip-addr}
trunk-list_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: Listmtu-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
trunk-list_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
trunk-list_ip_ospf_ospf-global¶
Specification Value Type object authentication-cfg
Description: authentication-cfg is a JSON Block. Please see below for trunk-list_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 trunk-list_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 trunk-list_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: Listmtu
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 trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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 trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_access-list¶
Specification Value Type object acl-id
Description ACL id
Type: number
Range: 1-199
acl-name
Description Apply an access list (Named Access List)
Type: string
Maximum Length: 16 characters
Maximum Length: 1 characters
trunk-list_bfd¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for trunk-list_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 trunk-list_bfd_interval-cfg
Type: Object
per-member-port
Description: per-member-port is a JSON Block. Please see below for trunk-list_bfd_per-member-port
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/bfd/per-member-port
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-list_bfd_per-member-port¶
Specification Value Type object ipv6-local
Description IPv6 local-address
Type: string
Format: ipv6-address
ipv6-nbr
Description IPv6 neighbor-address
Type: string
Format: ipv6-address
local-address
Description IPv4 local-address
Type: string
Format: ipv4-address
neighbor-address
Description IPv4 neighbor address
Type: string
Format: ipv4-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-list_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
trunk-list_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
trunk-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘num_pkts’: some help string; ‘num_total_bytes’: some help string; ‘num_unicast_pkts’: some help string; ‘num_broadcast_pkts’: some help string; ‘num_multicast_pkts’: some help string; ‘num_tx_pkts’: some help string; ‘num_total_tx_bytes’: some help string; ‘num_unicast_tx_pkts’: some help string; ‘num_broadcast_tx_pkts’: some help string; ‘num_multicast_tx_pkts’: some help string; ‘dropped_dis_rx_pkts’: some help string; ‘dropped_rx_pkts’: some help string; ‘dropped_dis_tx_pkts’: some help string; ‘dropped_tx_pkts’: some help string;
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, dropped_dis_rx_pkts, dropped_rx_pkts, dropped_dis_tx_pkts, dropped_tx_pkts
trunk-list_ipv6¶
Specification Value Type object access-list-cfg
Description: access-list-cfg is a JSON Block. Please see below for trunk-list_ipv6_access-list-cfg
Type: Object
address-list
Type: Listipv6-enable
Description Enable IPv6 processing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
nat
Description: nat is a JSON Block. Please see below for trunk-list_ipv6_nat
Type: Object
ospf
Description: ospf is a JSON Block. Please see below for trunk-list_ipv6_ospf
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ipv6/ospf
rip
Description: rip is a JSON Block. Please see below for trunk-list_ipv6_rip
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ipv6/rip
router
Description: router is a JSON Block. Please see below for trunk-list_ipv6_router
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ipv6/router
router-adver
Description: router-adver is a JSON Block. Please see below for trunk-list_ipv6_router-adver
Type: Object
stateful-firewall
Description: stateful-firewall is a JSON Block. Please see below for trunk-list_ipv6_stateful-firewall
Type: Object
Reference Object: /axapi/v3/interface/trunk/{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
trunk-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
trunk-list_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
default-lifetime
Description Set Router Advertisement Default Lifetime (default: 1800) (Default Lifetime (seconds))
Type: number
Range: 0-9000
Default: 1800
hop-limit
Description Set Router Advertisement Hop Limit (default: 255) (Max Router Advertisement Interval (seconds))
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) (Min Router Advertisement Interval (seconds))
Type: number
Range: 4-1800
Default: 600
min-interval
Description Set Router Advertisement Min Interval (default: 200) (Max Number of Router Solicitations to process per second)
Type: number
Range: 3-1350
Default: 200
mtu
Description: mtu is a JSON Block. Please see below for trunk-list_ipv6_router-adver_mtu
Type: Object
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: Listrate-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
vrid
Description: vrid is a JSON Block. Please see below for trunk-list_ipv6_router-adver_vrid
Type: Object
trunk-list_ipv6_router-adver_vrid¶
Specification Value Type object adver-vrid
Description Specify ha VRRP-A 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
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
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
trunk-list_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
trunk-list_ipv6_router-adver_mtu¶
Specification Value Type object 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
trunk-list_ipv6_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for trunk-list_ipv6_router_isis
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ipv6/router/isis
ospf
Description: ospf is a JSON Block. Please see below for trunk-list_ipv6_router_ospf
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ipv6/router/ospf
ripng
Description: ripng is a JSON Block. Please see below for trunk-list_ipv6_router_ripng
Type: Object
Reference Object: /axapi/v3/interface/trunk/{ifnum}/ipv6/router/ripng
trunk-list_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
trunk-list_ipv6_router_ospf¶
Specification Value Type object area-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-list_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
trunk-list_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
trunk-list_ipv6_rip¶
Specification Value Type object split-horizon-cfg
Description: split-horizon-cfg is a JSON Block. Please see below for trunk-list_ipv6_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-list_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
trunk-list_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
trunk-list_ipv6_nat¶
Specification Value Type object inside
Description Configure interface as NAT inside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
outside
Description Configure interface as NAT outside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
trunk-list_ipv6_access-list-cfg¶
Specification Value Type object inbound
Description ACL applied on incoming packets to this interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
trunk-list_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: Listdead-interval-cfg
Type: Listdisable
Description Disable BFD
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hello-interval-cfg
Type: Listmtu-ignore-cfg
Type: Listneighbor-cfg
Type: Listnetwork-list
Type: Listpriority-cfg
Type: Listretransmit-interval-cfg
Type: Listtransmit-delay-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_spanning-tree¶
Specification Value Type object admin-edge
Description Enable admin-edge
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auto-edge
Description Enable auto-edge
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
instance-list
Type: Listpath-cost
Description Path cost (Limit)
Type: number
Range: 1-200000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-list_spanning-tree_instance-list¶
Specification Value Type list Block object keys instance-start
Description Instance ID
Type: number
Range: 0-4094
mstp-path-cost
Description Path cost (Limit)
Type: number
Range: 1-200000
trunk-list_nptv6¶
Specification Value Type object domain-list
Type: List
Reference Object: /axapi/v3/interface/trunk/{ifnum}/nptv6/domain/{domain-name}+{bind-type}
trunk-list_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
trunk-list_isis¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for trunk-list_isis_authentication
Type: Object
bfd-cfg
Description: bfd-cfg is a JSON Block. Please see below for trunk-list_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: Listhello-interval-list
Type: Listhello-interval-minimal-list
Type: Listhello-multiplier-list
Type: Listlsp-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 trunk-list_isis_mesh-group
Type: Object
metric-list
Type: Listnetwork
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: Listpriority-list
Type: Listretransmit-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
trunk-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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_isis_authentication¶
Specification Value Type object key-chain-list
Type: Listmode-list
Type: Listsend-only-list
Type: List
trunk-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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
trunk-list_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
available-eth-list¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list¶
Specification Value Type list Block object keys access-list
Description: access-list is a JSON Block. Please see below for ve-list_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 ve-list_bfd
Type: Object
Reference Object: /axapi/v3/interface/ve/{ifnum}/bfd
ddos
Description: ddos is a JSON Block. Please see below for ve-list_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 ve-list_icmp-rate-limit
Type: Object
icmpv6-rate-limit
Description: icmpv6-rate-limit is a JSON Block. Please see below for ve-list_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 ve-list_ip
Type: Object
Reference Object: /axapi/v3/interface/ve/{ifnum}/ip
ipv6
Description: ipv6 is a JSON Block. Please see below for ve-list_ipv6
Type: Object
Reference Object: /axapi/v3/interface/ve/{ifnum}/ipv6
isis
Description: isis is a JSON Block. Please see below for ve-list_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 ve-list_lw-4o6
Type: Object
Reference Object: /axapi/v3/interface/ve/{ifnum}/lw-4o6
map
Description: map is a JSON Block. Please see below for ve-list_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 ve-list_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: Listtrap-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
ve-list_ip¶
Specification Value Type object address-list
Type: Listallow-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: Listinside
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 ve-list_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 ve-list_ip_rip
Type: Object
Reference Object: /axapi/v3/interface/ve/{ifnum}/ip/rip
router
Description: router is a JSON Block. Please see below for ve-list_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 ve-list_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
ve-list_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
ve-list_ip_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for ve-list_ip_router_isis
Type: Object
Reference Object: /axapi/v3/interface/ve/{ifnum}/ip/router/isis
ve-list_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
ve-list_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
ve-list_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
ve-list_ip_rip¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for ve-list_ip_rip_authentication
Type: Object
receive-cfg
Description: receive-cfg is a JSON Block. Please see below for ve-list_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 ve-list_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 ve-list_ip_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list_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
ve-list_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
ve-list_ip_rip_authentication¶
Specification Value Type object key-chain
Description: key-chain is a JSON Block. Please see below for ve-list_ip_rip_authentication_key-chain
Type: Object
mode
Description: mode is a JSON Block. Please see below for ve-list_ip_rip_authentication_mode
Type: Object
str
Description: str is a JSON Block. Please see below for ve-list_ip_rip_authentication_str
Type: Object
ve-list_ip_rip_authentication_key-chain¶
Specification Value Type object key-chain
Description Authentication key-chain (Name of key-chain)
Type: string
Format: string-rlx
ve-list_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
ve-list_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
ve-list_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
ve-list_ip_ospf¶
Specification Value Type object ospf-global
Description: ospf-global is a JSON Block. Please see below for ve-list_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}
ve-list_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: Listmtu-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
ve-list_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
ve-list_ip_ospf_ospf-global¶
Specification Value Type object authentication-cfg
Description: authentication-cfg is a JSON Block. Please see below for ve-list_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 ve-list_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 ve-list_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: Listmtu
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 ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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 ve-list_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
ve-list_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
ve-list_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
ve-list_access-list¶
Specification Value Type object acl-id
Description ACL id
Type: number
Range: 1-199
acl-name
Description Named Access List
Type: string
Maximum Length: 16 characters
Maximum Length: 1 characters
ve-list_bfd¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for ve-list_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 ve-list_bfd_interval-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list_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
ve-list_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
ve-list_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
ve-list_ipv6¶
Specification Value Type object address-list
Type: Listinbound
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 ve-list_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 ve-list_ipv6_rip
Type: Object
Reference Object: /axapi/v3/interface/ve/{ifnum}/ipv6/rip
router
Description: router is a JSON Block. Please see below for ve-list_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 ve-list_ipv6_router-adver
Type: Object
stateful-firewall
Description: stateful-firewall is a JSON Block. Please see below for ve-list_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
ve-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
ve-list_ipv6_rip¶
Specification Value Type object split-horizon-cfg
Description: split-horizon-cfg is a JSON Block. Please see below for ve-list_ipv6_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list_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
ve-list_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
ve-list_ipv6_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for ve-list_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 ve-list_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 ve-list_ipv6_router_ripng
Type: Object
Reference Object: /axapi/v3/interface/ve/{ifnum}/ipv6/router/ripng
ve-list_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
ve-list_ipv6_router_ospf¶
Specification Value Type object area-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list_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
ve-list_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
ve-list_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: Listdead-interval-cfg
Type: Listdisable
Description Disable BFD
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hello-interval-cfg
Type: Listmtu-ignore-cfg
Type: Listneighbor-cfg
Type: Listnetwork-list
Type: Listpriority-cfg
Type: Listretransmit-interval-cfg
Type: Listtransmit-delay-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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: Listrate-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
ve-list_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
ve-list_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
ve-list_nptv6¶
Specification Value Type object domain-list
Type: List
Reference Object: /axapi/v3/interface/ve/{ifnum}/nptv6/domain/{domain-name}+{bind-type}
ve-list_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
ve-list_isis¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for ve-list_isis_authentication
Type: Object
bfd-cfg
Description: bfd-cfg is a JSON Block. Please see below for ve-list_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: Listhello-interval-list
Type: Listhello-interval-minimal-list
Type: Listhello-multiplier-list
Type: Listlsp-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 ve-list_isis_mesh-group
Type: Object
metric-list
Type: Listnetwork
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: Listpriority-list
Type: Listretransmit-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
ve-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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_isis_authentication¶
Specification Value Type object key-chain-list
Type: Listmode-list
Type: Listsend-only-list
Type: List
ve-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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
ve-list_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
brief¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ethernet-list¶
Specification Value Type list Block object keys access-list
Description: access-list is a JSON Block. Please see below for ethernet-list_access-list
Type: Object
action
Description ‘enable’: Enable; ‘disable’: Disable;
Type: string
Supported Values: enable, disable
Default: disable
auto-neg-enable
Description enable auto-negotiation
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
bfd
Description: bfd is a JSON Block. Please see below for ethernet-list_bfd
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/bfd
cpu-process
Description All Packets to this port are processed by CPU
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cpu-process-dir
Description ‘primary’: Primary board; ‘blade’: blade board; ‘hash-dip’: Hash based on the Destination IP; ‘hash-sip’: Hash based on the Source IP; ‘hash-dmac’: Hash based on the Destination MAC; ‘hash-smac’: Hash based on the Source MAC;
Type: string
Supported Values: primary, blade, hash-dip, hash-sip, hash-dmac, hash-smac
ddos
Description: ddos is a JSON Block. Please see below for ethernet-list_ddos
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ddos
duplexity
Description ‘Full’: Full; ‘Half’: Half; ‘auto’: auto;
Type: string
Supported Values: Full, Half, auto
Default: auto
fec-forced-off
Description turn off the FEC
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: fec-forced-off and fec-forced-on are mutually exclusive
fec-forced-on
Description turn on the FEC
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: fec-forced-on and fec-forced-off are mutually exclusive
flow-control
Description Enable 802.3x flow control on full duplex port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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 ethernet-list_icmp-rate-limit
Type: Object
icmpv6-rate-limit
Description: icmpv6-rate-limit is a JSON Block. Please see below for ethernet-list_icmpv6-rate-limit
Type: Object
ifnum
Description Ethernet interface number
Type: number
Format: interface
ip
Description: ip is a JSON Block. Please see below for ethernet-list_ip
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ip
ipg-bit-time
Description Set Inter-packet-gap interval in bit timing, default is 96
Type: number
Range: 64-120
Default: 96
ipv6
Description: ipv6 is a JSON Block. Please see below for ethernet-list_ipv6
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ipv6
isis
Description: isis is a JSON Block. Please see below for ethernet-list_isis
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/isis
l3-vlan-fwd-disable
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lldp
Description: lldp is a JSON Block. Please see below for ethernet-list_lldp
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/lldp
load-interval
Description Configure Load Interval (Seconds (5-300, Multiple of 5), default 300)
Type: number
Range: 5-300
Default: 300
lw-4o6
Description: lw-4o6 is a JSON Block. Please see below for ethernet-list_lw-4o6
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/lw-4o6
mac-learning
Description ‘enable’: Enable MAC learning; ‘disable’: Disable MAC learning; ‘dmac-only’: Enable destination MAC learning only;
Type: string
Supported Values: enable, disable, dmac-only
map
Description: map is a JSON Block. Please see below for ethernet-list_map
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/map
media-type-copper
Description Set the media type to copper
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-list
Type: Listmtu
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 ethernet-list_nptv6
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/nptv6
packet-capture-template
Description Name of the packet capture template to be bind with this object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/packet-capture/object-templates/interface-ethernet-tmpl
ping-sweep-detection
Description ‘enable’: Enabl ping sweep detection; ‘disable’: Disable ping sweep detection(default);
Type: string
Supported Values: enable, disable
Default: disable
port-breakout
Description ‘4x10G’: Breakout 100G/40G ports into 4x10G ports; ‘4x25G’: Breakout 100G ports into 4x25G ports; ‘2x50G’: Breakout 100G ports into 2x50G ports;
Type: string
Supported Values: 4x10G, 4x25G, 2x50G
port-scan-detection
Description ‘enable’: Enable port scan detection; ‘disable’: Disable port scan detection(default);
Type: string
Supported Values: enable, disable
Default: disable
remove-vlan-tag
Description Remove the vlan tag for egressing packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sampling-enable
Type: Listspanning-tree
Description: spanning-tree is a JSON Block. Please see below for ethernet-list_spanning-tree
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/spanning-tree
speed
Description ‘10’: 10; ‘100’: 100; ‘1000’: 1000; ‘auto’: auto;
Type: string
Supported Values: 10, 100, 1000, auto
Default: auto
speed-forced-10g
Description force the speed to be 10G on 25G link
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: speed-forced-10g and speed-forced-1g are mutually exclusive
speed-forced-1g
Description force the speed to be 1G on 25G link
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: speed-forced-1g and speed-forced-10g are mutually exclusive
speed-forced-40g
Description force the speed to be 40G on 100G link
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
traffic-distribution-mode
Description ‘sip’: sip; ‘dip’: dip; ‘primary’: primary; ‘blade’: blade; ‘l4-src-port’: l4-src-port; ‘l4-dst-port’: l4-dst-port;
Type: string
Supported Values: sip, dip, primary, blade, l4-src-port, l4-dst-port
trap-source
Description The trap source
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
trunk-group-list
Type: List
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/trunk-group/{trunk-number}
update-l2-info
Description Update and use received L2 information
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
virtual-wire
Description Mark ethernet as a virtual wire interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vlan-learning
Description ‘enable’: Enable VLAN learning; ‘disable’: Disable VLAN learning;
Type: string
Supported Values: enable, disable
ethernet-list_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
ethernet-list_ip¶
Specification Value Type object address-list
Type: Listallow-promiscuous-vip
Description Allow traffic to be associated with promiscuous VIP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cache-spoofing-port
Description This interface connects to spoofing cache
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: Listinside
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 ethernet-list_ip_ospf
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{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 ethernet-list_ip_rip
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ip/rip
router
Description: router is a JSON Block. Please see below for ethernet-list_ip_router
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{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 ethernet-list_ip_stateful-firewall
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ip/stateful-firewall
syn-cookie
Description Configure 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 before sending out
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
ethernet-list_ip_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for ethernet-list_ip_router_isis
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ip/router/isis
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_ip_rip¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for ethernet-list_ip_rip_authentication
Type: Object
receive-cfg
Description: receive-cfg is a JSON Block. Please see below for ethernet-list_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 ethernet-list_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 ethernet-list_ip_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ethernet-list_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
ethernet-list_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
ethernet-list_ip_rip_authentication¶
Specification Value Type object key-chain
Description: key-chain is a JSON Block. Please see below for ethernet-list_ip_rip_authentication_key-chain
Type: Object
mode
Description: mode is a JSON Block. Please see below for ethernet-list_ip_rip_authentication_mode
Type: Object
str
Description: str is a JSON Block. Please see below for ethernet-list_ip_rip_authentication_str
Type: Object
ethernet-list_ip_rip_authentication_key-chain¶
Specification Value Type object key-chain
Description Authentication key-chain (Name of key-chain)
Type: string
Format: string-rlx
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_ip_ospf¶
Specification Value Type object ospf-global
Description: ospf-global is a JSON Block. Please see below for ethernet-list_ip_ospf_ospf-global
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ip/ospf/ospf-global
ospf-ip-list
Type: List
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ip/ospf/ospf-ip/{ip-addr}
ethernet-list_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: Listmtu-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
ethernet-list_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
ethernet-list_ip_ospf_ospf-global¶
Specification Value Type object authentication-cfg
Description: authentication-cfg is a JSON Block. Please see below for ethernet-list_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 ethernet-list_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 ethernet-list_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: Listmtu
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 ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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 ethernet-list_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
ethernet-list_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
ethernet-list_ddos¶
Specification Value Type object inside
Description DDoS inside (trusted) interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
outside
Description DDoS 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
ethernet-list_access-list¶
Specification Value Type object acl-id
Description ACL id
Type: number
Range: 1-199
acl-name
Description Apply an access list (Named Access List)
Type: string
Maximum Length: 16 characters
Maximum Length: 1 characters
ethernet-list_bfd¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for ethernet-list_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 ethernet-list_bfd_interval-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ethernet-list_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
ethernet-list_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
ethernet-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘packets_input’: Input packets; ‘bytes_input’: Input bytes; ‘received_broadcasts’: Received broadcasts; ‘received_multicasts’: Received multicasts; ‘received_unicasts’: Received unicasts; ‘input_errors’: Input errors; ‘crc’: CRC; ‘frame’: Frames; ‘runts’: Runts; ‘giants’: Giants; ‘packets_output’: Output packets; ‘bytes_output’: Output bytes; ‘transmitted_broadcasts’: Transmitted broadcasts; ‘transmitted_multicasts’: Transmitted multicasts; ‘transmitted_unicasts’: Transmitted unicasts; ‘output_errors’: Output errors; ‘collisions’: Collisions; ‘giants_output’: Output Giants; ‘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; ‘drops’: Drops;
Type: string
Supported Values: all, packets_input, bytes_input, received_broadcasts, received_multicasts, received_unicasts, input_errors, crc, frame, runts, giants, packets_output, bytes_output, transmitted_broadcasts, transmitted_multicasts, transmitted_unicasts, output_errors, collisions, giants_output, rate_pkt_sent, rate_byte_sent, rate_pkt_rcvd, rate_byte_rcvd, load_interval, drops, input_utilization, output_utilization
ethernet-list_monitor-list¶
Specification Value Type list Block object keys mirror-index
monitor
Description ‘input’: Incoming packets; ‘output’: Outgoing packets; ‘both’: Both incoming and outgoing packets;
Type: string
Supported Values: input, output, both
monitor-vlan
Description VLAN number
Type: number
Range: 2-4094
ethernet-list_spanning-tree¶
Specification Value Type object admin-edge
Description Enable admin-edge
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auto-edge
Description Enable auto-edge
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
instance-list
Type: Listpath-cost
Description Path cost (Limit)
Type: number
Range: 1-200000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ethernet-list_spanning-tree_instance-list¶
Specification Value Type list Block object keys instance-start
Description Instance ID
Type: number
Range: 0-4094
mstp-path-cost
Description Path cost (Limit)
Type: number
Range: 1-200000
ethernet-list_lldp¶
Specification Value Type object enable-cfg
Description: enable-cfg is a JSON Block. Please see below for ethernet-list_lldp_enable-cfg
Type: Object
notification-cfg
Description: notification-cfg is a JSON Block. Please see below for ethernet-list_lldp_notification-cfg
Type: Object
tx-dot1-cfg
Description: tx-dot1-cfg is a JSON Block. Please see below for ethernet-list_lldp_tx-dot1-cfg
Type: Object
tx-tlvs-cfg
Description: tx-tlvs-cfg is a JSON Block. Please see below for ethernet-list_lldp_tx-tlvs-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ethernet-list_lldp_tx-dot1-cfg¶
Specification Value Type object link-aggregation
Description Interface link aggregation information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tx-dot1-tlvs
Description Interface lldp tx IEEE 802.1 Organizationally specific TLVs configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vlan
Description Interface vlan information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ethernet-list_lldp_notification-cfg¶
Specification Value Type object notif-enable
Description Interface lldp notification enable
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
notification
Description Interface lldp notification configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ethernet-list_lldp_tx-tlvs-cfg¶
Specification Value Type object exclude
Description Configure which TLVs excluded. All basic TLVs will be included by default
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
management-address
Description Interface lldp management address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-description
Description Interface lldp port description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
system-capabilities
Description Interface lldp system capabilities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
system-description
Description Interface lldp system description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
system-name
Description Interface lldp system name
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tx-tlvs
Description Interface lldp tx TLVs configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ethernet-list_lldp_enable-cfg¶
Specification Value Type object rt-enable
Description Interface lldp enable/disable
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rx
Description Enable lldp rx
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tx
Description Enable lldp tx
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ethernet-list_trunk-group-list¶
Specification Value Type list Block object keys admin-key
Description LACP admin key (Admin key value)
Type: number
Range: 10000-65535
mode
Description ‘active’: enable initiation of LACP negotiation on a port(default); ‘passive’: disable initiation of LACP negotiation on a port;
Type: string
Supported Values: active, passive
Default: active
port-priority
Description Set LACP priority for a port (LACP port priority)
Type: number
Range: 1-65535
timeout
Description ‘long’: Set LACP long timeout (default); ‘short’: Set LACP short timeout;
Type: string
Supported Values: long, short
Default: long
trunk-number
Description Trunk Number
Type: number
Range: 1-4096
type
Description ‘static’: Static (default); ‘lacp’: lacp; ‘lacp-udld’: lacp-udld;
Type: string
Supported Values: static, lacp, lacp-udld
Default: static
udld-timeout-cfg
Description: udld-timeout-cfg is a JSON Block. Please see below for ethernet-list_trunk-group-list_udld-timeout-cfg
Type: Object
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
ethernet-list_trunk-group-list_udld-timeout-cfg¶
Specification Value Type object fast
Description fast timeout in unit of milli-seconds(default 1000)
Type: number
Range: 100-1000
Default: 1000
Mutual Exclusion: fast and slow are mutually exclusive
slow
Description slow timeout in unit of seconds
Type: number
Range: 1-60
Mutual Exclusion: slow and fast are mutually exclusive
ethernet-list_nptv6¶
Specification Value Type object domain-list
Type: List
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/nptv6/domain/{domain-name}+{bind-type}
ethernet-list_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
ethernet-list_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
ethernet-list_isis¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for ethernet-list_isis_authentication
Type: Object
bfd-cfg
Description: bfd-cfg is a JSON Block. Please see below for ethernet-list_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: Listhello-interval-list
Type: Listhello-interval-minimal-list
Type: Listhello-multiplier-list
Type: Listlsp-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 ethernet-list_isis_mesh-group
Type: Object
metric-list
Type: Listnetwork
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: Listpriority-list
Type: Listretransmit-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
ethernet-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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_isis_authentication¶
Specification Value Type object key-chain-list
Type: Listmode-list
Type: Listsend-only-list
Type: List
ethernet-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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_ipv6¶
Specification Value Type object access-list-cfg
Description: access-list-cfg is a JSON Block. Please see below for ethernet-list_ipv6_access-list-cfg
Type: Object
address-list
Type: Listinside
Description Configure interface as inside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6-enable
Description Enable IPv6 processing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ospf
Description: ospf is a JSON Block. Please see below for ethernet-list_ipv6_ospf
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ipv6/ospf
outside
Description Configure interface as outside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rip
Description: rip is a JSON Block. Please see below for ethernet-list_ipv6_rip
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ipv6/rip
router
Description: router is a JSON Block. Please see below for ethernet-list_ipv6_router
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ipv6/router
router-adver
Description: router-adver is a JSON Block. Please see below for ethernet-list_ipv6_router-adver
Type: Object
stateful-firewall
Description: stateful-firewall is a JSON Block. Please see below for ethernet-list_ipv6_stateful-firewall
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ipv6/stateful-firewall
ttl-ignore
Description Ignore TTL decrement for a received packet before sending out
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
ethernet-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
ethernet-list_ipv6_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for ethernet-list_ipv6_router_isis
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ipv6/router/isis
ospf
Description: ospf is a JSON Block. Please see below for ethernet-list_ipv6_router_ospf
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ipv6/router/ospf
ripng
Description: ripng is a JSON Block. Please see below for ethernet-list_ipv6_router_ripng
Type: Object
Reference Object: /axapi/v3/interface/ethernet/{ifnum}/ipv6/router/ripng
ethernet-list_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
ethernet-list_ipv6_router_ospf¶
Specification Value Type object area-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ethernet-list_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
ethernet-list_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
ethernet-list_ipv6_rip¶
Specification Value Type object split-horizon-cfg
Description: split-horizon-cfg is a JSON Block. Please see below for ethernet-list_ipv6_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ethernet-list_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
ethernet-list_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
ethernet-list_ipv6_access-list-cfg¶
Specification Value Type object inbound
Description ACL applied on incoming packets to this interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
ethernet-list_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: Listdead-interval-cfg
Type: Listdisable
Description Disable BFD
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hello-interval-cfg
Type: Listmtu-ignore-cfg
Type: Listneighbor-cfg
Type: Listnetwork-list
Type: Listpriority-cfg
Type: Listretransmit-interval-cfg
Type: Listtransmit-delay-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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
ethernet-list_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 Specify ha VRRP-A 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: Listrate-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
ethernet-list_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
ethernet-list_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
switch-drop-reason¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
common¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lif-list¶
Specification Value Type list Block object keys access-list
Description: access-list is a JSON Block. Please see below for lif-list_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 lif-list_bfd
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/bfd
encapsulation
Description: encapsulation is a JSON Block. Please see below for lif-list_encapsulation
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/encapsulation
ifname
Description Lif interface name
Type: string
Maximum Length: 15 characters
Maximum Length: 1 characters
ip
Description: ip is a JSON Block. Please see below for lif-list_ip
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ip
ipv6
Description: ipv6 is a JSON Block. Please see below for lif-list_ipv6
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ipv6
isis
Description: isis is a JSON Block. Please see below for lif-list_isis
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/isis
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
sampling-enable
Type: Listuser-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
lif-list_isis¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for lif-list_isis_authentication
Type: Object
bfd-cfg
Description: bfd-cfg is a JSON Block. Please see below for lif-list_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: Listhello-interval-list
Type: Listhello-interval-minimal-list
Type: Listhello-multiplier-list
Type: Listlsp-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 lif-list_isis_mesh-group
Type: Object
metric-list
Type: Listnetwork
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: Listpriority-list
Type: Listretransmit-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
lif-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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_isis_authentication¶
Specification Value Type object key-chain-list
Type: Listmode-list
Type: Listsend-only-list
Type: List
lif-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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_bfd¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for lif-list_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 lif-list_bfd_interval-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lif-list_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
lif-list_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
lif-list_ip¶
Specification Value Type object address-list
Type: Listallow-promiscuous-vip
Description Allow traffic to be associated with promiscuous VIP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cache-spoofing-port
Description This interface connects to spoofing cache
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
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 lif-list_ip_ospf
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/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 lif-list_ip_rip
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ip/rip
router
Description: router is a JSON Block. Please see below for lif-list_ip_router
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ip/router
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
lif-list_ip_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for lif-list_ip_router_isis
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ip/router/isis
lif-list_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
lif-list_ip_rip¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for lif-list_ip_rip_authentication
Type: Object
receive-cfg
Description: receive-cfg is a JSON Block. Please see below for lif-list_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 lif-list_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 lif-list_ip_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lif-list_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
lif-list_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
lif-list_ip_rip_authentication¶
Specification Value Type object key-chain
Description: key-chain is a JSON Block. Please see below for lif-list_ip_rip_authentication_key-chain
Type: Object
mode
Description: mode is a JSON Block. Please see below for lif-list_ip_rip_authentication_mode
Type: Object
str
Description: str is a JSON Block. Please see below for lif-list_ip_rip_authentication_str
Type: Object
lif-list_ip_rip_authentication_key-chain¶
Specification Value Type object key-chain
Description Authentication key-chain (Name of key-chain)
Type: string
Format: string-rlx
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_ip_ospf¶
Specification Value Type object ospf-global
Description: ospf-global is a JSON Block. Please see below for lif-list_ip_ospf_ospf-global
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ip/ospf/ospf-global
ospf-ip-list
Type: List
Reference Object: /axapi/v3/interface/lif/{ifname}/ip/ospf/ospf-ip/{ip-addr}
lif-list_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: Listmtu-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
lif-list_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
lif-list_ip_ospf_ospf-global¶
Specification Value Type object authentication-cfg
Description: authentication-cfg is a JSON Block. Please see below for lif-list_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 lif-list_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 lif-list_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: Listmtu
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 lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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 lif-list_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
lif-list_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
lif-list_access-list¶
Specification Value Type object acl-id
Description ACL id
Type: number
Range: 1-199
acl-name
Description Apply an access list (Named Access List)
Type: string
Maximum Length: 16 characters
Maximum Length: 1 characters
lif-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘num_pkts’: some help string; ‘num_total_bytes’: some help string; ‘num_unicast_pkts’: some help string; ‘num_broadcast_pkts’: some help string; ‘num_multicast_pkts’: some help string; ‘num_tx_pkts’: some help string; ‘num_total_tx_bytes’: some help string; ‘num_unicast_tx_pkts’: some help string; ‘num_broadcast_tx_pkts’: some help string; ‘num_multicast_tx_pkts’: some help string; ‘dropped_dis_rx_pkts’: some help string; ‘dropped_rx_pkts’: some help string; ‘dropped_dis_tx_pkts’: some help string; ‘dropped_tx_pkts’: some help string; ‘dropped_rx_pkts_gre_key’: some help string;
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, dropped_dis_rx_pkts, dropped_rx_pkts, dropped_dis_tx_pkts, dropped_tx_pkts, dropped_rx_pkts_gre_key
lif-list_ipv6¶
Specification Value Type object address-list
Type: Listinside
Description Configure interface as inside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6-enable
Description Enable IPv6 processing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ospf
Description: ospf is a JSON Block. Please see below for lif-list_ipv6_ospf
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ipv6/ospf
outside
Description Configure interface as outside
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
router
Description: router is a JSON Block. Please see below for lif-list_ipv6_router
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ipv6/router
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lif-list_ipv6_address-list¶
Specification Value 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
lif-list_ipv6_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for lif-list_ipv6_router_isis
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ipv6/router/isis
ospf
Description: ospf is a JSON Block. Please see below for lif-list_ipv6_router_ospf
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ipv6/router/ospf
ripng
Description: ripng is a JSON Block. Please see below for lif-list_ipv6_router_ripng
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/ipv6/router/ripng
lif-list_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
lif-list_ipv6_router_ospf¶
Specification Value Type object area-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lif-list_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
lif-list_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
lif-list_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: Listdead-interval-cfg
Type: Listdisable
Description Disable BFD
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hello-interval-cfg
Type: Listmtu-ignore-cfg
Type: Listneighbor-cfg
Type: Listnetwork-list
Type: Listpriority-cfg
Type: Listretransmit-interval-cfg
Type: Listtransmit-delay-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_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
lif-list_encapsulation¶
Specification Value Type object dot1q
Description: dot1q is a JSON Block. Please see below for lif-list_encapsulation_dot1q
Type: Object
Reference Object: /axapi/v3/interface/lif/{ifname}/encapsulation/dot1q
lif-list_encapsulation_dot1q¶
Specification Value Type object ethernet
Description Ethernet Interface (Ethernet port number)
Type: number
Format: interface
Mutual Exclusion: ethernet and trunk are mutually exclusive
tag
Description Tag ID
Type: number
Range: 2-4094
trunk
Description Trunk Interface (Trunk number)
Type: number
Range: 1-4096
Mutual Exclusion: trunk and ethernet are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
driver-statistic¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
loopback-list¶
Specification Value Type list Block object keys ifnum
Description Loopback interface number
Type: number
Format: interface
ip
Description: ip is a JSON Block. Please see below for loopback-list_ip
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ip
ipv6
Description: ipv6 is a JSON Block. Please see below for loopback-list_ipv6
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6
isis
Description: isis is a JSON Block. Please see below for loopback-list_isis
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/isis
name
Description Name for the interface
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
snmp-server
Description: snmp-server is a JSON Block. Please see below for loopback-list_snmp-server
Type: Object
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
loopback-list_isis¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for loopback-list_isis_authentication
Type: Object
bfd-cfg
Description: bfd-cfg is a JSON Block. Please see below for loopback-list_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: Listhello-interval-list
Type: Listhello-interval-minimal-list
Type: Listhello-multiplier-list
Type: Listlsp-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 loopback-list_isis_mesh-group
Type: Object
metric-list
Type: Listpadding
Description Add padding to IS-IS hello packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
password-list
Type: Listpriority-list
Type: Listretransmit-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
loopback-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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_isis_authentication¶
Specification Value Type object key-chain-list
Type: Listmode-list
Type: Listsend-only-list
Type: List
loopback-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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_snmp-server¶
Specification Value Type object trap-source
Description The trap source
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
loopback-list_ip¶
Specification Value Type object address-list
Type: Listospf
Description: ospf is a JSON Block. Please see below for loopback-list_ip_ospf
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ip/ospf
rip
Description: rip is a JSON Block. Please see below for loopback-list_ip_rip
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ip/rip
router
Description: router is a JSON Block. Please see below for loopback-list_ip_router
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ip/router
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
loopback-list_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
loopback-list_ip_ospf¶
Specification Value Type object ospf-global
Description: ospf-global is a JSON Block. Please see below for loopback-list_ip_ospf_ospf-global
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ip/ospf/ospf-global
ospf-ip-list
Type: List
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ip/ospf/ospf-ip/{ip-addr}
loopback-list_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: Listmtu-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
loopback-list_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
loopback-list_ip_ospf_ospf-global¶
Specification Value Type object authentication-cfg
Description: authentication-cfg is a JSON Block. Please see below for loopback-list_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 loopback-list_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 loopback-list_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: Listmtu
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
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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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 loopback-list_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
loopback-list_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
loopback-list_ip_rip¶
Specification Value Type object authentication
Description: authentication is a JSON Block. Please see below for loopback-list_ip_rip_authentication
Type: Object
receive-cfg
Description: receive-cfg is a JSON Block. Please see below for loopback-list_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 loopback-list_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 loopback-list_ip_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
loopback-list_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
loopback-list_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
loopback-list_ip_rip_authentication¶
Specification Value Type object key-chain
Description: key-chain is a JSON Block. Please see below for loopback-list_ip_rip_authentication_key-chain
Type: Object
mode
Description: mode is a JSON Block. Please see below for loopback-list_ip_rip_authentication_mode
Type: Object
str
Description: str is a JSON Block. Please see below for loopback-list_ip_rip_authentication_str
Type: Object
loopback-list_ip_rip_authentication_key-chain¶
Specification Value Type object key-chain
Description Authentication key-chain (Name of key-chain)
Type: string
Format: string-rlx
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_ip_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for loopback-list_ip_router_isis
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ip/router/isis
loopback-list_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
loopback-list_ipv6¶
Specification Value Type object address-list
Type: Listipv6-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 loopback-list_ipv6_ospf
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/ospf
rip
Description: rip is a JSON Block. Please see below for loopback-list_ipv6_rip
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/rip
router
Description: router is a JSON Block. Please see below for loopback-list_ipv6_router
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/router
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
loopback-list_ipv6_address-list¶
Specification Value 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
loopback-list_ipv6_rip¶
Specification Value Type object split-horizon-cfg
Description: split-horizon-cfg is a JSON Block. Please see below for loopback-list_ipv6_rip_split-horizon-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
loopback-list_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
loopback-list_ipv6_router¶
Specification Value Type object isis
Description: isis is a JSON Block. Please see below for loopback-list_ipv6_router_isis
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/router/isis
ospf
Description: ospf is a JSON Block. Please see below for loopback-list_ipv6_router_ospf
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/router/ospf
ripng
Description: ripng is a JSON Block. Please see below for loopback-list_ipv6_router_ripng
Type: Object
Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/router/ripng
loopback-list_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
loopback-list_ipv6_router_ospf¶
Specification Value Type object area-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
loopback-list_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
loopback-list_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
loopback-list_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: Listdead-interval-cfg
Type: Listdisable
Description Disable BFD
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hello-interval-cfg
Type: Listmtu-ignore-cfg
Type: Listpriority-cfg
Type: Listretransmit-interval-cfg
Type: Listtransmit-delay-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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
loopback-list_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