system

Configure System Parameters

system Specification

Type Configuration Resource
Element Name system
Element URI /axapi/v3/system
Element Attributes system_attributes
Schema system schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/system

system Attributes

Get Object

GET

/axapi/v3/system

system Attributes

Modify Object

POST

/axapi/v3/system

system Attributes

Replace Object

PUT

/axapi/v3/system

system Attributes

Delete Object

DELETE

/axapi/v3/system

system Attributes

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

attack

Description: System Attack

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

control-cpu

Description: control-cpu is a JSON Block . Please see below for control-cpu

Type: Object

Reference Object: /axapi/v3/system/control-cpu

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

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

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

glid

Description: Apply limits to the whole system

Type: number

Range: 1-1023

Reference Object: /axapi/v3/glid

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

ip-stats

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

Type: Object

Reference Object: /axapi/v3/system/ip-stats

ip6-stats

Description: ip6-stats is a JSON Block . Please see below for ip6-stats

Type: Object

Reference Object: /axapi/v3/system/ip6-stats

ipsec

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

Type: Object

Reference Object: /axapi/v3/system/ipsec

log-cpu-interval

Description: Log high CPU interval (Specify consecutive seconds before logging high CPU)

Type: number

Range: 15-255

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

ndisc-ra

Description: ndisc-ra is a JSON Block . Please see below for ndisc-ra

Type: Object

Reference Object: /axapi/v3/system/ndisc-ra

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

promiscuous-mode

Description: Run in promiscous mode settings

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

sockstress-disable

Description: Disable sockstress protection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

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

uuid

Description: uuid of the object

Type: string

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

mgmt-port

Specification
Type object

port-index

Description: port index to be configured (Specify port index)

Type: number

Range: 0-32

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

tcp-stats

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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; ‘rcvshort’: Packet received too short; ‘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; ‘mturesent’: Resends due to MTU discovery; ‘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; ‘ecn_shs’: ECN successful handshakes; ‘ecn_rcwnd’: ECN reduced the cwnd; ‘sndcack’: Challenge ACK sent; ‘cacklim’: Challenge ACK limited;

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, rcvshort, rcvduppack, rcvdupbyte, rcvpartduppack, rcvpartdupbyte, rcvoopack, rcvoobyte, rcvpackafterwin, rcvbyteafterwin, rcvwinprobe, rcvdupack, rcvacktoomuch, rcvackpack, rcvackbyte, rcvwinupd, pawsdrop, predack, preddat, persistdrop, mturesent, badrst, finwait2_drops, sack_recovery_episode, sack_rexmits, sack_rexmit_bytes, sack_rcv_blocks, sack_send_blocks, ecn_shs, ecn_rcwnd, sndcack, cacklim

control-cpu

Specification
Type object

uuid

Description: uuid of the object

Type: string

tcp

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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;

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

bandwidth

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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

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

Type: List

uuid

Description: uuid of the object

Type: string

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_ounter’: Reverse NAT TCP; ‘reverse_nat_udp_ounter’: 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_donn’: 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;

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_ounter, reverse_nat_udp_ounter, 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_donn, 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

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

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

del-port

Specification
Type object

port-index

Description: port index to be configured (Specify port index)

Type: number

Range: 0-32

ndisc-ra

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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

ip-stats

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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

add-port

Specification
Type object

port-index

Description: port index to be configured (Specify port index)

Type: number

Range: 0-32

icmp

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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

bfd

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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; ‘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, other_error

ip6-stats

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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

template

Specification
Type object

template-monitor

Description: Apply monitor template to the whole system (Monitor template ID Number)

Type: number

Range: 1-16

Reference Object: /axapi/v3/slb/template/monitor

template-policy

Description: Apply policy template to the whole system (Policy template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/policy

uuid

Description: uuid of the object

Type: string

memory

Specification
Type object

sampling-enable

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

Type: List

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

data-cpu

Specification
Type object

uuid

Description: uuid of the object

Type: string

ve-mac-scheme

Specification
Type object

uuid

Description: uuid of the object

Type: string

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

template-bind

Specification
Type object

monitor-list

Description: monitor-list is a JSON List . Please see below for l2_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

Reference Object: /axapi/v3/slb/template/monitor

uuid

Description: uuid of the object

Type: string

icmp-rate

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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

add-cpu-core

Specification
Type object

core-index

Description: core index to be added (Specify core index)

Type: number

Range: 0-128

ipsec

Specification
Type object

crypto-core

Description: Crypto cores assigned for IPsec processing

Type: number

Range: 0-56

Default: 0

crypto-mem

Description: Crypto memory percentage assigned for IPsec processing

Type: number

Range: 0-100

Default: 0

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

resource-usage

Specification
Type object

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

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

l4-session-count

Description: Total Sessions in the System

Type: number

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

uuid

Description: uuid of the object

Type: string

cpu-load-sharing

Specification
Type object

cpu-usage

Description: cpu-usage is a JSON Block . Please see below for l2_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 l2_packets-per-second

Type: Object

uuid

Description: uuid of the object

Type: string

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

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

icmp6

Specification
Type object

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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

delete-cpu-core

Specification
Type object

core-index

Description: core index to be deleted (Specify core index)

Type: number

Range: 0-128