system¶
Configure System Parameters
system Specification¶
Type Configuration Resource Element Name system Element URI /axapi/v3/system Element Attributes system_attributes Schema system schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/system | ||
Get Object | GET | /axapi/v3/system | ||
Modify Object | POST | /axapi/v3/system | ||
Replace Object | PUT | /axapi/v3/system | ||
Delete Object | DELETE | /axapi/v3/system |
system attributes¶
add-cpu-core
Description: add-cpu-core is a JSON Block. Please see below for add-cpu-core
Type: Object
Reference Object: /axapi/v3/system/add-cpu-core
add-port
Description: add-port is a JSON Block. Please see below for add-port
Type: Object
Reference Object: /axapi/v3/system/add-port
all-vlan-limit
Description: all-vlan-limit is a JSON Block. Please see below for all-vlan-limit
Type: Object
Reference Object: /axapi/v3/system/all-vlan-limit
anomaly-log
Description log system anomalies
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
app-performance
Description: app-performance is a JSON Block. Please see below for app-performance
Type: Object
Reference Object: /axapi/v3/system/app-performance
apps-global
Description: apps-global is a JSON Block. Please see below for apps-global
Type: Object
Reference Object: /axapi/v3/system/apps-global
asic-debug-dump
Description: asic-debug-dump is a JSON Block. Please see below for asic-debug-dump
Type: Object
Reference Object: /axapi/v3/system/asic-debug-dump
attack-log
Description log attack anomalies
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
bandwidth
Description: bandwidth is a JSON Block. Please see below for bandwidth
Type: Object
Reference Object: /axapi/v3/system/bandwidth
bfd
Description: bfd is a JSON Block. Please see below for bfd
Type: Object
Reference Object: /axapi/v3/system/bfd
class-list-hitcount-enable
Description Enable class list hit count
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
cm-update-file-name-ref
Description: cm-update-file-name-ref is a JSON Block. Please see below for cm-update-file-name-ref
Type: Object
Reference Object: /axapi/v3/system/cm-update-file-name-ref
control-cpu
Description: control-cpu is a JSON Block. Please see below for control-cpu
Type: Object
Reference Object: /axapi/v3/system/control-cpu
core
Description: core is a JSON Block. Please see below for core
Type: Object
Reference Object: /axapi/v3/system/core
cosq-show
Description: cosq-show is a JSON Block. Please see below for cosq-show
Type: Object
Reference Object: /axapi/v3/system/cosq-show
cosq-stats
Description: cosq-stats is a JSON Block. Please see below for cosq-stats
Type: Object
Reference Object: /axapi/v3/system/cosq-stats
counter-lib-accounting
Description: counter-lib-accounting is a JSON Block. Please see below for counter-lib-accounting
Type: Object
Reference Object: /axapi/v3/system/counter-lib-accounting
cpu-hyper-thread
Description: cpu-hyper-thread is a JSON Block. Please see below for cpu-hyper-thread
Type: Object
Reference Object: /axapi/v3/system/cpu-hyper-thread
cpu-list
Description: cpu-list is a JSON Block. Please see below for cpu-list
Type: Object
Reference Object: /axapi/v3/system/cpu-list
cpu-load-sharing
Description: cpu-load-sharing is a JSON Block. Please see below for cpu-load-sharing
Type: Object
Reference Object: /axapi/v3/system/cpu-load-sharing
cpu-map
Description: cpu-map is a JSON Block. Please see below for cpu-map
Type: Object
Reference Object: /axapi/v3/system/cpu-map
data-cpu
Description: data-cpu is a JSON Block. Please see below for data-cpu
Type: Object
Reference Object: /axapi/v3/system/data-cpu
ddos-attack
Description System DDoS Attack
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ddos-log
Description log DDoS attack anomalies
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
deep-hrxq
Description: deep-hrxq is a JSON Block. Please see below for deep-hrxq
Type: Object
Reference Object: /axapi/v3/system/deep-hrxq
del-port
Description: del-port is a JSON Block. Please see below for del-port
Type: Object
Reference Object: /axapi/v3/system/del-port
delete-cpu-core
Description: delete-cpu-core is a JSON Block. Please see below for delete-cpu-core
Type: Object
Reference Object: /axapi/v3/system/delete-cpu-core
dns
Description: dns is a JSON Block. Please see below for dns
Type: Object
Reference Object: /axapi/v3/system/dns
dns-cache
Description: dns-cache is a JSON Block. Please see below for dns-cache
Type: Object
Reference Object: /axapi/v3/system/dns-cache
domain-list-hitcount-enable
Description Enable class list hit count
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
domain-list-info
Description: domain-list-info is a JSON Block. Please see below for domain-list-info
Type: Object
Reference Object: /axapi/v3/system/domain-list-info
dpdk-stats
Description: dpdk-stats is a JSON Block. Please see below for dpdk-stats
Type: Object
Reference Object: /axapi/v3/system/dpdk-stats
dynamic-service-dns-socket-pool
Description Enable socket pool for dynamic-service DNS
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
environment
Description: environment is a JSON Block. Please see below for environment
Type: Object
Reference Object: /axapi/v3/system/environment
fpga-core-crc
Description: fpga-core-crc is a JSON Block. Please see below for fpga-core-crc
Type: Object
Reference Object: /axapi/v3/system/fpga-core-crc
fpga-drop
Description: fpga-drop is a JSON Block. Please see below for fpga-drop
Type: Object
Reference Object: /axapi/v3/system/fpga-drop
fw
Description: fw is a JSON Block. Please see below for fw
Type: Object
Reference Object: /axapi/v3/system/fw
geo-db-hitcount-enable
Description Enable Geolocation database hit count
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geo-location
Description: geo-location is a JSON Block. Please see below for geo-location
Type: Object
Reference Object: /axapi/v3/system/geo-location
geoloc
Description: geoloc is a JSON Block. Please see below for geoloc
Type: Object
Reference Object: /axapi/v3/system/geoloc
geoloc-list-list
Type: List
Reference Object: /axapi/v3/system/geoloc-list/{name}
geoloc-name-helper
Description: geoloc-name-helper is a JSON Block. Please see below for geoloc-name-helper
Type: Object
Reference Object: /axapi/v3/system/geoloc-name-helper
geolocation-file
Description: geolocation-file is a JSON Block. Please see below for geolocation-file
Type: Object
Reference Object: /axapi/v3/system/geolocation-file
glid
Description Apply limits to the whole system
Type: number
Range: 1-1023
Reference Object: /axapi/v3/glid
guest-file
Description: guest-file is a JSON Block. Please see below for guest-file
Type: Object
Reference Object: /axapi/v3/system/guest-file
gui-image-list
Description: gui-image-list is a JSON Block. Please see below for gui-image-list
Type: Object
Reference Object: /axapi/v3/system/gui-image-list
hardware
Description: hardware is a JSON Block. Please see below for hardware
Type: Object
Reference Object: /axapi/v3/system/hardware
hardware-forward
Description: hardware-forward is a JSON Block. Please see below for hardware-forward
Type: Object
Reference Object: /axapi/v3/system/hardware-forward
high-memory-l4-session
Description: high-memory-l4-session is a JSON Block. Please see below for high-memory-l4-session
Type: Object
Reference Object: /axapi/v3/system/high-memory-l4-session
hrxq-status
Description: hrxq-status is a JSON Block. Please see below for hrxq-status
Type: Object
Reference Object: /axapi/v3/system/hrxq-status
icmp
Description: icmp is a JSON Block. Please see below for icmp
Type: Object
Reference Object: /axapi/v3/system/icmp
icmp-rate
Description: icmp-rate is a JSON Block. Please see below for icmp-rate
Type: Object
Reference Object: /axapi/v3/system/icmp-rate
icmp6
Description: icmp6 is a JSON Block. Please see below for icmp6
Type: Object
Reference Object: /axapi/v3/system/icmp6
inuse-cpu-list
Description: inuse-cpu-list is a JSON Block. Please see below for inuse-cpu-list
Type: Object
Reference Object: /axapi/v3/system/inuse-cpu-list
inuse-port-list
Description: inuse-port-list is a JSON Block. Please see below for inuse-port-list
Type: Object
Reference Object: /axapi/v3/system/inuse-port-list
io-cpu
Description: io-cpu is a JSON Block. Please see below for io-cpu
Type: Object
Reference Object: /axapi/v3/system/io-cpu
ip-dns-cache
Description: ip-dns-cache is a JSON Block. Please see below for ip-dns-cache
Type: Object
Reference Object: /axapi/v3/system/ip-dns-cache
ip-stats
Description: ip-stats is a JSON Block. Please see below for ip-stats
Type: Object
Reference Object: /axapi/v3/system/ip-stats
ip-threat-list
Description: ip-threat-list is a JSON Block. Please see below for ip-threat-list
Type: Object
Reference Object: /axapi/v3/system/ip-threat-list
ip6-stats
Description: ip6-stats is a JSON Block. Please see below for ip6-stats
Type: Object
Reference Object: /axapi/v3/system/ip6-stats
ipmi
Description: ipmi is a JSON Block. Please see below for ipmi
Type: Object
Reference Object: /axapi/v3/system/ipmi
ipmi-service
Description: ipmi-service is a JSON Block. Please see below for ipmi-service
Type: Object
Reference Object: /axapi/v3/system/ipmi-service
ipsec
Description: ipsec is a JSON Block. Please see below for ipsec
Type: Object
Reference Object: /axapi/v3/system/ipsec
ipv6-prefix-length
Description Length of IPv6 prefix used to determine the user-group and the PU, by default 128
Type: number
Range: 16-128
Default: 128
link-capability
Description: link-capability is a JSON Block. Please see below for link-capability
Type: Object
Reference Object: /axapi/v3/system/link-capability
link-monitor
Description: link-monitor is a JSON Block. Please see below for link-monitor
Type: Object
Reference Object: /axapi/v3/system/link-monitor
lro
Description: lro is a JSON Block. Please see below for lro
Type: Object
Reference Object: /axapi/v3/system/lro
management-interface-mode
Description: management-interface-mode is a JSON Block. Please see below for management-interface-mode
Type: Object
Reference Object: /axapi/v3/system/management-interface-mode
memory
Description: memory is a JSON Block. Please see below for memory
Type: Object
Reference Object: /axapi/v3/system/memory
mfa-auth
Description: mfa-auth is a JSON Block. Please see below for mfa-auth
Type: Object
Reference Object: /axapi/v3/system/mfa-auth
mfa-cert-store
Description: mfa-cert-store is a JSON Block. Please see below for mfa-cert-store
Type: Object
Reference Object: /axapi/v3/system/mfa-cert-store
mfa-management
Description: mfa-management is a JSON Block. Please see below for mfa-management
Type: Object
Reference Object: /axapi/v3/system/mfa-management
mfa-validation-type
Description: mfa-validation-type is a JSON Block. Please see below for mfa-validation-type
Type: Object
Reference Object: /axapi/v3/system/mfa-validation-type
mgmt-port
Description: mgmt-port is a JSON Block. Please see below for mgmt-port
Type: Object
Reference Object: /axapi/v3/system/mgmt-port
modify-port
Description: modify-port is a JSON Block. Please see below for modify-port
Type: Object
Reference Object: /axapi/v3/system/modify-port
module-ctrl-cpu
Description ‘high’: high cpu usage; ‘low’: low cpu usage; ‘medium’: medium cpu usage;
Type: string
Supported Values: high, low, medium
mon-template
Description: mon-template is a JSON Block. Please see below for mon-template
Type: Object
Reference Object: /axapi/v3/system/mon-template
multi-queue-support
Description: multi-queue-support is a JSON Block. Please see below for multi-queue-support
Type: Object
Reference Object: /axapi/v3/system/multi-queue-support
ndisc-ra
Description: ndisc-ra is a JSON Block. Please see below for ndisc-ra
Type: Object
Reference Object: /axapi/v3/system/ndisc-ra
nsm-a10lb
Description: nsm-a10lb is a JSON Block. Please see below for nsm-a10lb
Type: Object
Reference Object: /axapi/v3/system/nsm-a10lb
password-policy
Description: password-policy is a JSON Block. Please see below for password-policy
Type: Object
Reference Object: /axapi/v3/system/password-policy
per-vlan-limit
Description: per-vlan-limit is a JSON Block. Please see below for per-vlan-limit
Type: Object
Reference Object: /axapi/v3/system/per-vlan-limit
platformtype
Description: platformtype is a JSON Block. Please see below for platformtype
Type: Object
Reference Object: /axapi/v3/system/platformtype
port-info
Description: port-info is a JSON Block. Please see below for port-info
Type: Object
Reference Object: /axapi/v3/system/port-info
port-list
Description: port-list is a JSON Block. Please see below for port-list
Type: Object
Reference Object: /axapi/v3/system/port-list
ports
Description: ports is a JSON Block. Please see below for ports
Type: Object
Reference Object: /axapi/v3/system/ports
probe-network-devices
Type: Object
Reference Object: /axapi/v3/system/probe-network-devices
promiscuous-mode
Description Run in promiscous mode settings
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
psu-info
Description: psu-info is a JSON Block. Please see below for psu-info
Type: Object
Reference Object: /axapi/v3/system/psu-info
q-in-q
Description: q-in-q is a JSON Block. Please see below for q-in-q
Type: Object
Reference Object: /axapi/v3/system/q-in-q
queuing-buffer
Description: queuing-buffer is a JSON Block. Please see below for queuing-buffer
Type: Object
Reference Object: /axapi/v3/system/queuing-buffer
radius
Description: radius is a JSON Block. Please see below for radius
Type: Object
Reference Object: /axapi/v3/system/radius
reboot
Description: reboot is a JSON Block. Please see below for reboot
Type: Object
Reference Object: /axapi/v3/system/reboot
resource-accounting
Description: resource-accounting is a JSON Block. Please see below for resource-accounting
Type: Object
Reference Object: /axapi/v3/system/resource-accounting
resource-usage
Description: resource-usage is a JSON Block. Please see below for resource-usage
Type: Object
Reference Object: /axapi/v3/system/resource-usage
session
Description: session is a JSON Block. Please see below for session
Type: Object
Reference Object: /axapi/v3/system/session
session-reclaim-limit
Description: session-reclaim-limit is a JSON Block. Please see below for session-reclaim-limit
Type: Object
Reference Object: /axapi/v3/system/session-reclaim-limit
set-rxtx-desc-size
Description: set-rxtx-desc-size is a JSON Block. Please see below for set-rxtx-desc-size
Type: Object
Reference Object: /axapi/v3/system/set-rxtx-desc-size
set-rxtx-queue
Description: set-rxtx-queue is a JSON Block. Please see below for set-rxtx-queue
Type: Object
Reference Object: /axapi/v3/system/set-rxtx-queue
set-tcp-syn-per-sec
Description: set-tcp-syn-per-sec is a JSON Block. Please see below for set-tcp-syn-per-sec
Type: Object
Reference Object: /axapi/v3/system/set-tcp-syn-per-sec
shared-poll-mode
Description: shared-poll-mode is a JSON Block. Please see below for shared-poll-mode
Type: Object
Reference Object: /axapi/v3/system/shared-poll-mode
shell-privileges
Description: shell-privileges is a JSON Block. Please see below for shell-privileges
Type: Object
Reference Object: /axapi/v3/system/shell-privileges
shm-logging
Description: shm-logging is a JSON Block. Please see below for shm-logging
Type: Object
Reference Object: /axapi/v3/system/shm-logging
shutdown
Description: shutdown is a JSON Block. Please see below for shutdown
Type: Object
Reference Object: /axapi/v3/system/shutdown
sockstress-disable
Description Disable sockstress protection
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
spe-profile
Description: spe-profile is a JSON Block. Please see below for spe-profile
Type: Object
Reference Object: /axapi/v3/system/spe-profile
spe-status
Description: spe-status is a JSON Block. Please see below for spe-status
Type: Object
Reference Object: /axapi/v3/system/spe-status
src-ip-hash-enable
Description Enable source ip hash
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ssl-req-q
Description: ssl-req-q is a JSON Block. Please see below for ssl-req-q
Type: Object
Reference Object: /axapi/v3/system/ssl-req-q
ssl-scv
Description: ssl-scv is a JSON Block. Please see below for ssl-scv
Type: Object
Reference Object: /axapi/v3/system/ssl-scv
ssl-scv-verify-crl-sign
Description: ssl-scv-verify-crl-sign is a JSON Block. Please see below for ssl-scv-verify-crl-sign
Type: Object
Reference Object: /axapi/v3/system/ssl-scv-verify-crl-sign
ssl-scv-verify-host
Description: ssl-scv-verify-host is a JSON Block. Please see below for ssl-scv-verify-host
Type: Object
Reference Object: /axapi/v3/system/ssl-scv-verify-host
ssl-set-compatible-cipher
Description: ssl-set-compatible-cipher is a JSON Block. Please see below for ssl-set-compatible-cipher
Type: Object
Reference Object: /axapi/v3/system/ssl-set-compatible-cipher
ssl-status
Description: ssl-status is a JSON Block. Please see below for ssl-status
Type: Object
Reference Object: /axapi/v3/system/ssl-status
syslog-time-msec
Description: syslog-time-msec is a JSON Block. Please see below for syslog-time-msec
Type: Object
Reference Object: /axapi/v3/system/syslog-time-msec
table-integrity
Description: table-integrity is a JSON Block. Please see below for table-integrity
Type: Object
Reference Object: /axapi/v3/system/table-integrity
tcp
Description: tcp is a JSON Block. Please see below for tcp
Type: Object
Reference Object: /axapi/v3/system/tcp
tcp-stats
Description: tcp-stats is a JSON Block. Please see below for tcp-stats
Type: Object
Reference Object: /axapi/v3/system/tcp-stats
tcp-syn-per-sec
Description: tcp-syn-per-sec is a JSON Block. Please see below for tcp-syn-per-sec
Type: Object
Reference Object: /axapi/v3/system/tcp-syn-per-sec
telemetry-log
Description: telemetry-log is a JSON Block. Please see below for telemetry-log
Type: Object
Reference Object: /axapi/v3/system/telemetry-log
template
Description: template is a JSON Block. Please see below for template
Type: Object
Reference Object: /axapi/v3/system/template
template-bind
Description: template-bind is a JSON Block. Please see below for template-bind
Type: Object
Reference Object: /axapi/v3/system/template-bind
throughput
Description: throughput is a JSON Block. Please see below for throughput
Type: Object
Reference Object: /axapi/v3/system/throughput
timeout-value
Description: timeout-value is a JSON Block. Please see below for timeout-value
Type: Object
Reference Object: /axapi/v3/system/timeout-value
tls-1-3-mgmt
Description: tls-1-3-mgmt is a JSON Block. Please see below for tls-1-3-mgmt
Type: Object
Reference Object: /axapi/v3/system/tls-1-3-mgmt
trunk
Description: trunk is a JSON Block. Please see below for trunk
Type: Object
Reference Object: /axapi/v3/system/trunk
trunk-hw-hash
Description: trunk-hw-hash is a JSON Block. Please see below for trunk-hw-hash
Type: Object
Reference Object: /axapi/v3/system/trunk-hw-hash
trunk-xaui-hw-hash
Description: trunk-xaui-hw-hash is a JSON Block. Please see below for trunk-xaui-hw-hash
Type: Object
Reference Object: /axapi/v3/system/trunk-xaui-hw-hash
tso
Description: tso is a JSON Block. Please see below for tso
Type: Object
Reference Object: /axapi/v3/system/tso
upgrade-status
Description: upgrade-status is a JSON Block. Please see below for upgrade-status
Type: Object
Reference Object: /axapi/v3/system/upgrade-status
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-mac-scheme
Description: ve-mac-scheme is a JSON Block. Please see below for ve-mac-scheme
Type: Object
Reference Object: /axapi/v3/system/ve-mac-scheme
geo-location¶
Specification Type object entry-list
Type: List
Reference Object: /axapi/v3/system/geo-location/entry/{geo-locn-obj-name}
geo-location-geolite2-city
Description Load built-in Maxmind GeoLite2-City database. Database available from http://www.maxmind.com
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geo-location-geolite2-country
Description Load built-in Maxmind GeoLite2-Country database. Database available from http://www.maxmind.com
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geo-location-iana
Description Load built-in IANA Database
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
geolite2-city-include-ipv6
Description Include IPv6 address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geolite2-country-include-ipv6
Description Include IPv6 address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geoloc-load-file-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
geo-location_entry-list¶
Specification Type list Block object keys geo-locn-multiple-addresses
Type: Listgeo-locn-obj-name
Description Specify geo-location name, section range is (1-15)
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
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
geo-location_entry-list_geo-locn-multiple-addresses¶
Specification Type list Block object keys first-ip-address
Description Specify IP information (Specify IP address)
Type: string
Format: ipv4-address
first-ipv6-address
Description Specify IPv6 address
Type: string
Format: ipv6-address
geol-ipv4-mask
Description Specify IPv4 mask
Type: string
Format: ipv4-netmask
Mutual Exclusion: geol-ipv4-mask and ip-addr2 are mutually exclusive
geol-ipv6-mask
Description Specify IPv6 mask
Type: number
Range: 0-128
Mutual Exclusion: geol-ipv6-mask and ipv6-addr2 are mutually exclusive
ip-addr2
Description Specify IP address range
Type: string
Format: ipv4-address
Mutual Exclusion: ip-addr2 and geol-ipv4-mask are mutually exclusive
ipv6-addr2
Description Specify IPv6 address range
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-addr2 and geol-ipv6-mask are mutually exclusive
geo-location_geoloc-load-file-list¶
Specification Type list Block object keys geo-location-load-filename
Description Specify file to be loaded
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
template-name
Description CSV template to load this file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/template/csv
mgmt-port¶
Specification Type object mac-address
Description mac-address to be configured as mgmt port
Type: string
Format: mac-address
Maximum Length: 14 characters
Maximum Length: 14 characters
pci-address
Description pci-address to be configured as mgmt port
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
port-index
Description port index to be configured (Specify port index)
Type: number
Range: 0-32
geolocation-file¶
Specification Type object error-info
Description: error-info is a JSON Block. Please see below for geolocation-file_error-info
Type: Object
Reference Object: /axapi/v3/system/geolocation-file/error-info
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
geolocation-file_error-info¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ndisc-ra¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ndisc-ra_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘good_recv’: Good Router Solicitations (R.S.) Received; ‘periodic_sent’: Periodic Router Advertisements (R.A.) Sent; ‘rate_limit’: R.S. Rate Limited; ‘bad_hop_limit’: R.S. Bad Hop Limit; ‘truncated’: R.S. Truncated; ‘bad_icmpv6_csum’: R.S. Bad ICMPv6 Checksum; ‘bad_icmpv6_code’: R.S. Unknown ICMPv6 Code; ‘bad_icmpv6_option’: R.S. Bad ICMPv6 Option; ‘l2_addr_and_unspec’: R.S. Src Link-Layer Option and Unspecified Address; ‘no_free_buffers’: No Free Buffers to send R.A.;
Type: string
Supported Values: all, good_recv, periodic_sent, rate_limit, bad_hop_limit, truncated, bad_icmpv6_csum, bad_icmpv6_code, bad_icmpv6_option, l2_addr_and_unspec, no_free_buffers
tcp¶
Specification Type object rate-limit-reset-unknown-conn
Description: rate-limit-reset-unknown-conn is a JSON Block. Please see below for tcp_rate-limit-reset-unknown-conn
Type: Object
Reference Object: /axapi/v3/system/tcp/rate-limit-reset-unknown-conn
sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tcp_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘activeopens’: Active open conns; ‘passiveopens’: Passive open conns; ‘attemptfails’: Connect attemp failures; ‘estabresets’: Resets rcvd on EST conn; ‘insegs’: Total in TCP packets; ‘outsegs’: Total out TCP packets; ‘retranssegs’: Retransmited packets; ‘inerrs’: Input errors; ‘outrsts’: Reset Sent; ‘sock_alloc’: Sockets allocated; ‘orphan_count’: Orphan sockets; ‘mem_alloc’: Memory alloc; ‘recv_mem’: Total rx buffer; ‘send_mem’: Total tx buffer; ‘currestab’: Currently EST conns; ‘currsyssnt’: TCP in SYN-SNT state; ‘currsynrcv’: TCP in SYN-RCV state; ‘currfinw1’: TCP in FIN-W1 state; ‘currfinw2’: TCP FIN-W2 state; ‘currtimew’: TCP TimeW state; ‘currclose’: TCP in Close state; ‘currclsw’: TCP in CloseW state; ‘currlack’: TCP in LastACK state; ‘currlstn’: TCP in Listen state; ‘currclsg’: TCP in Closing state; ‘pawsactiverejected’: TCP paw active rej; ‘syn_rcv_rstack’: Rcv RST|ACK on SYN; ‘syn_rcv_rst’: Rcv RST on SYN; ‘syn_rcv_ack’: Rcv ACK on SYN; ‘ax_rexmit_syn’: TCP rexmit SYN; ‘tcpabortontimeout’: TCP abort on timeout; ‘noroute’: TCPIP out noroute; ‘exceedmss’: MSS exceeded pkt dropped; ‘tfo_conns’: TFO Total Connections; ‘tfo_actives’: TFO Current Actives; ‘tfo_denied’: TFO Denied;
Type: string
Supported Values: all, activeopens, passiveopens, attemptfails, estabresets, insegs, outsegs, retranssegs, inerrs, outrsts, sock_alloc, orphan_count, mem_alloc, recv_mem, send_mem, currestab, currsyssnt, currsynrcv, currfinw1, currfinw2, currtimew, currclose, currclsw, currlack, currlstn, currclsg, pawsactiverejected, syn_rcv_rstack, syn_rcv_rst, syn_rcv_ack, ax_rexmit_syn, tcpabortontimeout, noroute, exceedmss, tfo_conns, tfo_actives, tfo_denied
tcp_rate-limit-reset-unknown-conn¶
Specification Type object log-for-reset-unknown-conn
Description Log when rate exceed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
pkt-rate-for-reset-unknown-conn
Description
Type: number
Range: 1-1048575
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
bandwidth¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
bandwidth_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘input-bytes-per-sec’: In Bytes per second; ‘output-bytes-per-sec’: Out Bytes per second;
Type: string
Supported Values: all, input-bytes-per-sec, output-bytes-per-sec
session¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
session_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘total_l4_conn’: Total L4 Count; ‘conn_counter’: Conn Count; ‘conn_freed_counter’: Conn Freed; ‘total_l4_packet_count’: Total L4 Packet Count; ‘total_l7_packet_count’: Total L7 Packet Count; ‘total_l4_conn_proxy’: Total L4 Conn Proxy Count; ‘total_l7_conn’: Total L7 Conn; ‘total_tcp_conn’: Total TCP Conn; ‘curr_free_conn’: Curr Free Conn; ‘tcp_est_counter’: TCP Established; ‘tcp_half_open_counter’: TCP Half Open; ‘tcp_half_close_counter’: TCP Half Closed; ‘udp_counter’: UDP Count; ‘ip_counter’: IP Count; ‘other_counter’: Non TCP/UDP IP sessions; ‘reverse_nat_tcp_counter’: Reverse NAT TCP; ‘reverse_nat_udp_counter’: Reverse NAT UDP; ‘tcp_syn_half_open_counter’: TCP SYN Half Open; ‘conn_smp_alloc_counter’: Conn SMP Alloc; ‘conn_smp_free_counter’: Conn SMP Free; ‘conn_smp_aged_counter’: Conn SMP Aged; ‘ssl_count_curr’: Curr SSL Count; ‘ssl_count_total’: Total SSL Count; ‘server_ssl_count_curr’: Current SSL Server Count; ‘server_ssl_count_total’: Total SSL Server Count; ‘client_ssl_reuse_total’: Total SSL Client Reuse; ‘server_ssl_reuse_total’: Total SSL Server Reuse; ‘ssl_failed_total’: Total SSL Failures; ‘ssl_failed_ca_verification’: SSL Cert Auth Verification Errors; ‘ssl_server_cert_error’: SSL Server Cert Errors; ‘ssl_client_cert_auth_fail’: SSL Client Cert Auth Failures; ‘total_ip_nat_conn’: Total IP Nat Conn; ‘total_l2l3_conn’: Totl L2/L3 Connections; ‘client_ssl_ctx_malloc_failure’: Client SSL Ctx malloc Failures; ‘conn_type_0_available’: Conn Type 0 Available; ‘conn_type_1_available’: Conn Type 1 Available; ‘conn_type_2_available’: Conn Type 2 Available; ‘conn_type_3_available’: Conn Type 3 Available; ‘conn_type_4_available’: Conn Type 4 Available; ‘conn_smp_type_0_available’: Conn SMP Type 0 Available; ‘conn_smp_type_1_available’: Conn SMP Type 1 Available; ‘conn_smp_type_2_available’: Conn SMP Type 2 Available; ‘conn_smp_type_3_available’: Conn SMP Type 3 Available; ‘conn_smp_type_4_available’: Conn SMP Type 4 Available; ‘sctp-half-open-counter’: SCTP Half Open; ‘sctp-est-counter’: SCTP Established; ‘nonssl_bypass’: NON SSL Bypass Count; ‘ssl_failsafe_total’: Total SSL Failsafe Count; ‘ssl_forward_proxy_failed_handshake_total’: Total SSL Forward Proxy Failed Handshake Count; ‘ssl_forward_proxy_failed_tcp_total’: Total SSL Forward Proxy Failed TCP Count; ‘ssl_forward_proxy_failed_crypto_total’: Total SSL Forward Proxy Failed Crypto Count; ‘ssl_forward_proxy_failed_cert_verify_total’: Total SSL Forward Proxy Failed Certificate Verification Count; ‘ssl_forward_proxy_invalid_ocsp_stapling_total’: Total SSL Forward Proxy Invalid OCSP Stapling Count; ‘ssl_forward_proxy_revoked_ocsp_total’: Total SSL Forward Proxy Revoked OCSP Response Count; ‘ssl_forward_proxy_failed_cert_signing_total’: Total SSL Forward Proxy Failed Certificate Signing Count; ‘ssl_forward_proxy_failed_ssl_version_total’: Total SSL Forward Proxy Unsupported version Count; ‘ssl_forward_proxy_sni_bypass_total’: Total SSL Forward Proxy SNI Bypass Count; ‘ssl_forward_proxy_client_auth_bypass_total’: Total SSL Forward Proxy Client Auth Bypass Count; ‘conn_app_smp_alloc_counter’: Conn APP SMP Alloc; ‘diameter_conn_counter’: Diameter Conn Count; ‘diameter_conn_freed_counter’: Diameter Conn Freed; ‘debug_tcp_counter’: Hidden TCP sessions for CGNv6 Stateless Technologies; ‘debug_udp_counter’: Hidden UDP sessions for CGNv6 Stateless Technologies; ‘total_fw_conn’: Total Firewall Conn; ‘total_local_conn’: Total Local Conn; ‘total_curr_conn’: Total Curr Conn; ‘client_ssl_fatal_alert’: client ssl fatal alert; ‘client_ssl_fin_rst’: client ssl fin rst; ‘fp_session_fin_rst’: FP Session FIN/RST; ‘server_ssl_fatal_alert’: server ssl fatal alert; ‘server_ssl_fin_rst’: server ssl fin rst; ‘client_template_int_err’: client template internal error; ‘client_template_unknown_err’: client template unknown error; ‘server_template_int_err’: server template int error; ‘server_template_unknown_err’: server template unknown error; ‘total_debug_conn’: Total Debug Conn; ‘ssl_forward_proxy_failed_aflex_total’: Total SSL Forward Proxy AFLEX Count; ‘ssl_forward_proxy_cert_subject_bypass_total’: Total SSL Forward Proxy Certificate Subject Bypass Count; ‘ssl_forward_proxy_cert_issuer_bypass_total’: Total SSL Forward Proxy Certificate Issuer Bypass Count; ‘ssl_forward_proxy_cert_san_bypass_total’: Total SSL Forward Proxy Certificate SAN Bypass Count; ‘ssl_forward_proxy_no_sni_bypass_total’: Total SSL Forward Proxy No SNI Bypass Count; ‘ssl_forward_proxy_no_sni_reset_total’: Total SSL Forward Proxy No SNI reset Count; ‘ssl_forward_proxy_username_bypass_total’: Total SSL Forward Proxy Username Bypass Count; ‘ssl_forward_proxy_ad_grpup_bypass_total’: Total SSL Forward Proxy AD-Group Bypass Count; ‘diameter_concurrent_user_sessions_counter’: Diameter Concurrent User-Sessions; ‘client_ssl_session_ticket_reuse_total’: Total SSL Client Session Ticket Reuse; ‘server_ssl_session_ticket_reuse_total’: Total SSL Server Session Ticket Reuse; ‘total_clientside_early_data_connections’: Total clientside early data connections; ‘total_serverside_early_data_connections’: Total serverside early data connections; ‘total_clientside_failed_early_data-connections’: Total clientside failed early data connections; ‘total_serverside_failed_early_data-connections’: Total serverside failed early data connections; ‘ssl_forward_proxy_esni_bypass_total’: Total SSL Forward Proxy ESNI Bypass Count; ‘ssl_forward_proxy_esni_reset_total’: Total SSL Forward Proxy ESNI Drop Count; ‘total_logging_conn’: Total Logging Conn; ‘gtp_c_est_counter’: GTP-C Established; ‘gtp_c_half_open_counter’: GTP-C Half Open; ‘gtp_u_counter’: GTP-U Count; ‘gtp_c_echo_counter’: GTP-C Echo Count; ‘gtp_u_echo_counter’: GTP-U Echo Count; ‘gtp_curr_free_conn’: GTP Current Available Conn; ‘gtp_cum_conn_counter’: GTP cumulative Conn Count; ‘gtp_cum_conn_freed_counter’: GTP cumulative Conn Freed;
Type: string
Supported Values: all, total_l4_conn, conn_counter, conn_freed_counter, total_l4_packet_count, total_l7_packet_count, total_l4_conn_proxy, total_l7_conn, total_tcp_conn, curr_free_conn, tcp_est_counter, tcp_half_open_counter, tcp_half_close_counter, udp_counter, ip_counter, other_counter, reverse_nat_tcp_counter, reverse_nat_udp_counter, tcp_syn_half_open_counter, conn_smp_alloc_counter, conn_smp_free_counter, conn_smp_aged_counter, ssl_count_curr, ssl_count_total, server_ssl_count_curr, server_ssl_count_total, client_ssl_reuse_total, server_ssl_reuse_total, ssl_failed_total, ssl_failed_ca_verification, ssl_server_cert_error, ssl_client_cert_auth_fail, total_ip_nat_conn, total_l2l3_conn, client_ssl_ctx_malloc_failure, conn_type_0_available, conn_type_1_available, conn_type_2_available, conn_type_3_available, conn_type_4_available, conn_smp_type_0_available, conn_smp_type_1_available, conn_smp_type_2_available, conn_smp_type_3_available, conn_smp_type_4_available, sctp-half-open-counter, sctp-est-counter, nonssl_bypass, ssl_failsafe_total, ssl_forward_proxy_failed_handshake_total, ssl_forward_proxy_failed_tcp_total, ssl_forward_proxy_failed_crypto_total, ssl_forward_proxy_failed_cert_verify_total, ssl_forward_proxy_invalid_ocsp_stapling_total, ssl_forward_proxy_revoked_ocsp_total, ssl_forward_proxy_failed_cert_signing_total, ssl_forward_proxy_failed_ssl_version_total, ssl_forward_proxy_sni_bypass_total, ssl_forward_proxy_client_auth_bypass_total, conn_app_smp_alloc_counter, diameter_conn_counter, diameter_conn_freed_counter, debug_tcp_counter, debug_udp_counter, total_fw_conn, total_local_conn, total_curr_conn, client_ssl_fatal_alert, client_ssl_fin_rst, fp_session_fin_rst, server_ssl_fatal_alert, server_ssl_fin_rst, client_template_int_err, client_template_unknown_err, server_template_int_err, server_template_unknown_err, total_debug_conn, ssl_forward_proxy_failed_aflex_total, ssl_forward_proxy_cert_subject_bypass_total, ssl_forward_proxy_cert_issuer_bypass_total, ssl_forward_proxy_cert_san_bypass_total, ssl_forward_proxy_no_sni_bypass_total, ssl_forward_proxy_no_sni_reset_total, ssl_forward_proxy_username_bypass_total, ssl_forward_proxy_ad_grpup_bypass_total, diameter_concurrent_user_sessions_counter, client_ssl_session_ticket_reuse_total, server_ssl_session_ticket_reuse_total, total_clientside_early_data_connections, total_serverside_early_data_connections, total_clientside_failed_early_data-connections, total_serverside_failed_early_data-connections, ssl_forward_proxy_esni_bypass_total, ssl_forward_proxy_esni_reset_total, total_logging_conn, gtp_c_est_counter, gtp_c_half_open_counter, gtp_u_counter, gtp_c_echo_counter, gtp_u_echo_counter, gtp_curr_free_conn, gtp_cum_conn_counter, gtp_cum_conn_freed_counter
ip-threat-list¶
Specification Type object ipv4-dest-list
Description: ipv4-dest-list is a JSON Block. Please see below for ip-threat-list_ipv4-dest-list
Type: Object
Reference Object: /axapi/v3/system/ip-threat-list/ipv4-dest-list
ipv4-internet-host-list
Description: ipv4-internet-host-list is a JSON Block. Please see below for ip-threat-list_ipv4-internet-host-list
Type: Object
Reference Object: /axapi/v3/system/ip-threat-list/ipv4-internet-host-list
ipv4-source-list
Description: ipv4-source-list is a JSON Block. Please see below for ip-threat-list_ipv4-source-list
Type: Object
Reference Object: /axapi/v3/system/ip-threat-list/ipv4-source-list
ipv6-dest-list
Description: ipv6-dest-list is a JSON Block. Please see below for ip-threat-list_ipv6-dest-list
Type: Object
Reference Object: /axapi/v3/system/ip-threat-list/ipv6-dest-list
ipv6-internet-host-list
Description: ipv6-internet-host-list is a JSON Block. Please see below for ip-threat-list_ipv6-internet-host-list
Type: Object
Reference Object: /axapi/v3/system/ip-threat-list/ipv6-internet-host-list
ipv6-source-list
Description: ipv6-source-list is a JSON Block. Please see below for ip-threat-list_ipv6-source-list
Type: Object
Reference Object: /axapi/v3/system/ip-threat-list/ipv6-source-list
sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-threat-list_ipv6-internet-host-list¶
Specification Type object class-list-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-threat-list_ipv6-internet-host-list_class-list-cfg¶
Specification Type list Block object keys class-list
Description Bind class-list (class-list name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
ip-threat-action-tmpl
Description Bind ip-threat-action Template (ip-threat-action Template number)
Type: number
Range: 1-8
ip-threat-list_ipv4-source-list¶
Specification Type object class-list-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-threat-list_ipv4-source-list_class-list-cfg¶
Specification Type list Block object keys class-list
Description Bind class-list (class-list name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
ip-threat-action-tmpl
Description Bind ip-threat-action Template (ip-threat-action Template number)
Type: number
Range: 1-8
ip-threat-list_ipv4-internet-host-list¶
Specification Type object class-list-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-threat-list_ipv4-internet-host-list_class-list-cfg¶
Specification Type list Block object keys class-list
Description Bind class-list (class-list name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
ip-threat-action-tmpl
Description Bind ip-threat-action Template (ip-threat-action Template number)
Type: number
Range: 1-8
ip-threat-list_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘packet_hit_count_in_sw’: Packet Hit Count in SW; ‘packet_hit_count_in_spe’: Packet Hit Count in SPE; ‘entries_added_in_sw’: Entries Added in SW; ‘entries_removed_from_sw’: Entries Removed from SW; ‘entries_added_in_spe’: Entries Added in SPE; ‘entries_removed_from_spe’: Entries Removed from SPE; ‘error_out_of_memory’: Out of memory Error; ‘error_out_of_spe_entries’: Out of SPE Entries Error;
Type: string
Supported Values: all, packet_hit_count_in_sw, packet_hit_count_in_spe, entries_added_in_sw, entries_removed_from_sw, entries_added_in_spe, entries_removed_from_spe, error_out_of_memory, error_out_of_spe_entries
ip-threat-list_ipv6-dest-list¶
Specification Type object class-list-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-threat-list_ipv6-dest-list_class-list-cfg¶
Specification Type list Block object keys class-list
Description Bind class-list (class-list name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
ip-threat-action-tmpl
Description Bind ip-threat-action Template (ip-threat-action Template number)
Type: number
Range: 1-8
ip-threat-list_ipv4-dest-list¶
Specification Type object class-list-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-threat-list_ipv4-dest-list_class-list-cfg¶
Specification Type list Block object keys class-list
Description Bind class-list (class-list name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
ip-threat-action-tmpl
Description Bind ip-threat-action Template (ip-threat-action Template number)
Type: number
Range: 1-8
ip-threat-list_ipv6-source-list¶
Specification Type object class-list-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-threat-list_ipv6-source-list_class-list-cfg¶
Specification Type list Block object keys class-list
Description Bind class-list (class-list name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
ip-threat-action-tmpl
Description Bind ip-threat-action Template (ip-threat-action Template number)
Type: number
Range: 1-8
session-reclaim-limit¶
Specification Type object nscan-limit
Description smp session scan limit (number of smp sessions per scan)
Type: number
Range: 1-20480
Default: 4096
scan-freq
Description smp session scan frequency (scan per second)
Type: number
Range: 5-50
Default: 5
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
inuse-cpu-list¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
add-port¶
Specification Type object port-index
Description port index to be configured (Specify port index)
Type: number
Range: 0-32
tso¶
Specification Type object disable
Description Disable TCP Segmentation Offload
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable
Description Enable TCP Segmentation Offload
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
bfd¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
bfd_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘ip_checksum_error’: IP packet checksum errors; ‘udp_checksum_error’: UDP packet checksum errors; ‘session_not_found’: Session not found; ‘multihop_mismatch’: Multihop session or packet mismatch; ‘version_mismatch’: BFD version mismatch; ‘length_too_small’: Packets too small; ‘data_is_short’: Packet data length too short; ‘invalid_detect_mult’: Invalid detect multiplier; ‘invalid_multipoint’: Invalid multipoint setting; ‘invalid_my_disc’: Invalid my descriptor; ‘invalid_ttl’: Invalid TTL; ‘auth_length_invalid’: Invalid authentication length; ‘auth_mismatch’: Authentication mismatch; ‘auth_type_mismatch’: Authentication type mismatch; ‘auth_key_id_mismatch’: Authentication key-id mismatch; ‘auth_key_mismatch’: Authentication key mismatch; ‘auth_seqnum_invalid’: Invalid authentication sequence number; ‘auth_failed’: Authentication failures; ‘local_state_admin_down’: Local admin down session state; ‘dest_unreachable’: Destination unreachable; ‘no_ipv6_enable’: No IPv6 enable; ‘other_error’: Other errors;
Type: string
Supported Values: all, ip_checksum_error, udp_checksum_error, session_not_found, multihop_mismatch, version_mismatch, length_too_small, data_is_short, invalid_detect_mult, invalid_multipoint, invalid_my_disc, invalid_ttl, auth_length_invalid, auth_mismatch, auth_type_mismatch, auth_key_id_mismatch, auth_key_mismatch, auth_seqnum_invalid, auth_failed, local_state_admin_down, dest_unreachable, no_ipv6_enable, other_error
trunk-xaui-hw-hash¶
Specification Type object mode
Description Set HW hash mode, default is 6 (1:dst-mac 2:src-mac 3:src-dst-mac 4:src-ip 5:dst-ip 6:rtag6 7:rtag7)
Type: number
Range: 1-7
Default: 6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
environment¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
port-info¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-hw-hash¶
Specification Type object mode
Description Set HW hash mode, default is 6 (1:dst-mac 2:src-mac 3:src-dst-mac 4:src-ip 5:dst-ip 6:rtag6 7:rtag7)
Type: number
Range: 1-7
Default: 6
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template¶
Specification Type object template-policy
Description Apply policy template to the whole system (Policy template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/policy
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template-bind¶
Specification Type object monitor-list
Type: List
Reference Object: /axapi/v3/system/template-bind/monitor/{template-monitor}
template-bind_monitor-list¶
Specification Type list Block object keys template-monitor
Description Monitor template ID Number
Type: number
Range: 1-16
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ipmi¶
Specification Type object ip
Description: ip is a JSON Block. Please see below for ipmi_ip
Type: Object
Reference Object: /axapi/v3/system/ipmi/ip
ipsrc
Description: ipsrc is a JSON Block. Please see below for ipmi_ipsrc
Type: Object
Reference Object: /axapi/v3/system/ipmi/ipsrc
reset
Description Reset IPMI Controller
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tool
Description: tool is a JSON Block. Please see below for ipmi_tool
Type: Object
Reference Object: /axapi/v3/system/ipmi/tool
user
Description: user is a JSON Block. Please see below for ipmi_user
Type: Object
Reference Object: /axapi/v3/system/ipmi/user
ipmi_ip¶
Specification Type object default-gateway
Description Default gateway address
Type: string
Format: ipv4-address
ipv4-address
Description IP address
Type: string
Format: ipv4-address
ipv4-netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask
ipmi_ipsrc¶
Specification Type object dhcp
Description IP addr obtained by BMC running DHCP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
static
Description Manually configured static IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipmi_tool¶
Specification Type object cmd
Description Command to execute in double quotes
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
ipmi_user¶
Specification Type object add
Description Add a new IPMI user (IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
administrator
Description Full control
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
callback
Description Lowest privilege level
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable
Description Disable an existing IPMI user (IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
newname
Description New IPMI User Name
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
newpass
Description New Password
Type: string
Format: password
Maximum Length: 17 characters
Maximum Length: 1 characters
operator
Description Most BMC commands are allowed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
password
Description Password
Type: string
Format: password
Maximum Length: 17 characters
Maximum Length: 1 characters
privilege
Description Change an existing IPMI user privilege (IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
setname
Description Change User Name (Current IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
setpass
Description Change Password (IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
user
Description Only ‘benign’ commands are allowed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lro¶
Specification Type object disable
Description Disable Large Receive Offload
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable
Description Enable Large Receive Offload
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
q-in-q¶
Specification Type object enable-all-ports
Description Enable 802.1QinQ on all physical ports
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
inner-tpid
Description TPID for inner VLAN (Inner TPID, 16 bit hex value, default is 8100)
Type: string
Format: time-hh:mm
Maximum Length: 4 characters
Maximum Length: 1 characters
outer-tpid
Description TPID for outer VLAN (Outer TPID, 16 bit hex value, default is 8100)
Type: string
Format: time-hh:mm
Maximum Length: 4 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ssl-req-q¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ssl-req-q_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘num-ssl-queues’: some help string; ‘ssl-req-q-depth-tot’: some help string; ‘ssl-req-q-inuse-tot’: some help string; ‘ssl-hw-q-depth-tot’: some help string; ‘ssl-hw-q-inuse-tot’: some help string;
Type: string
Supported Values: all, num-ssl-queues, ssl-req-q-depth-tot, ssl-req-q-inuse-tot, ssl-hw-q-depth-tot, ssl-hw-q-inuse-tot
telemetry-log¶
Specification Type object device-status
Description: device-status is a JSON Block. Please see below for telemetry-log_device-status
Type: Object
Reference Object: /axapi/v3/system/telemetry-log/device-status
environment
Description: environment is a JSON Block. Please see below for telemetry-log_environment
Type: Object
Reference Object: /axapi/v3/system/telemetry-log/environment
partition-metrics
Description: partition-metrics is a JSON Block. Please see below for telemetry-log_partition-metrics
Type: Object
Reference Object: /axapi/v3/system/telemetry-log/partition-metrics
top-k-app-svc-list
Description: top-k-app-svc-list is a JSON Block. Please see below for telemetry-log_top-k-app-svc-list
Type: Object
Reference Object: /axapi/v3/system/telemetry-log/top-k-app-svc-list
top-k-source-list
Description: top-k-source-list is a JSON Block. Please see below for telemetry-log_top-k-source-list
Type: Object
Reference Object: /axapi/v3/system/telemetry-log/top-k-source-list
telemetry-log_device-status¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
telemetry-log_environment¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
telemetry-log_partition-metrics¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
telemetry-log_top-k-app-svc-list¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
telemetry-log_top-k-source-list¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ipsec¶
Specification Type object crypto-core
Description Crypto cores assigned for IPsec processing
Type: number
Range: 0-64
Default: 0
crypto-mem
Description Crypto memory percentage assigned for IPsec processing (rounded to increments of 10)
Type: number
Range: 0-100
Default: 0
fpga-decrypt
Description: fpga-decrypt is a JSON Block. Please see below for ipsec_fpga-decrypt
Type: Object
Reference Object: /axapi/v3/system/ipsec/fpga-decrypt
packet-round-robin
Description Enable packet round robin for IPsec packets
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
ipsec_fpga-decrypt¶
Specification Type object action
Description ‘enable’: Enable FPGA decryption offload; ‘disable’: Disable FPGA decryption offload;
Type: string
Supported Values: enable, disable
Default: disable
hrxq-status¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cosq-stats¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
queuing-buffer¶
Specification Type object enable
Description Enable/Disable micro-burst traffic support
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
cpu-map¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ports¶
Specification Type object link-detection-interval
Description Link detection interval in msecs
Type: number
Range: 50-60000
Default: 1000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
mfa-validation-type¶
Specification Type object ca-cert
Description Configure CA Certificate
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
core¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
app-performance¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
app-performance_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘total-throughput-bits-per-sec’: Total Throughput in bits/sec; ‘l4-conns-per-sec’: L4 Connections/sec; ‘l7-conns-per-sec’: L7 Connections/sec; ‘l7-trans-per-sec’: L7 Transactions/sec; ‘ssl-conns-per-sec’: SSL Connections/sec; ‘ip-nat-conns-per-sec’: IP NAT Connections/sec; ‘total-new-conns-per-sec’: Total New Connections Established/sec; ‘total-curr-conns’: Total Current Established Connections; ‘l4-bandwidth’: L4 Bandwidth in bits/sec; ‘l7-bandwidth’: L7 Bandwidth in bits/sec; ‘serv-ssl-conns-per-sec’: Server SSL Connections/sec; ‘fw-conns-per-sec’: FW Connections/sec; ‘gifw-conns-per-sec’: GiFW Connections/sec;
Type: string
Supported Values: all, total-throughput-bits-per-sec, l4-conns-per-sec, l7-conns-per-sec, l7-trans-per-sec, ssl-conns-per-sec, ip-nat-conns-per-sec, total-new-conns-per-sec, total-curr-conns, l4-bandwidth, l7-bandwidth, serv-ssl-conns-per-sec, fw-conns-per-sec, gifw-conns-per-sec
counter-lib-accounting¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
inuse-port-list¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
control-cpu¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
password-policy¶
Specification Type object aging
Description ‘Strict’: Strict: Max Age-60 Days; ‘Medium’: Medium: Max Age- 90 Days; ‘Simple’: Simple: Max Age-120 Days;
Type: string
Supported Values: Strict, Medium, Simple
complexity
Description ‘Strict’: Strict: Min length:8, Min Lower Case:2, Min Upper Case:2, Min Numbers:2, Min Special Character:1; ‘Medium’: Medium: Min length:6, Min Lower Case:2, Min Upper Case:2, Min Numbers:1, Min Special Character:1; ‘Simple’: Simple: Min length:4, Min Lower Case:1, Min Upper Case:1, Min Numbers:1, Min Special Character:0;
Type: string
Supported Values: Strict, Medium, Simple
history
Description ‘Strict’: Strict: Does not allow upto 5 old passwords; ‘Medium’: Medium: Does not allow upto 4 old passwords; ‘Simple’: Simple: Does not allow upto 3 old passwords;
Type: string
Supported Values: Strict, Medium, Simple
min-pswd-len
Description Configure custom password length
Type: number
Range: 8-63
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tcp-syn-per-sec¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
radius¶
Specification Type object server
Description: server is a JSON Block. Please see below for radius_server
Type: Object
Reference Object: /axapi/v3/system/radius/server
radius_server¶
Specification Type object accounting-interim-update
Description ‘ignore’: Ignore (default); ‘append-entry’: Append the AVPs to existing entry; ‘replace-entry’: Replace the AVPs of existing entry;
Type: string
Supported Values: ignore, append-entry, replace-entry
Default: ignore
accounting-on
Description ‘ignore’: Ignore (default); ‘delete-entries-using-attribute’: Delete entries matching attribute in RADIUS Table;
Type: string
Supported Values: ignore, delete-entries-using-attribute
Default: ignore
accounting-start
Description ‘ignore’: Ignore; ‘append-entry’: Append the AVPs to existing entry (default); ‘replace-entry’: Replace the AVPs of existing entry;
Type: string
Supported Values: ignore, append-entry, replace-entry
Default: append-entry
accounting-stop
Description ‘ignore’: Ignore; ‘delete-entry’: Delete the entry (default); ‘delete-entry-and-sessions’: Delete the entry and data sessions associated(CGN only);
Type: string
Supported Values: ignore, delete-entry, delete-entry-and-sessions
Default: delete-entry
attribute
Type: Listattribute-name
Description ‘msisdn’: Clear using MSISDN; ‘imei’: Clear using IMEI; ‘imsi’: Clear using IMSI; ‘custom1’: Clear using CUSTOM1 attribute configured; ‘custom2’: Clear using CUSTOM2 attribute configured; ‘custom3’: Clear using CUSTOM3 attribute configured; ‘custom4’: Clear using CUSTOM4 attribute configured; ‘custom5’: Clear using CUSTOM5 attribute configured; ‘custom6’: Clear using CUSTOM6 attribute configured;
Type: string
Supported Values: msisdn, imei, imsi, custom1, custom2, custom3, custom4, custom5, custom6
Mutual Exclusion: attribute-name and custom-attribute-name are mutually exclusive
custom-attribute-name
Description Clear using customized attribute
Type: string
Maximum Length: 15 characters
Maximum Length: 1 characters
Mutual Exclusion: custom-attribute-name and attribute-name are mutually exclusive
disable-reply
Description Toggle option for RADIUS reply packet(Default: Accounting response will be sent)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)listen-port
Description Configure the listen port of RADIUS server (default 1813) (Port number)
Type: number
Range: 1024-65535
Default: 1813
remote
Description: remote is a JSON Block. Please see below for radius_server_remote
Type: Object
sampling-enable
Type: Listsecret
Description Configure shared secret
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
secret-string
Description The RADIUS secret
Type: string
Format: password
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vrid
Description Join a VRRP-A failover group
Type: number
Range: 1-31
radius_server_remote¶
Specification Type object ip-list
Type: List
radius_server_remote_ip-list¶
Specification Type list Block object keys ip-list-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)ip-list-name
Description IP-list name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
ip-list-secret
Description Configure shared secret
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-list-secret-string
Description The RADIUS secret
Type: string
Format: password
Maximum Length: 127 characters
Maximum Length: 1 characters
radius_server_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘msisdn-received’: MSISDN Received; ‘imei-received’: IMEI Received; ‘imsi-received’: IMSI Received; ‘custom-received’: Custom attribute Received; ‘radius-request-received’: RADIUS Request Received; ‘radius-request-dropped’: RADIUS Request Dropped (Malformed Packet); ‘request-bad-secret-dropped’: RADIUS Request Bad Secret Dropped; ‘request-no-key-vap-dropped’: RADIUS Request No Key Attribute Dropped; ‘request-malformed-dropped’: RADIUS Request Malformed Dropped; ‘request-ignored’: RADIUS Request Ignored; ‘radius-table-full’: RADIUS Request Dropped (Table Full); ‘secret-not-configured-dropped’: RADIUS Secret Not Configured Dropped; ‘ha-standby-dropped’: HA Standby Dropped; ‘ipv6-prefix-length-mismatch’: Framed IPV6 Prefix Length Mismatch; ‘invalid-key’: Radius Request has Invalid Key Field; ‘smp-created’: RADIUS SMP Created; ‘smp-deleted’: RADIUS SMP Deleted; ‘smp-mem-allocated’: RADIUS SMP Memory Allocated; ‘smp-mem-alloc-failed’: RADIUS SMP Memory Allocation Failed; ‘smp-mem-freed’: RADIUS SMP Memory Freed; ‘smp-in-rml’: RADIUS SMP in RML; ‘mem-allocated’: RADIUS Memory Allocated; ‘mem-alloc-failed’: RADIUS Memory Allocation Failed; ‘mem-freed’: RADIUS Memory Freed; ‘ha-sync-create-sent’: HA Record Sync Create Sent; ‘ha-sync-delete-sent’: HA Record Sync Delete Sent; ‘ha-sync-create-recv’: HA Record Sync Create Received; ‘ha-sync-delete-recv’: HA Record Sync Delete Received; ‘acct-on-filters-full’: RADIUS Acct On Request Ignored(Filters Full); ‘acct-on-dup-request’: Duplicate RADIUS Acct On Request; ‘ip-mismatch-delete’: Radius Entry IP Mismatch Delete; ‘ip-add-race-drop’: Radius Entry IP Add Race Drop; ‘ha-sync-no-key-vap-dropped’: HA Record Sync No key dropped; ‘inter-card-msg-fail-drop’: Inter-Card Message Fail Drop; ‘radius-packets-redirected’: RADIUS packets redirected (SO); ‘radius-packets-redirect-fail-dropped’: RADIUS packets dropped due to redirect failure (SO); ‘radius-packets-process-local’: RADIUS packets processed locally without redirection (SO); ‘radius-packets-dropped-not-lo’: RADIUS packets dropped dest not loopback (SO); ‘radius-inter-card-dup-redir’: RADIUS packet dropped as redirected by other blade (SO);
Type: string
Supported Values: all, msisdn-received, imei-received, imsi-received, custom-received, radius-request-received, radius-request-dropped, request-bad-secret-dropped, request-no-key-vap-dropped, request-malformed-dropped, request-ignored, radius-table-full, secret-not-configured-dropped, ha-standby-dropped, ipv6-prefix-length-mismatch, invalid-key, smp-created, smp-deleted, smp-mem-allocated, smp-mem-alloc-failed, smp-mem-freed, smp-in-rml, mem-allocated, mem-alloc-failed, mem-freed, ha-sync-create-sent, ha-sync-delete-sent, ha-sync-create-recv, ha-sync-delete-recv, acct-on-filters-full, acct-on-dup-request, ip-mismatch-delete, ip-add-race-drop, ha-sync-no-key-vap-dropped, inter-card-msg-fail-drop, radius-packets-redirected, radius-packets-redirect-fail-dropped, radius-packets-process-local, radius-packets-dropped-not-lo, radius-inter-card-dup-redir
radius_server_attribute¶
Specification Type list Block object keys attribute-value
Description ‘inside-ipv6-prefix’: Framed IPv6 Prefix; ‘inside-ip’: Inside IP address; ‘inside-ipv6’: Inside IPv6 address; ‘imei’: International Mobile Equipment Identity (IMEI); ‘imsi’: International Mobile Subscriber Identity (IMSI); ‘msisdn’: Mobile Subscriber Integrated Services Digital Network-Number (MSISDN); ‘custom1’: Customized attribute 1; ‘custom2’: Customized attribute 2; ‘custom3’: Customized attribute 3; ‘custom4’: Customized attribute 4; ‘custom5’: Customized attribute 5; ‘custom6’: Customized attribute 6;
Type: string
Supported Values: inside-ipv6-prefix, inside-ip, inside-ipv6, imei, imsi, msisdn, custom1, custom2, custom3, custom4, custom5, custom6
custom-number
Description RADIUS attribute number
Type: number
Range: 1-255
custom-vendor
Description RADIUS vendor attribute information (RADIUS vendor ID)
Type: number
Range: 1-65535
name
Description Customized attribute name
Type: string
Maximum Length: 15 characters
Maximum Length: 1 characters
number
Description RADIUS attribute number
Type: number
Range: 1-255
prefix-length
Description ‘32’: Prefix length 32; ‘48’: Prefix length 48; ‘64’: Prefix length 64; ‘80’: Prefix length 80; ‘96’: Prefix length 96; ‘112’: Prefix length 112;
Type: string
Supported Values: 32, 48, 64, 80, 96, 112
prefix-number
Description RADIUS attribute number
Type: number
Range: 1-255
prefix-vendor
Description RADIUS vendor attribute information (RADIUS vendor ID)
Type: number
Range: 1-65535
value
Description ‘hexadecimal’: Type of attribute value is hexadecimal;
Type: string
Supported Values: hexadecimal
vendor
Description RADIUS vendor attribute information (RADIUS vendor ID)
Type: number
Range: 1-65535
modify-port¶
Specification Type object port-index
Description port index to be configured (Specify port index)
Type: number
Range: 0-32
port-number
Description port number to be configured (Specify port number)
Type: number
Range: 1-32
del-port¶
Specification Type object port-index
Description port index to be configured (Specify port index)
Type: number
Range: 0-32
management-interface-mode¶
Specification Type object dedicated
Description Set management interface in dedicated mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
non-dedicated
Description Set management interface in non-dedicated mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
mfa-cert-store¶
Specification Type object cert-host
Description Configure certificate store host
Type: string
Format: host
cert-store-path
Description Configure certificate store path
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)passwd-string
Description Certificate store host password
Type: string
Format: password
Maximum Length: 128 characters
Maximum Length: 1 characters
protocol
Description ‘tftp’: Use tftp for connection; ‘ftp’: Use ftp for connection; ‘scp’: Use scp for connection; ‘http’: Use http for connection; ‘https’: Use https for connection; ‘sftp’: Use sftp for connection;
Type: string
Supported Values: tftp, ftp, scp, http, https, sftp
username
Description Certificate store host username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
reboot¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
domain-list-info¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-mac-scheme¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-mac-scheme-val
Description ‘hash-based’: Hash-based using the VE number; ‘round-robin’: Round Robin scheme; ‘system-mac’: Use system MAC address;
Type: string
Supported Values: hash-based, round-robin, system-mac
Default: hash-based
nsm-a10lb¶
Specification Type object kill
Description NSM will terminate a10lb if no response received
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
link-monitor¶
Specification Type object disable
Description Disable Link Monitoring
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable
Description Enable Link Monitoring
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
apps-global¶
Specification Type object log-session-on-established
Description Send TCP session creation log on completion of 3-way handshake
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
msl-time
Description Configure maximum session life, default is 2 seconds (1-39 seconds, default is 2 seconds)
Type: number
Range: 1-39
Default: 2
timer-wheel-walk-limit
Description Set timer wheel walk limit (0-1024, 0 is unlimited, default is 100)
Type: number
Range: 0-1024
Default: 100
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
multi-queue-support¶
Specification Type object enable
Description Enable Multi-Queue-Support
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
trunk¶
Specification Type object load-balance
Description: load-balance is a JSON Block. Please see below for trunk_load-balance
Type: Object
Reference Object: /axapi/v3/system/trunk/load-balance
trunk_load-balance¶
Specification Type object use-l3
Description Layer-3 Header based load balancing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-l3 and use-l4 are mutually exclusive
use-l4
Description Layer-3/4 Header based load balancing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-l4 and use-l3 are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
resource-usage¶
Specification Type object aflex-table-entry-count
Description Total aFleX table entry in the system (Total aFlex entry in the system)
Type: number
auth-portal-html-file-size
Description Specify maximum html file size for each html page in auth portal (in KB)
Type: number
Range: 4-120
Default: 20
auth-portal-image-file-size
Description Specify maximum image file size for default portal (in KB)
Type: number
Range: 1-80
Default: 6
auth-session-count
Description Total auth sessions in the system
Type: number
authz-policy-number
Description Specify the maximum number of authorization policies
Type: number
class-list-ac-entry-count
Description Total entries for AC class-list
Type: number
class-list-entry-count
Description Total entries for class-list
Type: number
class-list-ipv6-addr-count
Description Total IPv6 addresses for class-list
Type: number
ipsec-sa-number
Description Specify the maximum number of IPsec SA
Type: number
l4-session-count
Description Total Sessions in the System
Type: number
max-aflex-authz-collection-number
Description Specify the maximum number of collections supported by aFleX authorization
Type: number
Range: 256-4096
Default: 512
max-aflex-file-size
Description Set maximum aFleX file size (Maximum file size in KBytes, default is 32K)
Type: number
Range: 16-256
Default: 32
nat-pool-addr-count
Description Total configurable NAT Pool addresses in the System
Type: number
radius-table-size
Description Total configurable CGNV6 RADIUS Table entries
Type: number
ram-cache-memory-limit
Description Specify the maximum memory used by ram cache
Type: number
ssl-context-memory
Description Total SSL context memory needed in units of MB. Will be rounded to closest multiple of 2MB
Type: number
Range: 256-16384
Default: 2048
ssl-dma-memory
Description Total SSL DMA memory needed in units of MB. Will be rounded to closest multiple of 2MB
Type: number
Range: 32-2048
Default: 256
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
visibility
Description: visibility is a JSON Block. Please see below for resource-usage_visibility
Type: Object
Reference Object: /axapi/v3/system/resource-usage/visibility
waf-template-count
Description Total configurable WAF Templates in the System
Type: number
resource-usage_visibility¶
Specification Type object monitored-entity-count
Description Total number of monitored entities for visibility
Type: number
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ssl-scv-verify-crl-sign¶
Specification Type object enable
Description Enable verify CRL signature during SCV
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
throughput¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
throughput_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘global-system-throughput-bits-per-sec’: Global System throughput in bits/sec; ‘per-part-throughput-bits-per-sec’: Partition throughput in bits/sec;
Type: string
Supported Values: all, global-system-throughput-bits-per-sec, per-part-throughput-bits-per-sec
cm-update-file-name-ref¶
Specification Type object dest_name
Description bind dest name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
id
Description Specify unique Partition id
Type: number
source_name
Description bind source name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
spe-status¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
mfa-auth¶
Specification Type object second-factor
Description Input second factor paramter
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
username
Description Username for MFA validation
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
ssl-status¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fpga-core-crc¶
Specification Type object monitor-disable
Description Disable FPGA Core CRC error monitoring and act on it
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
reboot-enable
Description Enable system reboot if system encounters FPGA Core CRC error
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
tls-1-3-mgmt¶
Specification Type object enable
Description Enable TLS 1.3 support on ACOS management plane
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
cpu-load-sharing¶
Specification Type object cpu-usage
Description: cpu-usage is a JSON Block. Please see below for cpu-load-sharing_cpu-usage
Type: Object
disable
Description Disable CPU load sharing in overload situations
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
packets-per-second
Description: packets-per-second is a JSON Block. Please see below for cpu-load-sharing_packets-per-second
Type: Object
tcp
Description Disallow redistribution of new TCP sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
udp
Description Disallow redistribution of new UDP sessions
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
cpu-load-sharing_cpu-usage¶
Specification Type object high
Description CPU usage threshold (percentage) that will trigger the redistribution (default: 75)
Type: number
Range: 0-100
Default: 75
low
Description CPU usage threshold (percentage) that will restore the normal packet distribution (default: 60)
Type: number
Range: 0-100
Default: 60
cpu-load-sharing_packets-per-second¶
Specification Type object min
Description Minimum packets-per-second threshold (per CPU) before redistribution will take effect (Minimum packets-per-second threshold (per CPU) before redistribution will take effect (default: 100000))
Type: number
Range: 0-30000000
Default: 100000
geoloc-list-list¶
Specification Type list Block object keys exclude-geoloc-name-list
Type: Listinclude-geoloc-name-list
Type: Listname
Description Specify name of Geolocation list
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
sampling-enable
Type: Listshared
Description Enable sharing with other partitions
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
geoloc-list-list_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘hit-count’: some help string; ‘total-geoloc’: some help string; ‘total-active’: some help string;
Type: string
Supported Values: all, hit-count, total-geoloc, total-active
geoloc-list-list_include-geoloc-name-list¶
Specification Type list Block object keys include-geoloc-name-val
Description Geolocation name to add
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
geoloc-list-list_exclude-geoloc-name-list¶
Specification Type list Block object keys exclude-geoloc-name-val
Description Geolocation name to exclude
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
shutdown¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-stats¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-stats_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘inreceives’: Incoming packets received; ‘inhdrerrors’: Incoming packet header errors; ‘intoobigerrors’: Incoming packet too big errors; ‘innoroutes’: Incoming no route packet drops; ‘inaddrerrors’: Incoming packet address errors; ‘inunknownprotos’: Incoming unkown protocol packet drops; ‘intruncatedpkts’: Incoming truncated packets; ‘indiscards’: Incoming packets discarded; ‘indelivers’: Incoming packets delivered; ‘outforwdatagrams’: Outgoing forwarded datagrams; ‘outrequests’: Outgoing packets; ‘outdiscards’: Outgoing packets discarded; ‘outnoroutes’: Outgoing no route packet drops; ‘reasmtimeout’: Reassembly timed out packet drops; ‘reasmreqds’: Incoming reassembly requests; ‘reasmoks’: Incoming reassembled packets; ‘reasmfails’: Incoming reassembly requests failed; ‘fragoks’: Outgoing packets fragmented; ‘fragfails’: Outgoing packets fragmentation failed; ‘fragcreates’: Outgoing fragmented packets; ‘inmcastpkts’: Incoming multicast packets; ‘outmcastpkts’: Outgoing multicast packets;
Type: string
Supported Values: all, inreceives, inhdrerrors, intoobigerrors, innoroutes, inaddrerrors, inunknownprotos, intruncatedpkts, indiscards, indelivers, outforwdatagrams, outrequests, outdiscards, outnoroutes, reasmtimeout, reasmreqds, reasmoks, reasmfails, fragoks, fragfails, fragcreates, inmcastpkts, outmcastpkts
ip6-stats¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip6-stats_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘inreceives’: Incoming packets received; ‘inhdrerrors’: Incoming packet header errors; ‘intoobigerrors’: Incoming packet too big errors; ‘innoroutes’: Incoming no route packet drops; ‘inaddrerrors’: Incoming packet address errors; ‘inunknownprotos’: Incoming unkown protocol packet drops; ‘intruncatedpkts’: Incoming truncated packets; ‘indiscards’: Incoming packets discarded; ‘indelivers’: Incoming packets delivered; ‘outforwdatagrams’: Outgoing forwarded datagrams; ‘outrequests’: Outgoing packets; ‘outdiscards’: Outgoing packets discarded; ‘outnoroutes’: Outgoing no route packet drops; ‘reasmtimeout’: Reassembly timed out packet drops; ‘reasmreqds’: Incoming reassembly requests; ‘reasmoks’: Incoming reassembled packets; ‘reasmfails’: Incoming reassembly requests failed; ‘fragoks’: Outgoing packets fragmented; ‘fragfails’: Outgoing packets fragmentation failed; ‘fragcreates’: Outgoing fragmented packets; ‘inmcastpkts’: Incoming multicast packets; ‘outmcastpkts’: Outgoing multicast packets;
Type: string
Supported Values: all, inreceives, inhdrerrors, intoobigerrors, innoroutes, inaddrerrors, inunknownprotos, intruncatedpkts, indiscards, indelivers, outforwdatagrams, outrequests, outdiscards, outnoroutes, reasmtimeout, reasmreqds, reasmoks, reasmfails, fragoks, fragfails, fragcreates, inmcastpkts, outmcastpkts
io-cpu¶
Specification Type object max-cores
Description max number of IO cores (Specify number of cores)
Type: number
Range: 0-128
dns¶
Specification Type object recursive-nameserver
Description: recursive-nameserver is a JSON Block. Please see below for dns_recursive-nameserver
Type: Object
Reference Object: /axapi/v3/system/dns/recursive-nameserver
sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘slb_req’: No. of requests; ‘slb_resp’: No. of responses; ‘slb_no_resp’: No. of requests with no response; ‘slb_req_rexmit’: No. of requests retransmit; ‘slb_resp_no_match’: No. of requests and responses with no match; ‘slb_no_resource’: No. of resource failures; ‘nat_req’: (NAT) No. of requests; ‘nat_resp’: (NAT) No. of responses; ‘nat_no_resp’: (NAT) No. of resource failures; ‘nat_req_rexmit’: (NAT) No. of request retransmits; ‘nat_resp_no_match’: (NAT) No. of requests with no response; ‘nat_no_resource’: (NAT) No. of resource failures; ‘nat_xid_reused’: (NAT) No. of requests reusing a transaction id; ‘filter_type_drop’: Total Query Type Drop; ‘filter_class_drop’: Total Query Class Drop; ‘filter_type_any_drop’: Total Query ANY Type Drop; ‘slb_dns_client_ssl_succ’: No. of client ssl success; ‘slb_dns_server_ssl_succ’: No. of server ssl success; ‘slb_dns_udp_conn’: No. of backend udp connections; ‘slb_dns_udp_conn_succ’: No. of backend udp conn established; ‘slb_dns_padding_to_server_removed’: some help string; ‘slb_dns_padding_to_client_added’: some help string; ‘slb_dns_edns_subnet_to_server_removed’: some help string; ‘slb_dns_udp_retransmit’: some help string; ‘slb_dns_udp_retransmit_fail’: some help string; ‘rpz_action_drop’: RPZ Action Drop; ‘rpz_action_pass_thru’: RPZ Action Pass Through; ‘rpz_action_tcp_only’: RPZ Action TCP Only; ‘rpz_action_nxdomain’: RPZ Action NXDOMAIN; ‘rpz_action_nodata’: RPZ Action NODATA; ‘rpz_action_local_data’: RPZ Action Local Data; ‘slb_drop’: DNS requests drop; ‘nat_slb_drop’: (NAT)DNS requests drop; ‘invalid_q_len_to_udp’: invalid query length to conver to UDP;
Type: string
Supported Values: all, slb_req, slb_resp, slb_no_resp, slb_req_rexmit, slb_resp_no_match, slb_no_resource, nat_req, nat_resp, nat_no_resp, nat_req_rexmit, nat_resp_no_match, nat_no_resource, nat_xid_reused, filter_type_drop, filter_class_drop, filter_type_any_drop, slb_dns_client_ssl_succ, slb_dns_server_ssl_succ, slb_dns_udp_conn, slb_dns_udp_conn_succ, slb_dns_padding_to_server_removed, slb_dns_padding_to_client_added, slb_dns_edns_subnet_to_server_removed, slb_dns_udp_retransmit, slb_dns_udp_retransmit_fail, rpz_action_drop, rpz_action_pass_thru, rpz_action_tcp_only, rpz_action_nxdomain, rpz_action_nodata, rpz_action_local_data, slb_drop, nat_slb_drop, invalid_q_len_to_udp
dns_recursive-nameserver¶
Specification Type object follow-shared
Description Use the configured name servers of shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns_recursive-nameserver_server-list¶
Specification Type list Block object keys ipv4-addr
Description Specify IPv4 server address
Type: string
Format: ipv4-address
ipv6-addr
Description Specify IPv6 server address
Type: string
Format: ipv6-address
v4-desc
Description Description for this ipv4 address
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
v6-desc
Description Description for this ipv6 address
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
memory¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
memory_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘usage-percentage’: Memory Usage percentage;
Type: string
Supported Values: all, usage-percentage
cpu-hyper-thread¶
Specification Type object disable
Description Disable CPU Hyperthreading
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable
Description Enable CPU Hyperthreading
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ssl-scv¶
Specification Type object enable
Description Enable server certificate validation for all SSL connections
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
ssl-set-compatible-cipher¶
Specification Type object disable
Description Disable setting common cipher suite in management plane
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
spe-profile¶
Specification Type object action
Description ‘ipv4-only’: Enable IPv4 HW forward entries only; ‘ipv6-only’: Enable IPv6 HW forward entries only; ‘ipv4-ipv6’: Enable Both IPv4/IPv6 HW forward entries (shared);
Type: string
Supported Values: ipv4-only, ipv6-only, ipv4-ipv6
Default: ipv4-ipv6
add-cpu-core¶
Specification Type object core-index
Description core index to be added (Specify core index)
Type: number
Range: 0-128
cpu-list¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘num’: Total number; ‘inmsgs’: In Messages; ‘inerrors’: In Errors; ‘indestunreachs’: In Destination Unreachable; ‘intimeexcds’: In TTL Exceeds; ‘inparmprobs’: In Parameter Problem; ‘insrcquenchs’: In Source Quench Error; ‘inredirects’: In Redirects; ‘inechos’: In Echo requests; ‘inechoreps’: In Echo replies; ‘intimestamps’: In Timestamp; ‘intimestampreps’: In Timestamp Rep; ‘inaddrmasks’: In Address Masks; ‘inaddrmaskreps’: In Address Mask Rep; ‘outmsgs’: Out Message; ‘outerrors’: Out Errors; ‘outdestunreachs’: Out Destination Unreachable; ‘outtimeexcds’: Out TTL Exceeds; ‘outparmprobs’: Out Parameter Problem; ‘outsrcquenchs’: Out Source Quench Error; ‘outredirects’: Out Redirects; ‘outechos’: Out Echo Requests; ‘outechoreps’: Out Echo Replies; ‘outtimestamps’: Out Time Stamp; ‘outtimestampreps’: Out Time Stamp Rep; ‘outaddrmasks’: Out Address Mask; ‘outaddrmaskreps’: Out Address Mask Rep;
Type: string
Supported Values: all, num, inmsgs, inerrors, indestunreachs, intimeexcds, inparmprobs, insrcquenchs, inredirects, inechos, inechoreps, intimestamps, intimestampreps, inaddrmasks, inaddrmaskreps, outmsgs, outerrors, outdestunreachs, outtimeexcds, outparmprobs, outsrcquenchs, outredirects, outechos, outechoreps, outtimestamps, outtimestampreps, outaddrmasks, outaddrmaskreps
gui-image-list¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
hardware-forward¶
Specification Type object sampling-enable
Type: Listslb
Description: slb is a JSON Block. Please see below for hardware-forward_slb
Type: Object
Reference Object: /axapi/v3/system/hardware-forward/slb
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
hardware-forward_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘hit-counts’: Total packts hit counts; ‘hit-index’: HW Fwd hit index; ‘ipv4-forward-counts’: Total IPv4 hardware forwarded packets; ‘ipv6-forward-counts’: Total IPv6 hardware forwarded packets; ‘hw-fwd-module-status’: hardware forwarder status flags; ‘hw-fwd-prog-reqs’: hardware forward programming requests; ‘hw-fwd-prog-errors’: hardware forward programming Errors; ‘hw-fwd-flow-singlebit-errors’: hardware forward singlebit Errors; ‘hw-fwd-flow-tag-mismatch’: hardware forward tag mismatch errors; ‘hw-fwd-flow-seq-mismatch’: hardware forward sequence mismatch errors; ‘hw-fwd-ageout-drop-count’: hardware forward ageout drop count; ‘hw-fwd-invalidation-drop’: hardware forward invalid drop count; ‘hw-fwd-flow-hit-index’: hardware forward flow hit index; ‘hw-fwd-flow-reason-flags’: hardware forward flow reason flags; ‘hw-fwd-flow-drop-count’: hardware forward flow drop count; ‘hw-fwd-flow-error-count’: hardware forward flow error count; ‘hw-fwd-flow-unalign-count’: hardware forward flow unalign count; ‘hw-fwd-flow-underflow-count’: hardware forward flow underflow count; ‘hw-fwd-flow-tx-full-drop’: hardware forward flow tx full drop count; ‘hw-fwd-flow-qdr-full-drop’: hardware forward flow qdr full drop count; ‘hw-fwd-phyport-mismatch-drop’: hardware forward phyport mismatch count; ‘hw-fwd-vlanid-mismatch-drop’: hardware forward vlanid mismatch count; ‘hw-fwd-vmid-drop’: hardware forward vmid mismatch count; ‘hw-fwd-protocol-mismatch-drop’: hardware forward protocol mismatch count; ‘hw-fwd-avail-ipv4-entry’: hardware forward available ipv4 entries count; ‘hw-fwd-avail-ipv6-entry’: hardware forward available ipv6 entries count;
Type: string
Supported Values: all, hit-counts, hit-index, ipv4-forward-counts, ipv6-forward-counts, hw-fwd-module-status, hw-fwd-prog-reqs, hw-fwd-prog-errors, hw-fwd-flow-singlebit-errors, hw-fwd-flow-tag-mismatch, hw-fwd-flow-seq-mismatch, hw-fwd-ageout-drop-count, hw-fwd-invalidation-drop, hw-fwd-flow-hit-index, hw-fwd-flow-reason-flags, hw-fwd-flow-drop-count, hw-fwd-flow-error-count, hw-fwd-flow-unalign-count, hw-fwd-flow-underflow-count, hw-fwd-flow-tx-full-drop, hw-fwd-flow-qdr-full-drop, hw-fwd-phyport-mismatch-drop, hw-fwd-vlanid-mismatch-drop, hw-fwd-vmid-drop, hw-fwd-protocol-mismatch-drop, hw-fwd-avail-ipv4-entry, hw-fwd-avail-ipv6-entry
hardware-forward_slb¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
hardware-forward_slb_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘entry-create’: Hardware Entries Created; ‘entry-create-failure’: Hardware Entries Created; ‘entry-create-fail-server-down’: Hardware Entries Created; ‘entry-create-fail-max-entry’: Hardware Entries Created; ‘entry-free’: Hardware Entries Freed; ‘entry-free-opp-entry’: Hardware Entries Free due to opposite tuple entry ageout event; ‘entry-free-no-hw-prog’: Hardware Entry Free no hw prog; ‘entry-free-no-conn’: Hardware Entry Free no matched conn; ‘entry-free-no-sw-entry’: Hardware Entry Free no software entry; ‘entry-counter’: Hardware Entry Count; ‘entry-age-out’: Hardware Entries Aged Out; ‘entry-age-out-idle’: Hardware Entries Aged Out Idle; ‘entry-age-out-tcp-fin’: Hardware Entries Aged Out TCP FIN; ‘entry-age-out-tcp-rst’: Hardware Entries Aged Out TCP RST; ‘entry-age-out-invalid-dst’: Hardware Entries Aged Out invalid dst; ‘entry-force-hw-invalidate’: Hardware Entries Force HW Invalidate; ‘entry-invalidate-server-down’: Hardware Entries Invalidate due to server down; ‘tcam-create’: TCAM Entries Created; ‘tcam-free’: TCAM Entries Freed; ‘tcam-counter’: TCAM Entry Count;
Type: string
Supported Values: all, entry-create, entry-create-failure, entry-create-fail-server-down, entry-create-fail-max-entry, entry-free, entry-free-opp-entry, entry-free-no-hw-prog, entry-free-no-conn, entry-free-no-sw-entry, entry-counter, entry-age-out, entry-age-out-idle, entry-age-out-tcp-fin, entry-age-out-tcp-rst, entry-age-out-invalid-dst, entry-force-hw-invalidate, entry-invalidate-server-down, tcam-create, tcam-free, tcam-counter
tcp-stats¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tcp-stats_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘connattempt’: Connect initiated; ‘connects’: Connect established; ‘drops’: Connect dropped; ‘conndrops’: Embryonic connect dropped; ‘closed’: Connect closed; ‘segstimed’: Segs to get RTT; ‘rttupdated’: Update RTT; ‘delack’: Delayed acks sent; ‘timeoutdrop’: Conn dropped in rxmt timeout; ‘rexmttimeo’: Retransmit timeout; ‘persisttimeo’: Persist timeout; ‘keeptimeo’: Keepalive timeout; ‘keepprobe’: Keepalive probe sent; ‘keepdrops’: Connect dropped in keepalive; ‘sndtotal’: Total packet sent; ‘sndpack’: Data packet sent; ‘sndbyte’: Data bytes sent; ‘sndrexmitpack’: Data packet retransmit; ‘sndrexmitbyte’: Data byte retransmit; ‘sndrexmitbad’: Unnecessary packet retransmit; ‘sndacks’: Ack packet sent; ‘sndprobe’: Window probe sent; ‘sndurg’: URG packet sent; ‘sndwinup’: Window update packet sent; ‘sndctrl’: SYN|FIN|RST packet sent; ‘sndrst’: RST packet sent; ‘sndfin’: FIN packet sent; ‘sndsyn’: SYN packet sent; ‘rcvtotal’: Total packet received; ‘rcvpack’: Packet received; ‘rcvbyte’: Bytes received; ‘rcvbadoff’: Packet received with bad offset; ‘rcvmemdrop’: Packet dropped for lack of memory; ‘rcvduppack’: Duplicate packet received; ‘rcvdupbyte’: Duplicate bytes received; ‘rcvpartduppack’: Packet with some duplicate data; ‘rcvpartdupbyte’: Dup. bytes in part-dup. packets; ‘rcvoopack’: Out-of-order packet received; ‘rcvoobyte’: Out-of-order bytes received; ‘rcvpackafterwin’: Packets with data after window; ‘rcvbyteafterwin’: Bytes rcvd after window; ‘rcvwinprobe’: Rcvd window probe packet; ‘rcvdupack’: Rcvd duplicate acks; ‘rcvacktoomuch’: Rcvd acks for unsent data; ‘rcvackpack’: Rcvd ack packets; ‘rcvackbyte’: Bytes acked by rcvd acks; ‘rcvwinupd’: Rcvd window update packets; ‘pawsdrop’: Segments dropped due to PAWS; ‘predack’: Hdr predict for acks; ‘preddat’: Hdr predict for data pkts; ‘persistdrop’: Timeout in persist state; ‘badrst’: Ignored RST; ‘finwait2_drops’: Drop FIN_WAIT_2 connection after time limit; ‘sack_recovery_episode’: SACK recovery episodes; ‘sack_rexmits’: SACK rexmit segments; ‘sack_rexmit_bytes’: SACK rexmit bytes; ‘sack_rcv_blocks’: SACK received; ‘sack_send_blocks’: SACK sent; ‘sndcack’: Challenge ACK sent; ‘cacklim’: Challenge ACK limited; ‘reassmemdrop’: Packet dropped during reassembly; ‘reasstimeout’: Reassembly Time Out; ‘cc_idle’: Congestion control window set do to idle; ‘cc_reduce’: Congestion control window reduced by event; ‘rcvdsack’: Rcvd DSACK packets; ‘a2brcvwnd’: ATCP to BTCP receive window; ‘a2bsackpresent’: ATCP to BTCP SACK options present; ‘a2bdupack’: ATCP to BTCP Dup/OO ACK; ‘a2brxdata’: ATCP to BTCP Rxmitted data; ‘a2btcpoptions’: ATCP to BTCP unsupported TCP options; ‘a2boodata’: ATCP to BTCP oo data received; ‘a2bpartialack’: ATCP to BTCP partial ack received; ‘a2bfsmtransition’: ATCP to BTCP state machine transition; ‘a2btransitionnum’: ATCP to BTCP total transitions; ‘b2atransitionnum’: ATCP to BTCP total transitions; ‘bad_iochan’: IO Channel Modified; ‘atcpforward’: Adaptive TCP forward; ‘atcpsent’: Adaptive TCP sent; ‘atcprexmitsadrop’: Adaptive TCP transmit SA drops; ‘atcpsendbackack’: Adaptive TCP sendback ACK; ‘atcprexmit’: Adaptive TCP retransmits; ‘atcpbuffallocfail’: Adaptive TCP buffer allocation fails; ‘a2bappbuffering’: Transition to full stack on when application buffers too much data; ‘atcpsendfail’: Adaptive TCP sent fails; ‘earlyrexmit’: Early Retransmission sent; ‘mburstlim’: Maxburst limited tx; ‘a2bsndwnd’: ATCP to BTCP send window; ‘proxyheaderv1’: Proxy header v1; ‘proxyheaderv2’: Proxy header v2;
Type: string
Supported Values: all, connattempt, connects, drops, conndrops, closed, segstimed, rttupdated, delack, timeoutdrop, rexmttimeo, persisttimeo, keeptimeo, keepprobe, keepdrops, sndtotal, sndpack, sndbyte, sndrexmitpack, sndrexmitbyte, sndrexmitbad, sndacks, sndprobe, sndurg, sndwinup, sndctrl, sndrst, sndfin, sndsyn, rcvtotal, rcvpack, rcvbyte, rcvbadoff, rcvmemdrop, rcvduppack, rcvdupbyte, rcvpartduppack, rcvpartdupbyte, rcvoopack, rcvoobyte, rcvpackafterwin, rcvbyteafterwin, rcvwinprobe, rcvdupack, rcvacktoomuch, rcvackpack, rcvackbyte, rcvwinupd, pawsdrop, predack, preddat, persistdrop, badrst, finwait2_drops, sack_recovery_episode, sack_rexmits, sack_rexmit_bytes, sack_rcv_blocks, sack_send_blocks, sndcack, cacklim, reassmemdrop, reasstimeout, cc_idle, cc_reduce, rcvdsack, a2brcvwnd, a2bsackpresent, a2bdupack, a2brxdata, a2btcpoptions, a2boodata, a2bpartialack, a2bfsmtransition, a2btransitionnum, b2atransitionnum, bad_iochan, atcpforward, atcpsent, atcprexmitsadrop, atcpsendbackack, atcprexmit, atcpbuffallocfail, a2bappbuffering, atcpsendfail, earlyrexmit, mburstlim, a2bsndwnd, proxyheaderv1, proxyheaderv2
delete-cpu-core¶
Specification Type object core-index
Description core index to be deleted (Specify core index)
Type: number
Range: 0-128
geoloc-name-helper¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
geoloc-name-helper_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘place-holder’: place-holder;
Type: string
Supported Values: all, place-holder
shell-privileges¶
Specification Type object enable-shell-privileges
Description enable the shell privileges for a given customer
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
link-capability¶
Specification Type object enable
Description Enable/Disable link capabilities
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
timeout-value¶
Specification Type object ftp
Description set timeout to stop ftp transfer in seconds, 0 is no limit
Type: number
Range: 0-9999
Default: 120
http
Description set timeout to stop http transfer in seconds, 0 is no limit
Type: number
Range: 0-9999
Default: 0
https
Description set timeout to stop https transfer in seconds, 0 is no limit
Type: number
Range: 0-9999
Default: 0
scp
Description set timeout to stop scp transfer in seconds, 0 is no limit
Type: number
Range: 0-9999
Default: 300
sftp
Description set timeout to stop sftp transfer in seconds, 0 is no limit
Type: number
Range: 0-9999
Default: 0
tftp
Description set timeout to stop tftp transfer in seconds, 0 is no limit
Type: number
Range: 0-9999
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
asic-debug-dump¶
Specification Type object enable
Description Enable/Disable L2L3 ASIC traffic discard/drop events and Dump debug information
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
shm-logging¶
Specification Type object enable
Description Enable shared memory based logging
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
port-list¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
resource-accounting¶
Specification Type object template-list
Type: List
Reference Object: /axapi/v3/system/resource-accounting/template/{name}
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
resource-accounting_template-list¶
Specification Type list Block object keys app-resources
Description: app-resources is a JSON Block. Please see below for resource-accounting_template-list_app-resources
Type: Object
Reference Object: /axapi/v3/system/resource-accounting/template/{name}/app-resources
name
Description Enter template name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
network-resources
Description: network-resources is a JSON Block. Please see below for resource-accounting_template-list_network-resources
Type: Object
Reference Object: /axapi/v3/system/resource-accounting/template/{name}/network-resources
system-resources
Description: system-resources is a JSON Block. Please see below for resource-accounting_template-list_system-resources
Type: Object
Reference Object: /axapi/v3/system/resource-accounting/template/{name}/system-resources
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
resource-accounting_template-list_app-resources¶
Specification Type object cache-template-cfg
Description: cache-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_cache-template-cfg
Type: Object
client-ssl-template-cfg
Description: client-ssl-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_client-ssl-template-cfg
Type: Object
conn-reuse-template-cfg
Description: conn-reuse-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_conn-reuse-template-cfg
Type: Object
fast-tcp-template-cfg
Description: fast-tcp-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_fast-tcp-template-cfg
Type: Object
fast-udp-template-cfg
Description: fast-udp-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_fast-udp-template-cfg
Type: Object
fix-template-cfg
Description: fix-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_fix-template-cfg
Type: Object
gslb-device-cfg
Description: gslb-device-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-device-cfg
Type: Object
gslb-geo-location-cfg
Description: gslb-geo-location-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-geo-location-cfg
Type: Object
gslb-ip-list-cfg
Description: gslb-ip-list-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-ip-list-cfg
Type: Object
gslb-policy-cfg
Description: gslb-policy-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-policy-cfg
Type: Object
gslb-service-cfg
Description: gslb-service-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-service-cfg
Type: Object
gslb-service-ip-cfg
Description: gslb-service-ip-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-service-ip-cfg
Type: Object
gslb-service-port-cfg
Description: gslb-service-port-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-service-port-cfg
Type: Object
gslb-site-cfg
Description: gslb-site-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-site-cfg
Type: Object
gslb-svc-group-cfg
Description: gslb-svc-group-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-svc-group-cfg
Type: Object
gslb-template-cfg
Description: gslb-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-template-cfg
Type: Object
gslb-zone-cfg
Description: gslb-zone-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_gslb-zone-cfg
Type: Object
health-monitor-cfg
Description: health-monitor-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_health-monitor-cfg
Type: Object
http-template-cfg
Description: http-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_http-template-cfg
Type: Object
link-cost-template-cfg
Description: link-cost-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_link-cost-template-cfg
Type: Object
persist-cookie-template-cfg
Description: persist-cookie-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_persist-cookie-template-cfg
Type: Object
persist-srcip-template-cfg
Description: persist-srcip-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_persist-srcip-template-cfg
Type: Object
proxy-template-cfg
Description: proxy-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_proxy-template-cfg
Type: Object
real-port-cfg
Description: real-port-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_real-port-cfg
Type: Object
real-server-cfg
Description: real-server-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_real-server-cfg
Type: Object
server-ssl-template-cfg
Description: server-ssl-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_server-ssl-template-cfg
Type: Object
service-group-cfg
Description: service-group-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_service-group-cfg
Type: Object
stream-template-cfg
Description: stream-template-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_stream-template-cfg
Type: Object
threshold
Description Enter the threshold as a percentage (Threshold in percentage(default is 100%))
Type: number
Range: 1-99
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
virtual-port-cfg
Description: virtual-port-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_virtual-port-cfg
Type: Object
virtual-server-cfg
Description: virtual-server-cfg is a JSON Block. Please see below for resource-accounting_template-list_app-resources_virtual-server-cfg
Type: Object
resource-accounting_template-list_app-resources_http-template-cfg¶
Specification Type object http-template-max
Description Enter the number of http-template allowed (http-template count (default is max-value))
Type: number
http-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_server-ssl-template-cfg¶
Specification Type object server-ssl-template-max
Description Enter the number of server-ssl-template allowed (server-ssl-template count (default is max-value))
Type: number
server-ssl-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-template-cfg¶
Specification Type object gslb-template-max
Description Enter the number of gslb-template allowed (gslb-template count (default is max-value))
Type: number
gslb-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_virtual-server-cfg¶
Specification Type object virtual-server-max
Description Enter the number of virtual-servers allowed (virtual-server count (default is max-value))
Type: number
virtual-server-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-service-port-cfg¶
Specification Type object gslb-service-port-max
Description Enter the number of gslb-service-port allowed ( gslb-service-port count (default is max-value))
Type: number
gslb-service-port-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-site-cfg¶
Specification Type object gslb-site-max
Description Enter the number of gslb-site allowed (gslb-site count (default is max-value))
Type: number
gslb-site-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_proxy-template-cfg¶
Specification Type object proxy-template-max
Description Enter the number of proxy-template allowed (server-ssl-template count (default is max-value))
Type: number
proxy-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_real-server-cfg¶
Specification Type object real-server-max
Description Enter the number of real-servers allowed (real-server count (default is max-value))
Type: number
real-server-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_link-cost-template-cfg¶
Specification Type object link-cost-template-max
Description Enter the number of link-cost-template allowed (link-cost-template count (default is max-value))
Type: number
link-cost-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_client-ssl-template-cfg¶
Specification Type object client-ssl-template-max
Description Enter the number of client-ssl-template allowed (client-ssl-template count (default is max-value))
Type: number
client-ssl-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_health-monitor-cfg¶
Specification Type object health-monitor-max
Description Enter the number of health monitors allowed (health-monitor count (default is max-value))
Type: number
Range: 0-1023
health-monitor-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
Range: 0-1023
Default: 0
resource-accounting_template-list_app-resources_gslb-zone-cfg¶
Specification Type object gslb-zone-max
Description Enter the number of gslb-zone allowed (gslb-zone count (default is max-value))
Type: number
gslb-zone-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_conn-reuse-template-cfg¶
Specification Type object conn-reuse-template-max
Description Enter the number of conn-reuse-template allowed (conn-reuse-template count (default is max-value))
Type: number
conn-reuse-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-policy-cfg¶
Specification Type object gslb-policy-max
Description Enter the number of gslb-policy allowed (gslb-policy count (default is max-value))
Type: number
gslb-policy-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-service-cfg¶
Specification Type object gslb-service-max
Description Enter the number of gslb-service allowed (gslb-service count (default is max-value)
Type: number
gslb-service-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-geo-location-cfg¶
Specification Type object gslb-geo-location-max
Description Enter the number of gslb-geo-location allowed (gslb-geo-location count (default is max-value))
Type: number
gslb-geo-location-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_cache-template-cfg¶
Specification Type object cache-template-max
Description Enter the number of cache-template allowed (cache-template count (default is max-value))
Type: number
cache-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_persist-cookie-template-cfg¶
Specification Type object persist-cookie-template-max
Description Enter the number of persist-cookie-template allowed (persist-cookie-template count (default is max-value))
Type: number
persist-cookie-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_fix-template-cfg¶
Specification Type object fix-template-max
Description Enter the number of fix-template allowed (fix-template count (default is max-value))
Type: number
fix-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_fast-tcp-template-cfg¶
Specification Type object fast-tcp-template-max
Description Enter the number of fast-tcp-template allowed (fast-tcp-template count (default is max-value))
Type: number
fast-tcp-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_fast-udp-template-cfg¶
Specification Type object fast-udp-template-max
Description Enter the number of fast-udp-template allowed (fast-udp-template count (default is max-value))
Type: number
fast-udp-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-service-ip-cfg¶
Specification Type object gslb-service-ip-max
Description Enter the number of gslb-service-ip allowed (gslb-service-ip count (default is max-value))
Type: number
gslb-service-ip-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-svc-group-cfg¶
Specification Type object gslb-svc-group-max
Description Enter the number of gslb-svc-group allowed (gslb-svc-group count (default is max-value))
Type: number
gslb-svc-group-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_virtual-port-cfg¶
Specification Type object virtual-port-max
Description Enter the number of virtual-port allowed (virtual-port count (default is max-value))
Type: number
virtual-port-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_service-group-cfg¶
Specification Type object service-group-max
Description Enter the number of service groups allowed (service-group count (default is max-value))
Type: number
service-group-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-device-cfg¶
Specification Type object gslb-device-max
Description Enter the number of gslb-device allowed (gslb-device count (default is max-value))
Type: number
gslb-device-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_persist-srcip-template-cfg¶
Specification Type object persist-srcip-template-max
Description Enter the number of persist-srcip-template allowed (persist-source-ip-template count (default is max-value))
Type: number
persist-srcip-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_stream-template-cfg¶
Specification Type object stream-template-max
Description Enter the number of stream-template allowed (server-ssl-template count (default is max-value))
Type: number
stream-template-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_real-port-cfg¶
Specification Type object real-port-max
Description Enter the number of real-ports allowed (real-port count (default is max-value))
Type: number
real-port-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_app-resources_gslb-ip-list-cfg¶
Specification Type object gslb-ip-list-max
Description Enter the number of gslb-ip-list allowed (gslb-ip-list count (default is max-value))
Type: number
gslb-ip-list-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_system-resources¶
Specification Type object bw-limit-cfg
Description: bw-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_bw-limit-cfg
Type: Object
concurrent-session-limit-cfg
Description: concurrent-session-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_concurrent-session-limit-cfg
Type: Object
fwcps-limit-cfg
Description: fwcps-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_fwcps-limit-cfg
Type: Object
l4-session-limit-cfg
Description: l4-session-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_l4-session-limit-cfg
Type: Object
l4cps-limit-cfg
Description: l4cps-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_l4cps-limit-cfg
Type: Object
l7cps-limit-cfg
Description: l7cps-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_l7cps-limit-cfg
Type: Object
natcps-limit-cfg
Description: natcps-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_natcps-limit-cfg
Type: Object
ssl-throughput-limit-cfg
Description: ssl-throughput-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_ssl-throughput-limit-cfg
Type: Object
sslcps-limit-cfg
Description: sslcps-limit-cfg is a JSON Block. Please see below for resource-accounting_template-list_system-resources_sslcps-limit-cfg
Type: Object
threshold
Description Enter the threshold as a percentage (Threshold in percentage(default is 100%))
Type: number
Range: 1-99
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
resource-accounting_template-list_system-resources_l4-session-limit-cfg¶
Specification Type object l4-session-limit-max
Description Enter the l4 session limit in % (0.01% to 99.99%) (Enter a number from 0.01 to 99.99 (up to 2 digits precision))
Type: string
Maximum Length: 5 characters
Maximum Length: 1 characters
l4-session-limit-min-guarantee
Description minimum guaranteed value in % (up to 2 digits precision) (Enter a number from 0 to 99.99)
Type: string
Maximum Length: 5 characters
Maximum Length: 1 characters
Default: 0
resource-accounting_template-list_system-resources_l7cps-limit-cfg¶
Specification Type object l7cps-limit-max
Description L7cps-limit (L7 cps limit (no limits applied by default))
Type: number
Range: 100-300000
resource-accounting_template-list_system-resources_l4cps-limit-cfg¶
Specification Type object l4cps-limit-max
Description Enter the L4 cps limit (L4 cps limit (no limits applied by default))
Type: number
Range: 100-1000000
resource-accounting_template-list_system-resources_natcps-limit-cfg¶
Specification Type object natcps-limit-max
Description Enter the Nat cps limit (NAT cps limit (no limits applied by default))
Type: number
Range: 100-1000000
resource-accounting_template-list_system-resources_sslcps-limit-cfg¶
Specification Type object sslcps-limit-max
Description Enter the SSL cps limit (SSL cps limit (no limits applied by default))
Type: number
Range: 100-300000
resource-accounting_template-list_system-resources_fwcps-limit-cfg¶
Specification Type object fwcps-limit-max
Description Enter the Firewall cps limit (Firewall cps limit (no limits applied by default))
Type: number
Range: 100-1000000
resource-accounting_template-list_system-resources_ssl-throughput-limit-cfg¶
Specification Type object ssl-throughput-limit-max
Description Enter the ssl throughput limit in mbps (SSL Througput limit in Mbit/s (no limits applied by default))
Type: number
Range: 10-10000000
ssl-throughput-limit-watermark-disable
Description Disable watermark (90% drop, keep existing sessions, drop new sessions)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
resource-accounting_template-list_system-resources_bw-limit-cfg¶
Specification Type object bw-limit-max
Description Enter the bandwidth limit in mbps (Bandwidth limit in Mbit/s (no limits applied by default))
Type: number
Range: 10-10000000
bw-limit-watermark-disable
Description Disable watermark (90% drop, keep existing sessions, drop new sessions)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
resource-accounting_template-list_system-resources_concurrent-session-limit-cfg¶
Specification Type object concurrent-session-limit-max
Description Enter the Concurrent Session limit (cps) (Concurrent-Session cps limit (no limits applied by default))
Type: number
resource-accounting_template-list_network-resources¶
Specification Type object ipv4-acl-line-cfg
Description: ipv4-acl-line-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_ipv4-acl-line-cfg
Type: Object
ipv6-acl-line-cfg
Description: ipv6-acl-line-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_ipv6-acl-line-cfg
Type: Object
object-group-cfg
Description: object-group-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_object-group-cfg
Type: Object
object-group-clause-cfg
Description: object-group-clause-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_object-group-clause-cfg
Type: Object
static-arp-cfg
Description: static-arp-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_static-arp-cfg
Type: Object
static-ipv4-route-cfg
Description: static-ipv4-route-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_static-ipv4-route-cfg
Type: Object
static-ipv6-route-cfg
Description: static-ipv6-route-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_static-ipv6-route-cfg
Type: Object
static-mac-cfg
Description: static-mac-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_static-mac-cfg
Type: Object
static-neighbor-cfg
Description: static-neighbor-cfg is a JSON Block. Please see below for resource-accounting_template-list_network-resources_static-neighbor-cfg
Type: Object
threshold
Description Enter the threshold as a percentage (Threshold in percentage(default is 100%))
Type: number
Range: 1-99
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
resource-accounting_template-list_network-resources_static-ipv6-route-cfg¶
Specification Type object static-ipv6-route-max
Description Enter the number of static ipv6 routes allowed (Static ipv6 routes (default is max-value))
Type: number
static-ipv6-route-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_network-resources_object-group-clause-cfg¶
Specification Type object object-group-clause-max
Description Enter the number of object group clauses allowed (Object group clauses (default is max-value))
Type: number
Range: 0-8192000
object-group-clause-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
Range: 0-8192000
Default: 0
resource-accounting_template-list_network-resources_static-ipv4-route-cfg¶
Specification Type object static-ipv4-route-max
Description Enter the number of static ipv4 routes allowed (Static ipv4 routes (default is max-value))
Type: number
static-ipv4-route-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
resource-accounting_template-list_network-resources_static-arp-cfg¶
Specification Type object static-arp-max
Description Enter the number of static arp entries allowed (Static arp (default is max-value))
Type: number
Range: 0-128
static-arp-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
Range: 0-128
Default: 0
resource-accounting_template-list_network-resources_ipv4-acl-line-cfg¶
Specification Type object ipv4-acl-line-max
Description Enter the number of ACL lines allowed (IPV4 ACL lines (default is max-value))
Type: number
Range: 0-16000
ipv4-acl-line-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
Range: 0-16000
Default: 0
resource-accounting_template-list_network-resources_static-mac-cfg¶
Specification Type object static-mac-max
Description Enter the number of static MAC entries allowed (Static MACs (default is max-value))
Type: number
Range: 0-500
static-mac-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
Range: 0-500
Default: 0
resource-accounting_template-list_network-resources_ipv6-acl-line-cfg¶
Specification Type object ipv6-acl-line-max
Description Enter the number of ACL lines allowed (IPV6 ACL lines (default is max-value))
Type: number
Range: 0-16000
ipv6-acl-line-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
Range: 0-16000
Default: 0
resource-accounting_template-list_network-resources_static-neighbor-cfg¶
Specification Type object static-neighbor-max
Description Enter the number of static neighbor entries allowed (Static neighbors (default is max-value))
Type: number
Range: 0-128
static-neighbor-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
Range: 0-128
Default: 0
resource-accounting_template-list_network-resources_object-group-cfg¶
Specification Type object object-group-max
Description Enter the number of object groups allowed (Object group (default is max-value))
Type: number
Range: 0-8000
object-group-min-guarantee
Description Minimum guaranteed value ( Minimum guaranteed value)
Type: number
Range: 0-8000
Default: 0
ssl-scv-verify-host¶
Specification Type object disable
Description Disable verify host during SCV
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
hardware¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fpga-drop¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fpga-drop_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘mrx-drop’: Total MRX Drop; ‘hrx-drop’: Total HRX Drop; ‘siz-drop’: Total Size Drop; ‘fcs-drop’: Total FCS Drop; ‘land-drop’: Total LAND Attack Drop; ‘empty-frag-drop’: Total Empty frag Drop; ‘mic-frag-drop’: Total Micro frag Drop; ‘ipv4-opt-drop’: Total IPv4 opt Drop; ‘ipv4-frag’: Total IP frag Drop; ‘bad-ip-hdr-len’: Total Bad IP hdr len Drop; ‘bad-ip-flags-drop’: Total Bad IP Flags Drop; ‘bad-ip-ttl-drop’: Total Bad IP TTL Drop; ‘no-ip-payload-drop’: Total No IP Payload Drop; ‘oversize-ip-payload’: Total Oversize IP PL Drop; ‘bad-ip-payload-len’: Total Bad IP PL len Drop; ‘bad-ip-frag-offset’: Total Bad IP frag off Drop; ‘bad-ip-chksum-drop’: Total Bad IP csum Drop; ‘icmp-pod-drop’: Total ICMP POD Drop; ‘tcp-bad-urg-offet’: Total TCP bad urg off Drop; ‘tcp-short-hdr’: Total TCP short hdr Drop; ‘tcp-bad-ip-len’: Total TCP Bad IP Len Drop; ‘tcp-null-flags’: Total TCP null flags Drop; ‘tcp-null-scan’: Total TCP null scan Drop; ‘tcp-fin-sin’: Total TCP SYN&FIN Drop; ‘tcp-xmas-flags’: Total TCP XMAS FLAGS Drop; ‘tcp-xmas-scan’: Total TCP XMAS scan Drop; ‘tcp-syn-frag’: Total TCP SYN frag Drop; ‘tcp-frag-hdr’: Total TCP frag header Drop; ‘tcp-bad-chksum’: Total TCP bad csum Drop; ‘udp-short-hdr’: Total UDP short hdr Drop; ‘udp-bad-ip-len’: Total UDP bad leng Drop; ‘udp-kb-frags’: Total UDP KB frag Drop; ‘udp-port-lb’: Total UDP port LB Drop; ‘udp-bad-chksum’: Total UDP bad csum Drop; ‘runt-ip-hdr’: Total Runt IP hdr Drop; ‘runt-tcpudp-hdr’: Total Runt TCPUDP hdr Drop; ‘tun-mismatch’: Total Tun mismatch Drop; ‘qdr-drop’: Total QDR Drop;
Type: string
Supported Values: all, mrx-drop, hrx-drop, siz-drop, fcs-drop, land-drop, empty-frag-drop, mic-frag-drop, ipv4-opt-drop, ipv4-frag, bad-ip-hdr-len, bad-ip-flags-drop, bad-ip-ttl-drop, no-ip-payload-drop, oversize-ip-payload, bad-ip-payload-len, bad-ip-frag-offset, bad-ip-chksum-drop, icmp-pod-drop, tcp-bad-urg-offet, tcp-short-hdr, tcp-bad-ip-len, tcp-null-flags, tcp-null-scan, tcp-fin-sin, tcp-xmas-flags, tcp-xmas-scan, tcp-syn-frag, tcp-frag-hdr, tcp-bad-chksum, udp-short-hdr, udp-bad-ip-len, udp-kb-frags, udp-port-lb, udp-bad-chksum, runt-ip-hdr, runt-tcpudp-hdr, tun-mismatch, qdr-drop
all-vlan-limit¶
Specification Type object bcast
Description broadcast packets (per second limit)
Type: number
Range: 1-65535
Default: 5000
ipmcast
Description IP multicast packets (per second limit)
Type: number
Range: 1-65535
Default: 5000
mcast
Description multicast packets (per second limit)
Type: number
Range: 1-65535
Default: 5000
unknown-ucast
Description unknown unicast packets (per second limit)
Type: number
Range: 1-65535
Default: 5000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
guest-file¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
high-memory-l4-session¶
Specification Type object enable
Description Enable/Disable high memory l4 session support
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
per-vlan-limit¶
Specification Type object bcast
Description broadcast packets (per second limit)
Type: number
Range: 1-65535
Default: 1000
ipmcast
Description IP multicast packets (per second limit)
Type: number
Range: 1-65535
Default: 1000
mcast
Description multicast packets (per second limit)
Type: number
Range: 1-65535
Default: 1000
unknown-ucast
Description unknown unicast packets (per second limit)
Type: number
Range: 1-65535
Default: 1000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
deep-hrxq¶
Specification Type object enable
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cosq-show¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
set-rxtx-queue¶
Specification Type object port-index
Description port index to be configured (Specify port index)
Type: number
Range: 0-32
rxq-size
Description Set number of new rx queues
Type: number
Range: 0-1024
txq-size
Description Set number of new tx queues
Type: number
Range: 0-1024
syslog-time-msec¶
Specification Type object enable-flag
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipmi-service¶
Specification Type object disable
Description Disable IPMI on platform
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
data-cpu¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns-cache¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns-cache_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘total_q’: Total query; ‘total_r’: Total server response; ‘hit’: Total cache hit; ‘bad_q’: Query not passed; ‘encode_q’: Query encoded; ‘multiple_q’: Query with multiple questions; ‘oversize_q’: Query exceed cache size; ‘bad_r’: Response not passed; ‘oversize_r’: Response exceed cache size; ‘encode_r’: Response encoded; ‘multiple_r’: Response with multiple questions; ‘answer_r’: Response with multiple answers; ‘ttl_r’: Response with short TTL; ‘ageout’: Total aged out; ‘bad_answer’: Bad Answer; ‘ageout_weight’: Total aged for lower weight; ‘total_log’: Total stats log sent; ‘total_alloc’: Total allocated; ‘total_freed’: Total freed; ‘current_allocate’: Current allocate; ‘current_data_allocate’: Current data allocate; ‘resolver_queue_full’: Resolver task queue full; ‘truncated_r’: Response with Truncation bit set;
Type: string
Supported Values: all, total_q, total_r, hit, bad_q, encode_q, multiple_q, oversize_q, bad_r, oversize_r, encode_r, multiple_r, answer_r, ttl_r, ageout, bad_answer, ageout_weight, total_log, total_alloc, total_freed, current_allocate, current_data_allocate, resolver_queue_full, truncated_r
set-tcp-syn-per-sec¶
Specification Type object tcp-syn-value
Description Configure Tcp SYN’s per sec, default 70
Type: number
Range: 25-6000
Default: 70
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fw¶
Specification Type object application-flow
Description Number of flows
Type: number
application-mempool
Description Enable application memory pool
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
basic-dpi-enable
Description Enable basic dpi
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-dns-cache¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
mon-template¶
Specification Type object link-block-as-down
Description: link-block-as-down is a JSON Block. Please see below for mon-template_link-block-as-down
Type: Object
Reference Object: /axapi/v3/system/mon-template/link-block-as-down
link-down-on-restart
Description: link-down-on-restart is a JSON Block. Please see below for mon-template_link-down-on-restart
Type: Object
Reference Object: /axapi/v3/system/mon-template/link-down-on-restart
monitor-list
Type: List
Reference Object: /axapi/v3/system/mon-template/monitor/{id}
mon-template_link-down-on-restart¶
Specification Type object enable
Description
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
mon-template_monitor-list¶
Specification Type list Block object keys clear-cfg
Type: Listid
Description Monitor template ID Number
Type: number
Range: 1-16
link-disable-cfg
Type: Listlink-down-cfg
Type: Listlink-enable-cfg
Type: Listlink-up-cfg
Type: Listmonitor-relation
Description ‘monitor-and’: Configures the monitors in current template to work with AND logic; ‘monitor-or’: Configures the monitors in current template to work with OR logic;
Type: string
Supported Values: monitor-and, monitor-or
Default: monitor-and
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
mon-template_monitor-list_clear-cfg¶
Specification Type list Block object keys clear-all-sequence
Description Sequence number (Specify the port physical port number)
Type: number
Range: 1-16
clear-sequence
Description Specify the port physical port number
Type: number
Range: 1-16
sessions
Description ‘all’: Clear all sessions; ‘sequence’: Sequence number;
Type: string
Supported Values: all, sequence
mon-template_monitor-list_link-enable-cfg¶
Specification Type list Block object keys ena-sequence
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
enaeth
Description Specify the physical port number (Ethernet interface number)
Type: number
Format: interface
mon-template_monitor-list_link-up-cfg¶
Specification Type list Block object keys link-up-sequence1
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
link-up-sequence2
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
link-up-sequence3
Description Sequence number (Specify the sequece number)
Type: number
Range: 1-16
linkup-ethernet1
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
linkup-ethernet2
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
linkup-ethernet3
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
mon-template_monitor-list_link-down-cfg¶
Specification Type list Block object keys link-down-sequence1
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
link-down-sequence2
Description Sequence number (Specify the seqeuence number)
Type: number
Range: 1-16
link-down-sequence3
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
linkdown-ethernet1
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
linkdown-ethernet2
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
linkdown-ethernet3
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
mon-template_monitor-list_link-disable-cfg¶
Specification Type list Block object keys dis-sequence
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
diseth
Description Specify the physical port number (Ethernet interface number)
Type: number
Format: interface
mon-template_link-block-as-down¶
Specification Type object enable
Description
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
dpdk-stats¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dpdk-stats_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘pkt-drop’: Total packet drop; ‘pkt-lnk-down-drop’: Total packets link down drop; ‘err-pkt-drop’: Total error packet drop; ‘rx-err’: Total RX packet error; ‘tx-err’: Total TX packet error; ‘tx-drop’: Total TX packet drop; ‘rx-len-err’: Total RX packet length error; ‘rx-over-err’: Total RX packet over error; ‘rx-crc-err’: Total RX packet CRC error; ‘rx-frame-err’: Total RX packet frame error; ‘rx-no-buff-err’: Total RX packet no buffer error; ‘rx-miss-err’: Total RX packet miss error; ‘tx-abort-err’: Total TX packet abort error; ‘tx-carrier-err’: Total TX packert carrier error; ‘tx-fifo-err’: Total TX packet fifo error; ‘tx-hbeat-err’: Total TX packet HBEAT error; ‘tx-windows-err’: Total TX windows error; ‘rx-long-len-err’: Total RX packet long length error; ‘rx-short-len-err’: Total RX packet short length error; ‘rx-align-err’: Total RX packet align error; ‘rx-csum-offload-err’: Total Rx packet check-sum offload error; ‘io-rx-que-drop’: Total IO core Rx queue drop; ‘io-tx-que-drop’: Total IO core TX queue drop; ‘io-ring-drop’: Total IO core ring drop; ‘w-tx-que-drop’: Total worker core queue drop; ‘w-link-down-drop’: Total worker core link down drop; ‘w-ring-drop’: Total worker core ring drop;
Type: string
Supported Values: all, pkt-drop, pkt-lnk-down-drop, err-pkt-drop, rx-err, tx-err, tx-drop, rx-len-err, rx-over-err, rx-crc-err, rx-frame-err, rx-no-buff-err, rx-miss-err, tx-abort-err, tx-carrier-err, tx-fifo-err, tx-hbeat-err, tx-windows-err, rx-long-len-err, rx-short-len-err, rx-align-err, rx-csum-offload-err, io-rx-que-drop, io-tx-que-drop, io-ring-drop, w-tx-que-drop, w-link-down-drop, w-ring-drop
geoloc¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
geoloc_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘place-holder’: place-holder;
Type: string
Supported Values: all, place-holder
upgrade-status¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp-rate¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp-rate_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘over_limit_drop’: Over limit drops; ‘limit_intf_drop’: Interfaces rate limit drops; ‘limit_vserver_drop’: Virtual Server rate limit drops; ‘limit_total_drop’: Total rate limit drops; ‘lockup_time_left’: Lockup time left; ‘curr_rate’: Current rate; ‘v6_over_limit_drop’: Over limit drops (v6); ‘v6_limit_intf_drop’: Interfaces rate limit drops (v6); ‘v6_limit_vserver_drop’: Virtual Server rate limit drops (v6); ‘v6_limit_total_drop’: Total rate limit drops (v6); ‘v6_lockup_time_left’: Lockup time left (v6); ‘v6_curr_rate’: Current rate (v6);
Type: string
Supported Values: all, over_limit_drop, limit_intf_drop, limit_vserver_drop, limit_total_drop, lockup_time_left, curr_rate, v6_over_limit_drop, v6_limit_intf_drop, v6_limit_vserver_drop, v6_limit_total_drop, v6_lockup_time_left, v6_curr_rate
set-rxtx-desc-size¶
Specification Type object port-index
Description port index to be configured (Specify port index)
Type: number
Range: 0-32
rxd-size
Description Set new rx-descriptor size
Type: number
Range: 0-65536
txd-size
Description Set new tx-descriptor size
Type: number
Range: 0-65536
mfa-management¶
Specification Type object enable
Description Enable 2FA for management plane
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
icmp6¶
Specification Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp6_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘in_msgs’: In messages; ‘in_errors’: In Errors; ‘in_dest_un_reach’: In Destunation Unreachable; ‘in_pkt_too_big’: In Packet too big; ‘in_time_exceeds’: In TTL Exceeds; ‘in_param_prob’: In Parameter Problem; ‘in_echoes’: In Echo requests; ‘in_exho_reply’: In Echo replies; ‘in_grp_mem_query’: In Group member query; ‘in_grp_mem_resp’: In Group member reply; ‘in_grp_mem_reduction’: In Group member reduction; ‘in_router_sol’: In Router solicitation; ‘in_ra’: In Router advertisement; ‘in_ns’: In neighbor solicitation; ‘in_na’: In neighbor advertisement; ‘in_redirect’: In Redirects; ‘out_msg’: Out Messages; ‘out_dst_un_reach’: Out Destination Unreachable; ‘out_pkt_too_big’: Out Packet too big; ‘out_time_exceeds’: Out TTL Exceeds; ‘out_param_prob’: Out Parameter Problem; ‘out_echo_req’: Out Echo requests; ‘out_echo_replies’: Out Echo replies; ‘out_rs’: Out Router solicitation; ‘out_ra’: Out Router advertisement; ‘out_ns’: Out neighbor solicitation; ‘out_na’: Out neighbor advertisement; ‘out_redirects’: Out Redirects; ‘out_mem_resp’: Out Group member reply; ‘out_mem_reductions’: Out Group member reduction; ‘err_rs’: Error Router solicitation; ‘err_ra’: Error Router advertisement; ‘err_ns’: Error Neighbor solicitation; ‘err_na’: Error Neighbor advertisement; ‘err_redirects’: Error Redirects; ‘err_echoes’: Error Echo requests; ‘err_echo_replies’: Error Echo replies;
Type: string
Supported Values: all, in_msgs, in_errors, in_dest_un_reach, in_pkt_too_big, in_time_exceeds, in_param_prob, in_echoes, in_exho_reply, in_grp_mem_query, in_grp_mem_resp, in_grp_mem_reduction, in_router_sol, in_ra, in_ns, in_na, in_redirect, out_msg, out_dst_un_reach, out_pkt_too_big, out_time_exceeds, out_param_prob, out_echo_req, out_echo_replies, out_rs, out_ra, out_ns, out_na, out_redirects, out_mem_resp, out_mem_reductions, err_rs, err_ra, err_ns, err_na, err_redirects, err_echoes, err_echo_replies
psu-info¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
table-integrity¶
Specification Type object audit-action
Description ‘enable’: Enable table integrity audit; ‘disable’: Disable table integrity audit;
Type: string
Supported Values: enable, disable
Default: enable
auto-sync-action
Description ‘enable’: Enable auto-sync; ‘disable’: Disable auto-sync;
Type: string
Supported Values: enable, disable
Default: enable
sampling-enable
Type: Listtable
Description ‘all’: All tables;
Type: string
Supported Values: all
Default: all
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
table-integrity_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘arp-tbl-sync-start-ts-m-1st’: arp table sync start time stamp master; ‘nd6-tbl-sync-start-ts-m-1st’: nd6 table sync start time stamp master; ‘ipv4-fib-tbl-sync-start-ts-m-1st’: ipv4-fib table sync start time stamp master; ‘ipv6-fib-tbl-sync-start-ts-m-1st’: ipv6-fib table sync start time stamp master; ‘mac-tbl-sync-start-ts-m-1st’: mac table sync start time stamp master; ‘arp-tbl-sync-start-ts-b-1st’: arp table sync start time stamp blade; ‘nd6-tbl-sync-start-ts-b-1st’: nd6 table sync start time stamp blade; ‘ipv4-fib-tbl-sync-start-ts-b-1st’: ipv4-fib table sync start time stamp blade; ‘ipv6-fib-tbl-sync-start-ts-b-1st’: ipv6-fib table sync start time stamp blade; ‘mac-tbl-sync-start-ts-b-1st’: mac table sync start time stamp blade; ‘arp-tbl-sync-entries-sent-m-1st’: arp table entries sent from master for T0 synchronization; ‘nd6-tbl-sync-entries-sent-m-1st’: nd6 table entries sent from master for T0 synchronization; ‘ipv4-fib-tbl-sync-entries-sent-m-1st’: ipv4-fib table entries sent from master for T0 synchronization; ‘ipv6-fib-tbl-sync-entries-sent-m-1st’: ipv6-fib table entries sent from master for T0 synchronization; ‘mac-tbl-sync-entries-sent-m-1st’: mac table entries sent from master for T0 synchronization; ‘arp-tbl-sync-entries-rcvd-b-1st’: arp table entries received on blade for T0 synchronization; ‘nd6-tbl-sync-entries-rcvd-b-1st’: nd6 table entries received on blade for T0 synchronization; ‘ipv4-fib-tbl-sync-entries-rcvd-b-1st’: ipv4-fib table entries received on blade for T0 synchronization; ‘ipv6-fib-tbl-sync-entries-rcvd-b-1st’: ipv6-fib table entries received on blade for T0 synchronization; ‘mac-tbl-sync-entries-rcvd-b-1st’: mac table entries received on blade for T0 synchronization; ‘arp-tbl-sync-entries-added-b-1st’: arp table entries added on blade for T0 synchronization; ‘nd6-tbl-sync-entries-added-b-1st’: nd6 table entries added on blade for T0 synchronization; ‘ipv4-fib-tbl-sync-entries-added-b-1st’: ipv4-fib table entries added on blade for T0 synchronization; ‘ipv6-fib-tbl-sync-entries-added-b-1st’: ipv6-fib table entries added on blade for T0 synchronization; ‘mac-tbl-sync-entries-added-b-1st’: mac table entries added on blade for T0 synchronization; ‘arp-tbl-sync-entries-removed-b-1st’: arp table entries removed on blade for T0 synchronization; ‘nd6-tbl-sync-entries-removed-b-1st’: arp table entries removed on blade for T0 synchronization; ‘ipv4-fib-tbl-sync-entries-removed-b-1st’: arp table entries removed on blade for T0 synchronization; ‘ipv6-fib-tbl-sync-entries-removed-b-1st’: arp table entries removed on blade for T0 synchronization; ‘mac-tbl-sync-entries-removed-b-1st’: arp table entries removed on blade for T0 synchronization; ‘arp-tbl-sync-end-ts-m-1st’: arp table sync end time stamp master for T0 synchronization; ‘nd6-tbl-sync-end-ts-m-1st’: nd6 table sync end time stamp master for T0 synchronization; ‘ipv4-fib-tbl-sync-end-ts-m-1st’: ipv4-fib table sync end time stamp master for T0 synchronization; ‘ipv6-fib-tbl-sync-end-ts-m-1st’: ipv6-fib table sync end time stamp master for T0 synchronization; ‘mac-tbl-sync-end-ts-m-1st’: mac table sync end time stamp master for T0 synchronization; ‘arp-tbl-sync-end-ts-b-1st’: arp table sync end time stamp blade for T0 synchronization; ‘nd6-tbl-sync-end-ts-b-1st’: nd6 table sync end time stamp blade for T0 synchronization; ‘ipv4-fib-tbl-sync-end-ts-b-1st’: ipv4-fib table sync end time stamp blade for T0 synchronization; ‘ipv6-fib-tbl-sync-end-ts-b-1st’: ipv6-fib table sync end time stamp blade for T0 synchronization; ‘mac-tbl-sync-end-ts-b-1st’: mac table sync end time stamp blade for T0 synchronization; ‘arp-tbl-sync-start-ts-m-2nd’: arp table sync start time stamp master for T-1 synchronization; ‘nd6-tbl-sync-start-ts-m-2nd’: nd6 table sync start time stamp master for T-1 synchronization; ‘ipv4-fib-tbl-sync-start-ts-m-2nd’: ipv4-fib table sync start time stamp master for T-1 synchronization; ‘ipv6-fib-tbl-sync-start-ts-m-2nd’: ipv6-fib table sync start time stamp master for T-1 synchronization; ‘mac-tbl-sync-start-ts-m-2nd’: mac table sync start time stamp master for T-1 synchronization; ‘arp-tbl-sync-start-ts-b-2nd’: arp table sync start time stamp blade for T-1 synchronization; ‘nd6-tbl-sync-start-ts-b-2nd’: nd6 table sync start time stamp blade for T-1 synchronization; ‘ipv4-fib-tbl-sync-start-ts-b-2nd’: ipv4-fib table sync start time stamp blade for T-1 synchronization; ‘ipv6-fib-tbl-sync-start-ts-b-2nd’: ipv6-fib table sync start time stamp blade for T-1 synchronization; ‘mac-tbl-sync-start-ts-b-2nd’: mac table sync start time stamp blade for T-1 synchronization; ‘arp-tbl-sync-entries-sent-m-2nd’: arp table entries sent from master for T-1 synchronization; ‘nd6-tbl-sync-entries-sent-m-2nd’: nd6 table entries sent from master for T-1 synchronization; ‘ipv4-fib-tbl-sync-entries-sent-m-2nd’: ipv4-fib table entries sent from master for T-1 synchronization; ‘ipv6-fib-tbl-sync-entries-sent-m-2nd’: ipv6-fib table entries sent from master for T-1 synchronization; ‘mac-tbl-sync-entries-sent-m-2nd’: mac table entries sent from master for T-1 synchronization; ‘arp-tbl-sync-entries-rcvd-b-2nd’: arp table entries received in blade for T-1 synchronization; ‘nd6-tbl-sync-entries-rcvd-b-2nd’: nd6 table entries received in blade for T-1 synchronization; ‘ipv4-fib-tbl-sync-entries-rcvd-b-2nd’: ipv4-fib table entries received in blade for T-1 synchronization; ‘ipv6-fib-tbl-sync-entries-rcvd-b-2nd’: ipv6-fib table entries received in blade for T-1 synchronization; ‘mac-tbl-sync-entries-rcvd-b-2nd’: mac table entries received in blade for T-1 synchronization; ‘arp-tbl-sync-entries-added-b-2nd’: arp table entries added in blade for T-1 synchronization; ‘nd6-tbl-sync-entries-added-b-2nd’: nd6 table entries added in blade for T-1 synchronization; ‘ipv4-fib-tbl-sync-entries-added-b-2nd’: ipv4-fib table entries added in blade for T-1 synchronization; ‘ipv6-fib-tbl-sync-entries-added-b-2nd’: ipv6-fib table entries added in blade for T-1 synchronization; ‘mac-tbl-sync-entries-added-b-2nd’: mac table entries added in blade for T-1 synchronization; ‘arp-tbl-sync-entries-removed-b-2nd’: arp table entries removed in blade for T-1 synchronization; ‘nd6-tbl-sync-entries-removed-b-2nd’: nd6 table entries removed in blade for T-1 synchronization; ‘ipv4-fib-tbl-sync-entries-removed-b-2nd’: ipv4-fib table entries removed in blade for T-1 synchronization; ‘ipv6-fib-tbl-sync-entries-removed-b-2nd’: ipv6-fib table entries removed in blade for T-1 synchronization; ‘mac-tbl-sync-entries-removed-b-2nd’: mac table entries removed in blade for T-1 synchronization; ‘arp-tbl-sync-end-ts-m-2nd’: arp table sync end time stamp master for T-1 synchronization; ‘nd6-tbl-sync-end-ts-m-2nd’: nd6 table sync end time stamp master for T-1 synchronization; ‘ipv4-fib-tbl-sync-end-ts-m-2nd’: ipv4-fib table sync end time stamp master for T-1 synchronization; ‘ipv6-fib-tbl-sync-end-ts-m-2nd’: ipv6-fib table sync end time stamp master for T-1 synchronization; ‘mac-tbl-sync-end-ts-m-2nd’: mac table sync end time stamp master for T-1 synchronization; ‘arp-tbl-sync-end-ts-b-2nd’: arp table sync end time stamp blade for T-1 synchronization; ‘nd6-tbl-sync-end-ts-b-2nd’: nd6 table sync end time stamp blade for T-1 synchronization; ‘ipv4-fib-tbl-sync-end-ts-b-2nd’: ipv4-fib table sync end time stamp blade for T-1 synchronization; ‘ipv6-fib-tbl-sync-end-ts-b-2nd’: ipv6-fib table sync end time stamp blade for T-1 synchronization; ‘mac-tbl-sync-end-ts-b-2nd’: mac table sync end time stamp blade for T-1 synchronization; ‘arp-tbl-sync-start-ts-m-3rd’: arp table sync start time stamp master for T-2 synchronization; ‘nd6-tbl-sync-start-ts-m-3rd’: nd6 table sync start time stamp master for T-2 synchronization;
Type: string
Supported Values: all, arp-tbl-sync-start-ts-m-1st, nd6-tbl-sync-start-ts-m-1st, ipv4-fib-tbl-sync-start-ts-m-1st, ipv6-fib-tbl-sync-start-ts-m-1st, mac-tbl-sync-start-ts-m-1st, arp-tbl-sync-start-ts-b-1st, nd6-tbl-sync-start-ts-b-1st, ipv4-fib-tbl-sync-start-ts-b-1st, ipv6-fib-tbl-sync-start-ts-b-1st, mac-tbl-sync-start-ts-b-1st, arp-tbl-sync-entries-sent-m-1st, nd6-tbl-sync-entries-sent-m-1st, ipv4-fib-tbl-sync-entries-sent-m-1st, ipv6-fib-tbl-sync-entries-sent-m-1st, mac-tbl-sync-entries-sent-m-1st, arp-tbl-sync-entries-rcvd-b-1st, nd6-tbl-sync-entries-rcvd-b-1st, ipv4-fib-tbl-sync-entries-rcvd-b-1st, ipv6-fib-tbl-sync-entries-rcvd-b-1st, mac-tbl-sync-entries-rcvd-b-1st, arp-tbl-sync-entries-added-b-1st, nd6-tbl-sync-entries-added-b-1st, ipv4-fib-tbl-sync-entries-added-b-1st, ipv6-fib-tbl-sync-entries-added-b-1st, mac-tbl-sync-entries-added-b-1st, arp-tbl-sync-entries-removed-b-1st, nd6-tbl-sync-entries-removed-b-1st, ipv4-fib-tbl-sync-entries-removed-b-1st, ipv6-fib-tbl-sync-entries-removed-b-1st, mac-tbl-sync-entries-removed-b-1st, arp-tbl-sync-end-ts-m-1st, nd6-tbl-sync-end-ts-m-1st, ipv4-fib-tbl-sync-end-ts-m-1st, ipv6-fib-tbl-sync-end-ts-m-1st, mac-tbl-sync-end-ts-m-1st, arp-tbl-sync-end-ts-b-1st, nd6-tbl-sync-end-ts-b-1st, ipv4-fib-tbl-sync-end-ts-b-1st, ipv6-fib-tbl-sync-end-ts-b-1st, mac-tbl-sync-end-ts-b-1st, arp-tbl-sync-start-ts-m-2nd, nd6-tbl-sync-start-ts-m-2nd, ipv4-fib-tbl-sync-start-ts-m-2nd, ipv6-fib-tbl-sync-start-ts-m-2nd, mac-tbl-sync-start-ts-m-2nd, arp-tbl-sync-start-ts-b-2nd, nd6-tbl-sync-start-ts-b-2nd, ipv4-fib-tbl-sync-start-ts-b-2nd, ipv6-fib-tbl-sync-start-ts-b-2nd, mac-tbl-sync-start-ts-b-2nd, arp-tbl-sync-entries-sent-m-2nd, nd6-tbl-sync-entries-sent-m-2nd, ipv4-fib-tbl-sync-entries-sent-m-2nd, ipv6-fib-tbl-sync-entries-sent-m-2nd, mac-tbl-sync-entries-sent-m-2nd, arp-tbl-sync-entries-rcvd-b-2nd, nd6-tbl-sync-entries-rcvd-b-2nd, ipv4-fib-tbl-sync-entries-rcvd-b-2nd, ipv6-fib-tbl-sync-entries-rcvd-b-2nd, mac-tbl-sync-entries-rcvd-b-2nd, arp-tbl-sync-entries-added-b-2nd, nd6-tbl-sync-entries-added-b-2nd, ipv4-fib-tbl-sync-entries-added-b-2nd, ipv6-fib-tbl-sync-entries-added-b-2nd, mac-tbl-sync-entries-added-b-2nd, arp-tbl-sync-entries-removed-b-2nd, nd6-tbl-sync-entries-removed-b-2nd, ipv4-fib-tbl-sync-entries-removed-b-2nd, ipv6-fib-tbl-sync-entries-removed-b-2nd, mac-tbl-sync-entries-removed-b-2nd, arp-tbl-sync-end-ts-m-2nd, nd6-tbl-sync-end-ts-m-2nd, ipv4-fib-tbl-sync-end-ts-m-2nd, ipv6-fib-tbl-sync-end-ts-m-2nd, mac-tbl-sync-end-ts-m-2nd, arp-tbl-sync-end-ts-b-2nd, nd6-tbl-sync-end-ts-b-2nd, ipv4-fib-tbl-sync-end-ts-b-2nd, ipv6-fib-tbl-sync-end-ts-b-2nd, mac-tbl-sync-end-ts-b-2nd, arp-tbl-sync-start-ts-m-3rd, nd6-tbl-sync-start-ts-m-3rd
counters2
Description ‘ipv4-fib-tbl-sync-start-ts-m-3rd’: ipv4-fib table sync start time stamp master for T-2 synchronization; ‘ipv6-fib-tbl-sync-start-ts-m-3rd’: ipv6-fib table sync start time stamp master for T-2 synchronization; ‘mac-tbl-sync-start-ts-m-3rd’: mac table sync start time stamp master for T-2 synchronization; ‘arp-tbl-sync-start-ts-b-3rd’: arp table sync start time stamp blade for T-2 synchronization; ‘nd6-tbl-sync-start-ts-b-3rd’: nd6 table sync start time stamp blade for T-2 synchronization; ‘ipv4-fib-tbl-sync-start-ts-b-3rd’: ipv4-fib table sync start time stamp blade for T-2 synchronization; ‘ipv6-fib-tbl-sync-start-ts-b-3rd’: ipv6-fib table sync start time stamp blade for T-2 synchronization; ‘mac-tbl-sync-start-ts-b-3rd’: mac table sync start time stamp blade for T-2 synchronization; ‘arp-tbl-sync-entries-sent-m-3rd’: arp table entries sent from master for T-2 synchronization; ‘nd6-tbl-sync-entries-sent-m-3rd’: nd6 table entries sent from master for T-2 synchronization; ‘ipv4-fib-tbl-sync-entries-sent-m-3rd’: ipv4-fib table entries sent from master for T-2 synchronization; ‘ipv6-fib-tbl-sync-entries-sent-m-3rd’: ipv6-fib table entries sent from master for T-2 synchronization; ‘mac-tbl-sync-entries-sent-m-3rd’: mac table entries sent from master for T-2 synchronization; ‘arp-tbl-sync-entries-rcvd-b-3rd’: arp table entries received in blade for T-2 synchronization; ‘nd6-tbl-sync-entries-rcvd-b-3rd’: nd6 table entries received in blade for T-2 synchronization; ‘ipv4-fib-tbl-sync-entries-rcvd-b-3rd’: ipv4-fib table entries received in blade for T-2 synchronization; ‘ipv6-fib-tbl-sync-entries-rcvd-b-3rd’: ipv6-fib table entries received in blade for T-2 synchronization; ‘mac-tbl-sync-entries-rcvd-b-3rd’: mac table entries received in blade for T-2 synchronization; ‘arp-tbl-sync-entries-added-b-3rd’: arp table entries added in blade for T-2 synchronization; ‘nd6-tbl-sync-entries-added-b-3rd’: nd6 table entries added in blade for T-2 synchronization; ‘ipv4-fib-tbl-sync-entries-added-b-3rd’: ipv4-fib table entries added in blade for T-2 synchronization; ‘ipv6-fib-tbl-sync-entries-added-b-3rd’: ipv6-fib table entries added in blade for T-2 synchronization; ‘mac-tbl-sync-entries-added-b-3rd’: mac table entries added in blade for T-2 synchronization; ‘arp-tbl-sync-entries-removed-b-3rd’: arp table entries removed in blade for T-2 synchronization; ‘nd6-tbl-sync-entries-removed-b-3rd’: nd6 table entries removed in blade for T-2 synchronization; ‘ipv4-fib-tbl-sync-entries-removed-b-3rd’: ipv4-fib table entries removed in blade for T-2 synchronization; ‘ipv6-fib-tbl-sync-entries-removed-b-3rd’: ipv6-fib table entries removed in blade for T-2 synchronization; ‘mac-tbl-sync-entries-removed-b-3rd’: mac table entries removed in blade for T-2 synchronization; ‘arp-tbl-sync-end-ts-m-3rd’: arp table sync end time stamp master for T-2 synchronization; ‘nd6-tbl-sync-end-ts-m-3rd’: nd6 table sync end time stamp master for T-2 synchronization; ‘ipv4-fib-tbl-sync-end-ts-m-3rd’: ipv4-fib table sync end time stamp master for T-2 synchronization; ‘ipv6-fib-tbl-sync-end-ts-m-3rd’: ipv6-fib table sync end time stamp master for T-2 synchronization; ‘mac-tbl-sync-end-ts-m-3rd’: mac table sync end time stamp master for T-2 synchronization; ‘arp-tbl-sync-end-ts-b-3rd’: arp table sync end time stamp blade for T-2 synchronization; ‘nd6-tbl-sync-end-ts-b-3rd’: nd6 table sync end time stamp blade for T-2 synchronization; ‘ipv4-fib-tbl-sync-end-ts-b-3rd’: ipv4-fib table sync end time stamp blade for T-2 synchronization; ‘ipv6-fib-tbl-sync-end-ts-b-3rd’: ipv6-fib table sync end time stamp blade for T-2 synchronization; ‘mac-tbl-sync-end-ts-b-3rd’: mac table sync end time stamp blade for T-2 synchronization; ‘arp-tbl-sync-start-ts-m-4th’: arp table sync start time stamp master for T-3 synchronization; ‘nd6-tbl-sync-start-ts-m-4th’: nd6 table sync start time stamp master for T-3 synchronization; ‘ipv4-fib-tbl-sync-start-ts-m-4th’: ipv4-fib table sync start time stamp master for T-3 synchronization; ‘ipv6-fib-tbl-sync-start-ts-m-4th’: ipv6-fib table sync start time stamp master for T-3 synchronization; ‘mac-tbl-sync-start-ts-m-4th’: mac table sync start time stamp master for T-3 synchronization; ‘arp-tbl-sync-start-ts-b-4th’: arp table sync start time stamp blade for T-3 synchronization; ‘nd6-tbl-sync-start-ts-b-4th’: nd6 table sync start time stamp blade for T-3 synchronization; ‘ipv4-fib-tbl-sync-start-ts-b-4th’: ipv4-fib table sync start time stamp blade for T-3 synchronization; ‘ipv6-fib-tbl-sync-start-ts-b-4th’: ipv6-fib table sync start time stamp blade for T-3 synchronization; ‘mac-tbl-sync-start-ts-b-4th’: mac table sync start time stamp blade for T-3 synchronization; ‘arp-tbl-sync-entries-sent-m-4th’: arp table entries sent from master for T-3 synchronization; ‘nd6-tbl-sync-entries-sent-m-4th’: nd6 table entries sent from master for T-3 synchronization; ‘ipv4-fib-tbl-sync-entries-sent-m-4th’: ipv4-fib table entries sent from master for T-3 synchronization; ‘ipv6-fib-tbl-sync-entries-sent-m-4th’: ipv6-fib table entries sent from master for T-3 synchronization; ‘mac-tbl-sync-entries-sent-m-4th’: mac table entries sent from master for T-3 synchronization; ‘arp-tbl-sync-entries-rcvd-b-4th’: arp table entries received in blade for T-3 synchronization; ‘nd6-tbl-sync-entries-rcvd-b-4th’: nd6 table entries received in blade for T-3 synchronization; ‘ipv4-fib-tbl-sync-entries-rcvd-b-4th’: ipv4-fib table entries received in blade for T-3 synchronization; ‘ipv6-fib-tbl-sync-entries-rcvd-b-4th’: ipv6-fib table entries received in blade for T-3 synchronization; ‘mac-tbl-sync-entries-rcvd-b-4th’: mac table entries received in blade for T-3 synchronization; ‘arp-tbl-sync-entries-added-b-4th’: arp table entries added in blade for T-3 synchronization; ‘nd6-tbl-sync-entries-added-b-4th’: nd6 table entries added in blade for T-3 synchronization; ‘ipv4-fib-tbl-sync-entries-added-b-4th’: ipv4-fib table entries added in blade for T-3 synchronization; ‘ipv6-fib-tbl-sync-entries-added-b-4th’: ipv6-fib table entries added in blade for T-3 synchronization; ‘mac-tbl-sync-entries-added-b-4th’: mac table entries added in blade for T-3 synchronization; ‘arp-tbl-sync-entries-removed-b-4th’: arp table entries removed in blade for T-3 synchronization; ‘nd6-tbl-sync-entries-removed-b-4th’: nd6 table entries removed in blade for T-3 synchronization; ‘ipv4-fib-tbl-sync-entries-removed-b-4th’: ipv4-fib table entries removed in blade for T-3 synchronization; ‘ipv6-fib-tbl-sync-entries-removed-b-4th’: ipv6-fib table entries removed in blade for T-3 synchronization; ‘mac-tbl-sync-entries-removed-b-4th’: mac table entries removed in blade for T-3 synchronization; ‘arp-tbl-sync-end-ts-m-4th’: arp table sync end time stamp master for T-3 synchronization; ‘nd6-tbl-sync-end-ts-m-4th’: nd6 table sync end time stamp master for T-3 synchronization; ‘ipv4-fib-tbl-sync-end-ts-m-4th’: ipv4-fib table sync end time stamp master for T-3 synchronization; ‘ipv6-fib-tbl-sync-end-ts-m-4th’: ipv6-fib table sync end time stamp master for T-3 synchronization; ‘mac-tbl-sync-end-ts-m-4th’: mac table sync end time stamp master for T-3 synchronization; ‘arp-tbl-sync-end-ts-b-4th’: arp table sync end time stamp blade for T-3 synchronization; ‘nd6-tbl-sync-end-ts-b-4th’: nd6 table sync end time stamp blade for T-3 synchronization; ‘ipv4-fib-tbl-sync-end-ts-b-4th’: ipv4-fib table sync end time stamp blade for T-3 synchronization; ‘ipv6-fib-tbl-sync-end-ts-b-4th’: ipv6-fib table sync end time stamp blade for T-3 synchronization; ‘mac-tbl-sync-end-ts-b-4th’: mac table sync end time stamp blade for T-3 synchronization; ‘arp-tbl-sync-start-ts-m-5th’: arp table sync start time stamp master for T-4 synchronization;
Type: string
Supported Values: ipv4-fib-tbl-sync-start-ts-m-3rd, ipv6-fib-tbl-sync-start-ts-m-3rd, mac-tbl-sync-start-ts-m-3rd, arp-tbl-sync-start-ts-b-3rd, nd6-tbl-sync-start-ts-b-3rd, ipv4-fib-tbl-sync-start-ts-b-3rd, ipv6-fib-tbl-sync-start-ts-b-3rd, mac-tbl-sync-start-ts-b-3rd, arp-tbl-sync-entries-sent-m-3rd, nd6-tbl-sync-entries-sent-m-3rd, ipv4-fib-tbl-sync-entries-sent-m-3rd, ipv6-fib-tbl-sync-entries-sent-m-3rd, mac-tbl-sync-entries-sent-m-3rd, arp-tbl-sync-entries-rcvd-b-3rd, nd6-tbl-sync-entries-rcvd-b-3rd, ipv4-fib-tbl-sync-entries-rcvd-b-3rd, ipv6-fib-tbl-sync-entries-rcvd-b-3rd, mac-tbl-sync-entries-rcvd-b-3rd, arp-tbl-sync-entries-added-b-3rd, nd6-tbl-sync-entries-added-b-3rd, ipv4-fib-tbl-sync-entries-added-b-3rd, ipv6-fib-tbl-sync-entries-added-b-3rd, mac-tbl-sync-entries-added-b-3rd, arp-tbl-sync-entries-removed-b-3rd, nd6-tbl-sync-entries-removed-b-3rd, ipv4-fib-tbl-sync-entries-removed-b-3rd, ipv6-fib-tbl-sync-entries-removed-b-3rd, mac-tbl-sync-entries-removed-b-3rd, arp-tbl-sync-end-ts-m-3rd, nd6-tbl-sync-end-ts-m-3rd, ipv4-fib-tbl-sync-end-ts-m-3rd, ipv6-fib-tbl-sync-end-ts-m-3rd, mac-tbl-sync-end-ts-m-3rd, arp-tbl-sync-end-ts-b-3rd, nd6-tbl-sync-end-ts-b-3rd, ipv4-fib-tbl-sync-end-ts-b-3rd, ipv6-fib-tbl-sync-end-ts-b-3rd, mac-tbl-sync-end-ts-b-3rd, arp-tbl-sync-start-ts-m-4th, nd6-tbl-sync-start-ts-m-4th, ipv4-fib-tbl-sync-start-ts-m-4th, ipv6-fib-tbl-sync-start-ts-m-4th, mac-tbl-sync-start-ts-m-4th, arp-tbl-sync-start-ts-b-4th, nd6-tbl-sync-start-ts-b-4th, ipv4-fib-tbl-sync-start-ts-b-4th, ipv6-fib-tbl-sync-start-ts-b-4th, mac-tbl-sync-start-ts-b-4th, arp-tbl-sync-entries-sent-m-4th, nd6-tbl-sync-entries-sent-m-4th, ipv4-fib-tbl-sync-entries-sent-m-4th, ipv6-fib-tbl-sync-entries-sent-m-4th, mac-tbl-sync-entries-sent-m-4th, arp-tbl-sync-entries-rcvd-b-4th, nd6-tbl-sync-entries-rcvd-b-4th, ipv4-fib-tbl-sync-entries-rcvd-b-4th, ipv6-fib-tbl-sync-entries-rcvd-b-4th, mac-tbl-sync-entries-rcvd-b-4th, arp-tbl-sync-entries-added-b-4th, nd6-tbl-sync-entries-added-b-4th, ipv4-fib-tbl-sync-entries-added-b-4th, ipv6-fib-tbl-sync-entries-added-b-4th, mac-tbl-sync-entries-added-b-4th, arp-tbl-sync-entries-removed-b-4th, nd6-tbl-sync-entries-removed-b-4th, ipv4-fib-tbl-sync-entries-removed-b-4th, ipv6-fib-tbl-sync-entries-removed-b-4th, mac-tbl-sync-entries-removed-b-4th, arp-tbl-sync-end-ts-m-4th, nd6-tbl-sync-end-ts-m-4th, ipv4-fib-tbl-sync-end-ts-m-4th, ipv6-fib-tbl-sync-end-ts-m-4th, mac-tbl-sync-end-ts-m-4th, arp-tbl-sync-end-ts-b-4th, nd6-tbl-sync-end-ts-b-4th, ipv4-fib-tbl-sync-end-ts-b-4th, ipv6-fib-tbl-sync-end-ts-b-4th, mac-tbl-sync-end-ts-b-4th, arp-tbl-sync-start-ts-m-5th
counters3
Description ‘nd6-tbl-sync-start-ts-m-5th’: nd6 table sync start time stamp master for T-4 synchronization; ‘ipv4-fib-tbl-sync-start-ts-m-5th’: ipv4-fib table sync start time stamp master for T-4 synchronization; ‘ipv6-fib-tbl-sync-start-ts-m-5th’: ipv6-fib table sync start time stamp master for T-4 synchronization; ‘mac-tbl-sync-start-ts-m-5th’: mac table sync start time stamp master for T-4 synchronization; ‘arp-tbl-sync-start-ts-b-5th’: arp table sync start time stamp blade for T-4 synchronization; ‘nd6-tbl-sync-start-ts-b-5th’: nd6 table sync start time stamp blade for T-4 synchronization; ‘ipv4-fib-tbl-sync-start-ts-b-5th’: ipv4-fib table sync start time stamp blade for T-4 synchronization; ‘ipv6-fib-tbl-sync-start-ts-b-5th’: ipv6-fib table sync start time stamp blade for T-4 synchronization; ‘mac-tbl-sync-start-ts-b-5th’: mac table sync start time stamp blade for T-4 synchronization; ‘arp-tbl-sync-entries-sent-m-5th’: arp table sync start time stamp blade for T-4 synchronization; ‘nd6-tbl-sync-entries-sent-m-5th’: nd6 table sync start time stamp blade for T-4 synchronization; ‘ipv4-fib-tbl-sync-entries-sent-m-5th’: ipv4-fib table sync start time stamp blade for T-4 synchronization; ‘ipv6-fib-tbl-sync-entries-sent-m-5th’: ipv6-fib table sync start time stamp blade for T-4 synchronization; ‘mac-tbl-sync-entries-sent-m-5th’: mac table sync start time stamp blade for T-4 synchronization; ‘arp-tbl-sync-entries-rcvd-b-5th’: arp table entries received in blade for T-4 synchronization; ‘nd6-tbl-sync-entries-rcvd-b-5th’: nd6 table entries received in blade for T-4 synchronization; ‘ipv4-fib-tbl-sync-entries-rcvd-b-5th’: ipv4-fib table entries received in blade for T-4 synchronization; ‘ipv6-fib-tbl-sync-entries-rcvd-b-5th’: ipv6-fib table entries received in blade for T-4 synchronization; ‘mac-tbl-sync-entries-rcvd-b-5th’: mac table entries received in blade for T-4 synchronization; ‘arp-tbl-sync-entries-added-b-5th’: arp table entries added in blade for T-4 synchronization; ‘nd6-tbl-sync-entries-added-b-5th’: nd6 table entries added in blade for T-4 synchronization; ‘ipv4-fib-tbl-sync-entries-added-b-5th’: ipv4-fib table entries added in blade for T-4 synchronization; ‘ipv6-fib-tbl-sync-entries-added-b-5th’: ipv6-fib table entries added in blade for T-4 synchronization; ‘mac-tbl-sync-entries-added-b-5th’: mac table entries added in blade for T-4 synchronization; ‘arp-tbl-sync-entries-removed-b-5th’: arp table entries removed in blade for T-4 synchronization; ‘nd6-tbl-sync-entries-removed-b-5th’: nd6 table entries removed in blade for T-4 synchronization; ‘ipv4-fib-tbl-sync-entries-removed-b-5th’: ipv4-fib table entries removed in blade for T-4 synchronization; ‘ipv6-fib-tbl-sync-entries-removed-b-5th’: ipv6-fib table entries removed in blade for T-4 synchronization; ‘mac-tbl-sync-entries-removed-b-5th’: mac table entries removed in blade for T-4 synchronization; ‘arp-tbl-sync-end-ts-m-5th’: arp table sync end time stamp master for T-4 synchronization; ‘nd6-tbl-sync-end-ts-m-5th’: nd6 table sync end time stamp master for T-4 synchronization; ‘ipv4-fib-tbl-sync-end-ts-m-5th’: ipv4-fib table sync end time stamp master for T-4 synchronization; ‘ipv6-fib-tbl-sync-end-ts-m-5th’: ipv6-fib table sync end time stamp master for T-4 synchronization; ‘mac-tbl-sync-end-ts-m-5th’: mac table sync end time stamp master for T-4 synchronization; ‘arp-tbl-sync-end-ts-b-5th’: arp table sync end time stamp blade for T-4 synchronization; ‘nd6-tbl-sync-end-ts-b-5th’: nd6 table sync end time stamp blade for T-4 synchronization; ‘ipv4-fib-tbl-sync-end-ts-b-5th’: ipv4-fib table sync end time stamp blade for T-4 synchronization; ‘ipv6-fib-tbl-sync-end-ts-b-5th’: ipv6-fib table sync end time stamp blade for T-4 synchronization; ‘mac-tbl-sync-end-ts-b-5th’: mac table sync end time stamp blade for T-4 synchronization; ‘arp-tbl-sync-m’: arp table sync count in master; ‘nd6-tbl-sync-m’: nd6 table sync count in master; ‘ipv4-fib-tbl-sync-m’: ipv4-fib table sync count in master; ‘ipv6-fib-tbl-sync-m’: ipv6-fib table sync count in master; ‘mac-tbl-sync-m’: mac table sync count in master; ‘arp-tbl-sync-b’: arp table sync count in blade; ‘nd6-tbl-sync-b’: nd6 table sync count in blade; ‘ipv4-fib-tbl-sync-b’: ipv4-fib table sync count in blade; ‘ipv6-fib-tbl-sync-b’: ipv6-fib table sync count in blade; ‘mac-tbl-sync-b’: mac table sync count in blade; ‘arp-tbl-cksum-m’: arp table checksum count in master; ‘nd6-tbl-cksum-m’: nd6 table checksum count in master; ‘ipv4-fib-tbl-cksum-m’: ipv4-fib table checksum count in master; ‘ipv6-fib-tbl-cksum-m’: ipv6-fib table checksum count in master; ‘mac-tbl-cksum-m’: mac table checksum count in master; ‘arp-tbl-cksum-b’: arp table checksum count in blade; ‘nd6-tbl-cksum-b’: nd6 table checksum count in blade; ‘ipv4-fib-tbl-cksum-b’: ipv4-fib table checksum count in blade; ‘ipv6-fib-tbl-cksum-b’: ipv6-fib table checksum count in blade; ‘mac-tbl-cksum-b’: mac table checksum count in blade; ‘arp-tbl-cksum-mismatch-b’: arp table checksum mismatch count in blade; ‘nd6-tbl-cksum-mismatch-b’: nd6 table checksum mismatch count in blade; ‘ipv4-fib-tbl-cksum-mismatch-b’: ipv4-fib table checksum mismatch count in blade; ‘ipv6-fib-tbl-cksum-mismatch-b’: ipv6-fib table checksum mismatch count in blade; ‘mac-tbl-cksum-mismatch-b’: mac table checksum mismatch count in blade; ‘arp-tbl-cksum-cancel-m’: arp table checksum cancelled count in master; ‘nd6-tbl-cksum-cancel-m’: nd6 table checksum cancelled count in master; ‘ipv4-fib-tbl-cksum-cancel-m’: ipv4-fib table checksum cancelled count in master; ‘ipv6-fib-tbl-cksum-cancel-m’: ipv6-fib table checksum cancelled count in master; ‘mac-tbl-cksum-cancel-m’: mac table checksum cancelled count in master;
Type: string
Supported Values: nd6-tbl-sync-start-ts-m-5th, ipv4-fib-tbl-sync-start-ts-m-5th, ipv6-fib-tbl-sync-start-ts-m-5th, mac-tbl-sync-start-ts-m-5th, arp-tbl-sync-start-ts-b-5th, nd6-tbl-sync-start-ts-b-5th, ipv4-fib-tbl-sync-start-ts-b-5th, ipv6-fib-tbl-sync-start-ts-b-5th, mac-tbl-sync-start-ts-b-5th, arp-tbl-sync-entries-sent-m-5th, nd6-tbl-sync-entries-sent-m-5th, ipv4-fib-tbl-sync-entries-sent-m-5th, ipv6-fib-tbl-sync-entries-sent-m-5th, mac-tbl-sync-entries-sent-m-5th, arp-tbl-sync-entries-rcvd-b-5th, nd6-tbl-sync-entries-rcvd-b-5th, ipv4-fib-tbl-sync-entries-rcvd-b-5th, ipv6-fib-tbl-sync-entries-rcvd-b-5th, mac-tbl-sync-entries-rcvd-b-5th, arp-tbl-sync-entries-added-b-5th, nd6-tbl-sync-entries-added-b-5th, ipv4-fib-tbl-sync-entries-added-b-5th, ipv6-fib-tbl-sync-entries-added-b-5th, mac-tbl-sync-entries-added-b-5th, arp-tbl-sync-entries-removed-b-5th, nd6-tbl-sync-entries-removed-b-5th, ipv4-fib-tbl-sync-entries-removed-b-5th, ipv6-fib-tbl-sync-entries-removed-b-5th, mac-tbl-sync-entries-removed-b-5th, arp-tbl-sync-end-ts-m-5th, nd6-tbl-sync-end-ts-m-5th, ipv4-fib-tbl-sync-end-ts-m-5th, ipv6-fib-tbl-sync-end-ts-m-5th, mac-tbl-sync-end-ts-m-5th, arp-tbl-sync-end-ts-b-5th, nd6-tbl-sync-end-ts-b-5th, ipv4-fib-tbl-sync-end-ts-b-5th, ipv6-fib-tbl-sync-end-ts-b-5th, mac-tbl-sync-end-ts-b-5th, arp-tbl-sync-m, nd6-tbl-sync-m, ipv4-fib-tbl-sync-m, ipv6-fib-tbl-sync-m, mac-tbl-sync-m, arp-tbl-sync-b, nd6-tbl-sync-b, ipv4-fib-tbl-sync-b, ipv6-fib-tbl-sync-b, mac-tbl-sync-b, arp-tbl-cksum-m, nd6-tbl-cksum-m, ipv4-fib-tbl-cksum-m, ipv6-fib-tbl-cksum-m, mac-tbl-cksum-m, arp-tbl-cksum-b, nd6-tbl-cksum-b, ipv4-fib-tbl-cksum-b, ipv6-fib-tbl-cksum-b, mac-tbl-cksum-b, arp-tbl-cksum-mismatch-b, nd6-tbl-cksum-mismatch-b, ipv4-fib-tbl-cksum-mismatch-b, ipv6-fib-tbl-cksum-mismatch-b, mac-tbl-cksum-mismatch-b, arp-tbl-cksum-cancel-m, nd6-tbl-cksum-cancel-m, ipv4-fib-tbl-cksum-cancel-m, ipv6-fib-tbl-cksum-cancel-m, mac-tbl-cksum-cancel-m
platformtype¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters