system¶
Configure System Parameters
system Specification¶
Parameter Value Type Configuration Resource Element Name system Element URI /axapi/v3/system Element Attributes system_attributes Partition Visibility shared 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
anomaly-log-rate-limit
Description Anomaly log rate-limit per second, default 32
Type: number
Range: 1-100
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-mmu-fail-safe
Description: asic-mmu-fail-safe is a JSON Block. Please see below for asic-mmu-fail-safe
Type: Object
Reference Object: /axapi/v3/system/asic-mmu-fail-safe
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
cli-monitor-interval
Description: cli-monitor-interval is a JSON Block. Please see below for cli-monitor-interval
Type: Object
Reference Object: /axapi/v3/system/cli-monitor-interval
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
default-mtu
Description Set all interfaces default mtu (Interface MTU, default 1 (System jumbo needs to be enabled))
Type: number
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
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
ext-only-logging
Description: ext-only-logging is a JSON Block. Please see below for ext-only-logging
Type: Object
Reference Object: /axapi/v3/system/ext-only-logging
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
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
hw-blocking-enable
Description Enable system hardware blocking (default disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
l3-traffic-distribution
Description: l3-traffic-distribution is a JSON Block. Please see below for l3-traffic-distribution
Type: Object
Reference Object: /axapi/v3/system/l3-traffic-distribution
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
memory
Description: memory is a JSON Block. Please see below for memory
Type: Object
Reference Object: /axapi/v3/system/memory
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
netvsc-monitor
Description: netvsc-monitor is a JSON Block. Please see below for netvsc-monitor
Type: Object
Reference Object: /axapi/v3/system/netvsc-monitor
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
promiscuous-mode
Description Run in promiscous mode settings
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
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-status
Description: ssl-status is a JSON Block. Please see below for ssl-status
Type: Object
Reference Object: /axapi/v3/system/ssl-status
switch-common-drop
Description: switch-common-drop is a JSON Block. Please see below for switch-common-drop
Type: Object
Reference Object: /axapi/v3/system/switch-common-drop
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
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
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
xaui-dlb-mode
Description: xaui-dlb-mode is a JSON Block. Please see below for xaui-dlb-mode
Type: Object
Reference Object: /axapi/v3/system/xaui-dlb-mode
geo-location¶
Specification Value Type object entry-list
Type: List
Reference Object: /axapi/v3/system/geo-location/entry/{geo-locn-obj-name}
geo-location-geolite2-asn
Description Load built-in Maxmind GeoLite2-ASN database. Database available from http://www.maxmind.com
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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: 0
geolite2-asn-include-ipv6
Description Include IPv6 address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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 Value 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 Value 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 Value Type list Block object keys geo-location-load-file-include-ipv6
Description Include IPv6 address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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 Use default CSV format to load this file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/template/csv
mgmt-port¶
Specification Value 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 Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ndisc-ra¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tcp¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
bandwidth¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
session¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ext-only-logging¶
Specification Value Type object enable
Description enable external only logging for packet driven DDOS logs
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-threat-list¶
Specification Value 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-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-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
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-threat-list_ipv6-dest-list¶
Specification Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
add-port¶
Specification Value Type object port-index
Description port index to be configured (Specify port index)
Type: number
Range: 0-32
bfd¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-xaui-hw-hash¶
Specification Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
port-info¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trunk-hw-hash¶
Specification Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template-bind¶
Specification Value Type object monitor-list
Type: List
Reference Object: /axapi/v3/system/template-bind/monitor/{template-monitor}
template-bind_monitor-list¶
Specification Value 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 Value 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 Value 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 Value 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 Value 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 Value 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
set-rxtx-queue¶
Specification Value 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
icmp-rate¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ssl-req-q¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
telemetry-log¶
Specification Value 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
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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
telemetry-log_partition-metrics¶
Specification Value 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 Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ipsec¶
Specification Value 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
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 Value Type object action
Description ‘enable’: Enable FPGA decryption offload; ‘disable’: Disable FPGA decryption offload;
Type: string
Supported Values: enable, disable
Default: disable
cli-monitor-interval¶
Specification Value Type object interval
Description one interval is 300ms (0 = disable)
Type: number
Range: 0-5000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
hrxq-status¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cosq-stats¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
password-policy¶
Specification Value 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-64
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
switch-common-drop¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
queuing-buffer¶
Specification Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ports¶
Specification Value 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
core¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
app-performance¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
counter-lib-accounting¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
inuse-port-list¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
control-cpu¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
radius¶
Specification Value 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 Value 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;
Type: string
Supported Values: msisdn, imei, imsi, custom1, custom2, custom3
Mutual Exclusion: attribute-name and custom-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
secret
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 Value Type object ip-list
Type: List
radius_server_remote_ip-list¶
Specification Value 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_attribute¶
Specification Value 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;
Type: string
Supported Values: inside-ipv6-prefix, inside-ip, inside-ipv6, imei, imsi, msisdn, custom1, custom2, custom3
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 Value 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 Value Type object port-index
Description port index to be configured (Specify port index)
Type: number
Range: 0-32
asic-mmu-fail-safe¶
Specification Value Type object monitor-disable
Description Enable Fail-safe software error monitoring and act on it
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
monitor-interval
Description ASIC Fail-safe monitoring intervals in Seconds (Units of 1 Seconds (default 60))
Type: number
Range: 5-300
Default: 60
reboot-disable
Description Disable system reboot if system encounters mmu error
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
recovery-threshold
Description ASIC Fail-safe recovery threshold in Errors (Units of 1 Errors (default 2))
Type: number
Range: 1-1000
Default: 2
test-pattern-type
Description ‘all-zeros’: Inject all bits 0s in a byte; ‘all-ones’: Inject all bits 1s in a byte; ‘lcb’: Logical checker board; ‘inverse-lcb’: Inverse Logical checker board;
Type: string
Supported Values: all-zeros, all-ones, lcb, inverse-lcb
Default: lcb
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
netvsc-monitor¶
Specification Value Type object enable
Description Enable/Disable auto-recovery from Rx/Tx hang
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
reboot¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
domain-list-info¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-mac-scheme¶
Specification Value 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
link-monitor¶
Specification Value 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 Value 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-40 seconds, default is 2 seconds)
Type: number
Range: 1-40
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 Value Type object enable
Description Enable Multi-Queue-Support
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
trunk¶
Specification Value 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 Value 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 Value Type object class-list-ac-entry-count
Description Total entries for AC class-list
Type: number
class-list-ipv6-addr-count
Description Total IPv6 addresses for class-list
Type: number
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
resource-usage_visibility¶
Specification Value 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
xaui-dlb-mode¶
Specification Value Type object enable
Description Enable/Disable Dynamic Load Balancing traffic distribution 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
throughput¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cm-update-file-name-ref¶
Specification Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ssl-status¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fpga-core-crc¶
Specification Value 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 Value 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 Value 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
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cpu-load-sharing_packets-per-second¶
Specification Value 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
cpu-load-sharing_cpu-usage¶
Specification Value 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
geoloc-list-list¶
Specification Value 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
shared
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_include-geoloc-name-list¶
Specification Value 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 Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-stats¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip6-stats¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
io-cpu¶
Specification Value Type object max-cores
Description max number of IO cores (Specify number of cores)
Type: number
Range: 0-128
dns¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
memory¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cpu-hyper-thread¶
Specification Value 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
spe-profile¶
Specification Value 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 Value Type object core-index
Description core index to be added (Specify core index)
Type: number
Range: 0-128
cpu-list¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmp¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
gui-image-list¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
hardware-forward¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
tcp-stats¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
delete-cpu-core¶
Specification Value Type object core-index
Description core index to be deleted (Specify core index)
Type: number
Range: 0-128
geoloc-name-helper¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
shell-privileges¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
timeout-value¶
Specification Value 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
Type: number
Range: 1-9999
Default: 120
https
Description set timeout to stop https transfer in seconds
Type: number
Range: 1-9999
Default: 120
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
shm-logging¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
port-list¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
resource-accounting¶
Specification Value 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 Value 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 Value 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
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
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
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-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_gslb-site-cfg¶
Specification Value 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_gslb-policy-cfg¶
Specification Value 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 Value 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 Value 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_real-server-cfg¶
Specification Value 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_virtual-server-cfg¶
Specification Value 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-ip-list-cfg¶
Specification Value 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_app-resources_gslb-template-cfg¶
Specification Value 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_health-monitor-cfg¶
Specification Value 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-service-port-cfg¶
Specification Value 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-zone-cfg¶
Specification Value 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_real-port-cfg¶
Specification Value 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-svc-group-cfg¶
Specification Value 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_service-group-cfg¶
Specification Value 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 Value 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_gslb-service-ip-cfg¶
Specification Value 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_system-resources¶
Specification Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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 Value 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
hardware¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
link-capability¶
Specification Value 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
all-vlan-limit¶
Specification Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
high-memory-l4-session¶
Specification Value 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 Value 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 Value Type object enable
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cosq-show¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
syslog-time-msec¶
Specification Value Type object enable-flag
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipmi-service¶
Specification Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns-cache¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
fw¶
Specification Value 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 Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
mon-template¶
Specification Value Type object monitor-list
Type: List
Reference Object: /axapi/v3/system/mon-template/monitor/{id}
mon-template_monitor-list¶
Specification Value 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 Value 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 Value 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
Range: 0-103
mon-template_monitor-list_link-up-cfg¶
Specification Value 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
Range: 0-103
linkup-ethernet2
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
Range: 0-103
linkup-ethernet3
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
Range: 0-103
mon-template_monitor-list_link-down-cfg¶
Specification Value 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
Range: 0-103
linkdown-ethernet2
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
Range: 0-103
linkdown-ethernet3
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
Range: 0-103
mon-template_monitor-list_link-disable-cfg¶
Specification Value 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
Range: 0-103
geoloc¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
upgrade-status¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
set-rxtx-desc-size¶
Specification Value 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
icmp6¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
table-integrity¶
Specification Value Type object audit-action
Description ‘enable’: Enable table integrity audit; ‘disable’: Disable table integrity audit;
Type: string
Supported Values: enable, disable
Default: enable
table
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
l3-traffic-distribution¶
Specification Value Type object disable
Description Disable L3 Based traffic distribution support, default: enable
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
platformtype¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters