.. _slb: slb === SLB related commands slb Specification ----------------- ===================================== ============================================ **Parameter** **Value** ===================================== ============================================ **Type** *Intermediate Resource* **Element Name** slb **Element URI** /axapi/v3/slb **Element Attributes** slb_attributes **Partition Visibility** shared **Schema** :download:`slb schema ` ===================================== ============================================ **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/slb .. raw:: html slb_attributes .. raw:: html
.. _3076_slb_attributes: slb attributes -------------- **ac-class-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/ac-class-list/{name} ` **aflex** **Description:** aflex is a **JSON Block**. Please see below for :ref:`3076_aflex` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/aflex ` **aflex-log** **Description:** aflex-log is a **JSON Block**. Please see below for :ref:`3076_aflex-log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/aflex-log ` **aflow** **Description:** aflow is a **JSON Block**. Please see below for :ref:`3076_aflow` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/aflow ` **common** **Description:** common is a **JSON Block**. Please see below for :ref:`3076_common` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/common ` **connection-reuse** **Description:** connection-reuse is a **JSON Block**. Please see below for :ref:`3076_connection-reuse` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/connection-reuse ` **crl-srcip** **Description:** crl-srcip is a **JSON Block**. Please see below for :ref:`3076_crl-srcip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/crl-srcip ` **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`3076_dns` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/dns ` **dns-cache** **Description:** dns-cache is a **JSON Block**. Please see below for :ref:`3076_dns-cache` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/dns-cache ` **dns-persistent-cache** **Description:** dns-persistent-cache is a **JSON Block**. Please see below for :ref:`3076_dns-persistent-cache` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/dns-persistent-cache ` **dns-response-rate-limiting** **Description:** dns-response-rate-limiting is a **JSON Block**. Please see below for :ref:`3076_dns-response-rate-limiting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/dns-response-rate-limiting ` **dns64** **Description:** dns64 is a **JSON Block**. Please see below for :ref:`3076_dns64` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/dns64 ` **domain-list-info** **Description:** domain-list-info is a **JSON Block**. Please see below for :ref:`3076_domain-list-info` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/domain-list-info ` **ecmp** **Description:** ecmp is a **JSON Block**. Please see below for :ref:`3076_ecmp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ecmp ` **fast-http-proxy** **Description:** fast-http-proxy is a **JSON Block**. Please see below for :ref:`3076_fast-http-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/fast-http-proxy ` **fix** **Description:** fix is a **JSON Block**. Please see below for :ref:`3076_fix` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/fix ` **forward-proxy** **Description:** forward-proxy is a **JSON Block**. Please see below for :ref:`3076_forward-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/forward-proxy ` **ftp-ctl** **Description:** ftp-ctl is a **JSON Block**. Please see below for :ref:`3076_ftp-ctl` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ftp-ctl ` **ftp-data** **Description:** ftp-data is a **JSON Block**. Please see below for :ref:`3076_ftp-data` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ftp-data ` **ftp-proxy** **Description:** ftp-proxy is a **JSON Block**. Please see below for :ref:`3076_ftp-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ftp-proxy ` **fwd-policy-snat-pt-only** **Description:** fwd-policy-snat-pt-only is a **JSON Block**. Please see below for :ref:`3076_fwd-policy-snat-pt-only` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/fwd-policy-snat-pt-only ` **gaming-protocol-compliance-port-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/gaming-protocol-compliance-port/{port} ` **gaming-protocol-compliance-salt** **Description:** gaming-protocol-compliance-salt is a **JSON Block**. Please see below for :ref:`3076_gaming-protocol-compliance-salt` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/gaming-protocol-compliance-salt ` **generic-proxy** **Description:** generic-proxy is a **JSON Block**. Please see below for :ref:`3076_generic-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/generic-proxy ` **health-check-details** **Description:** health-check-details is a **JSON Block**. Please see below for :ref:`3076_health-check-details` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/health-check-details ` **health-check-summary** **Description:** health-check-summary is a **JSON Block**. Please see below for :ref:`3076_health-check-summary` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/health-check-summary ` **health-down-reason** **Description:** health-down-reason is a **JSON Block**. Please see below for :ref:`3076_health-down-reason` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/health-down-reason ` **health-gateway** **Description:** health-gateway is a **JSON Block**. Please see below for :ref:`3076_health-gateway` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/health-gateway ` **health-monitor** **Description:** health-monitor is a **JSON Block**. Please see below for :ref:`3076_health-monitor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/health-monitor ` **health-stat** **Description:** health-stat is a **JSON Block**. Please see below for :ref:`3076_health-stat` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/health-stat ` **health-up-reason** **Description:** health-up-reason is a **JSON Block**. Please see below for :ref:`3076_health-up-reason` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/health-up-reason ` **hm-dplane** **Description:** hm-dplane is a **JSON Block**. Please see below for :ref:`3076_hm-dplane` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/hm-dplane ` **http-proxy** **Description:** http-proxy is a **JSON Block**. Please see below for :ref:`3076_http-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/http-proxy ` **http2** **Description:** http2 is a **JSON Block**. Please see below for :ref:`3076_http2` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/http2 ` **http3** **Description:** http3 is a **JSON Block**. Please see below for :ref:`3076_http3` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/http3 ` **hw-compress** **Description:** hw-compress is a **JSON Block**. Please see below for :ref:`3076_hw-compress` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/hw-compress ` **icap** **Description:** icap is a **JSON Block**. Please see below for :ref:`3076_icap` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/icap ` **icap_http** **Description:** icap_http is a **JSON Block**. Please see below for :ref:`3076_icap_http` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/icap_http ` **imap-proxy** **Description:** imap-proxy is a **JSON Block**. Please see below for :ref:`3076_imap-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/imap-proxy ` **ip-dns-cache** **Description:** ip-dns-cache is a **JSON Block**. Please see below for :ref:`3076_ip-dns-cache` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ip-dns-cache ` **ipv6-class-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/ipv6-class-list/{name} ` **l4** **Description:** l4 is a **JSON Block**. Please see below for :ref:`3076_l4` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/l4 ` **l7session** **Description:** l7session is a **JSON Block**. Please see below for :ref:`3076_l7session` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/l7session ` **link-probe** **Description:** link-probe is a **JSON Block**. Please see below for :ref:`3076_link-probe` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/link-probe ` **mlb** **Description:** mlb is a **JSON Block**. Please see below for :ref:`3076_mlb` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/mlb ` **mqtt** **Description:** mqtt is a **JSON Block**. Please see below for :ref:`3076_mqtt` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/mqtt ` **mssql** **Description:** mssql is a **JSON Block**. Please see below for :ref:`3076_mssql` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/mssql ` **mysql** **Description:** mysql is a **JSON Block**. Please see below for :ref:`3076_mysql` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/mysql ` **passthrough** **Description:** passthrough is a **JSON Block**. Please see below for :ref:`3076_passthrough` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/passthrough ` **perf** **Description:** perf is a **JSON Block**. Please see below for :ref:`3076_perf` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/perf ` **persist** **Description:** persist is a **JSON Block**. Please see below for :ref:`3076_persist` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/persist ` **player-id-ep** **Description:** player-id-ep is a **JSON Block**. Please see below for :ref:`3076_player-id-ep` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/player-id-ep ` **player-id-global** **Description:** player-id-global is a **JSON Block**. Please see below for :ref:`3076_player-id-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/player-id-global ` **player-id-list** **Description:** player-id-list is a **JSON Block**. Please see below for :ref:`3076_player-id-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/player-id-list ` **pop3-proxy** **Description:** pop3-proxy is a **JSON Block**. Please see below for :ref:`3076_pop3-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/pop3-proxy ` **proxy** **Description:** proxy is a **JSON Block**. Please see below for :ref:`3076_proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/proxy ` **quic** **Description:** quic is a **JSON Block**. Please see below for :ref:`3076_quic` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/quic ` **rate-limit-log** **Description:** rate-limit-log is a **JSON Block**. Please see below for :ref:`3076_rate-limit-log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/rate-limit-log ` **rc-cache-global** **Description:** rc-cache-global is a **JSON Block**. Please see below for :ref:`3076_rc-cache-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/rc-cache-global ` **reset-unknown-conn** **Description:** reset-unknown-conn is a **JSON Block**. Please see below for :ref:`3076_reset-unknown-conn` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/reset-unknown-conn ` **resource-usage** **Description:** resource-usage is a **JSON Block**. Please see below for :ref:`3076_resource-usage` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/resource-usage ` **rpz** **Description:** rpz is a **JSON Block**. Please see below for :ref:`3076_rpz` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/rpz ` **secure-gaming** **Description:** secure-gaming is a **JSON Block**. Please see below for :ref:`3076_secure-gaming` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/secure-gaming ` **server-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/server-group/{name} ` **server-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/server/{name} ` **server-ssl-counters** **Description:** server-ssl-counters is a **JSON Block**. Please see below for :ref:`3076_server-ssl-counters` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/server-ssl-counters ` **service-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/service-group/{name} ` **sip** **Description:** sip is a **JSON Block**. Please see below for :ref:`3076_sip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/sip ` **smpp** **Description:** smpp is a **JSON Block**. Please see below for :ref:`3076_smpp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/smpp ` **smtp** **Description:** smtp is a **JSON Block**. Please see below for :ref:`3076_smtp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/smtp ` **spdy-proxy** **Description:** spdy-proxy is a **JSON Block**. Please see below for :ref:`3076_spdy-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/spdy-proxy ` **sport-rate-limit** **Description:** sport-rate-limit is a **JSON Block**. Please see below for :ref:`3076_sport-rate-limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/sport-rate-limit ` **ssl** **Description:** ssl is a **JSON Block**. Please see below for :ref:`3076_ssl` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl ` **ssl-acme-cert-log** **Description:** ssl-acme-cert-log is a **JSON Block**. Please see below for :ref:`3076_ssl-acme-cert-log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-acme-cert-log ` **ssl-acme-cert-status** **Description:** ssl-acme-cert-status is a **JSON Block**. Please see below for :ref:`3076_ssl-acme-cert-status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-acme-cert-status ` **ssl-ca-cert** **Description:** ssl-ca-cert is a **JSON Block**. Please see below for :ref:`3076_ssl-ca-cert` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-ca-cert ` **ssl-cert** **Description:** ssl-cert is a **JSON Block**. Please see below for :ref:`3076_ssl-cert` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-cert ` **ssl-cert-expire-check** **Description:** ssl-cert-expire-check is a **JSON Block**. Please see below for :ref:`3076_ssl-cert-expire-check` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-cert-expire-check ` **ssl-cert-pinning-candidate-list** **Description:** ssl-cert-pinning-candidate-list is a **JSON Block**. Please see below for :ref:`3076_ssl-cert-pinning-candidate-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-cert-pinning-candidate-list ` **ssl-cert-revoke** **Description:** ssl-cert-revoke is a **JSON Block**. Please see below for :ref:`3076_ssl-cert-revoke` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-cert-revoke ` **ssl-cert-stats** **Description:** ssl-cert-stats is a **JSON Block**. Please see below for :ref:`3076_ssl-cert-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-cert-stats ` **ssl-cmp-cert-log** **Description:** ssl-cmp-cert-log is a **JSON Block**. Please see below for :ref:`3076_ssl-cmp-cert-log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-cmp-cert-log ` **ssl-cmp-cert-status** **Description:** ssl-cmp-cert-status is a **JSON Block**. Please see below for :ref:`3076_ssl-cmp-cert-status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-cmp-cert-status ` **ssl-counters** **Description:** ssl-counters is a **JSON Block**. Please see below for :ref:`3076_ssl-counters` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-counters ` **ssl-crl** **Description:** ssl-crl is a **JSON Block**. Please see below for :ref:`3076_ssl-crl` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-crl ` **ssl-error** **Description:** ssl-error is a **JSON Block**. Please see below for :ref:`3076_ssl-error` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-error ` **ssl-expire-check** **Description:** ssl-expire-check is a **JSON Block**. Please see below for :ref:`3076_ssl-expire-check` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-expire-check ` **ssl-forward-proxy** **Description:** ssl-forward-proxy is a **JSON Block**. Please see below for :ref:`3076_ssl-forward-proxy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-forward-proxy ` **ssl-forward-proxy-cert** **Description:** ssl-forward-proxy-cert is a **JSON Block**. Please see below for :ref:`3076_ssl-forward-proxy-cert` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-forward-proxy-cert ` **ssl-ja3** **Description:** ssl-ja3 is a **JSON Block**. Please see below for :ref:`3076_ssl-ja3` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-ja3 ` **ssl-ocsp** **Description:** ssl-ocsp is a **JSON Block**. Please see below for :ref:`3076_ssl-ocsp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-ocsp ` **ssl-scep-cert-log** **Description:** ssl-scep-cert-log is a **JSON Block**. Please see below for :ref:`3076_ssl-scep-cert-log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-scep-cert-log ` **ssl-scep-cert-status** **Description:** ssl-scep-cert-status is a **JSON Block**. Please see below for :ref:`3076_ssl-scep-cert-status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-scep-cert-status ` **ssl-stats** **Description:** ssl-stats is a **JSON Block**. Please see below for :ref:`3076_ssl-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-stats ` **svm-source-nat** **Description:** svm-source-nat is a **JSON Block**. Please see below for :ref:`3076_svm-source-nat` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/svm-source-nat ` **switch** **Description:** switch is a **JSON Block**. Please see below for :ref:`3076_switch` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/switch ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`3076_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template ` **transparent-acl-template** **Description:** transparent-acl-template is a **JSON Block**. Please see below for :ref:`3076_transparent-acl-template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/transparent-acl-template ` **transparent-tcp-template** **Description:** transparent-tcp-template is a **JSON Block**. Please see below for :ref:`3076_transparent-tcp-template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/transparent-tcp-template ` **tsig** **Description:** tsig is a **JSON Block**. Please see below for :ref:`3076_tsig` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/tsig ` **virtual-server-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/virtual-server/{name} ` .. _3076_rc-cache-global: rc-cache-global ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_rc-cache-global_sampling-enable: rc-cache-global_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Cache Hits; 'miss': Cache Misses; 'bytes_served': Bytes Served; 'total_req': Total Requests; 'caching_req': Cacheable Requests; 'nc_req_header': No-cache Request; 'nc_res_header': Not cacheable; 'rv_success': Revalidation Successes; 'rv_failure': Revalidation Failures; 'ims_request': IMS Requests; 'nm_response': Responses from cache 304 Not Modified; 'rsp_type_CL': Responses from server 200 OK - Cont Len; 'rsp_type_CE': Responses from server 200 OK - Chnk Enc; 'rsp_type_304': Responses from server 304 Not Modified; 'rsp_type_other': Responses from server 200 OK - Other; 'rsp_no_compress': Responses from cache 200 OK - No Comp; 'rsp_gzip': Responses from cache 200 OK - Gzip; 'rsp_deflate': Responses from cache 200 OK - Deflate; 'rsp_other': Responses from cache Other; 'nocache_match': Policy URI nocache; 'match': Policy URI cache; 'invalidate_match': Policy URI invalidate; 'content_toobig': Policy Content Too Big; 'content_toosmall': Policy Content Too Small; 'entry_create_failures': Entry Create failures; 'mem_size': Memory Used; 'entry_num': Entry Cached; 'replaced_entry': Entry Replaced; 'aging_entry': Entry Aged Out; 'cleaned_entry': Entry Cleaned; 'rsp_type_stream': Responses from http2 server 200 OK - Stream; 'rsp_br': Responses from cache 200 OK - Brotli; **Type:** string **Supported Values:** all, hits, miss, bytes_served, total_req, caching_req, nc_req_header, nc_res_header, rv_success, rv_failure, ims_request, nm_response, rsp_type_CL, rsp_type_CE, rsp_type_304, rsp_type_other, rsp_no_compress, rsp_gzip, rsp_deflate, rsp_other, nocache_match, match, invalidate_match, content_toobig, content_toosmall, entry_create_failures, mem_size, entry_num, replaced_entry, aging_entry, cleaned_entry, rsp_type_stream, rsp_br .. _3076_imap-proxy: imap-proxy ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_imap-proxy_sampling-enable: imap-proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num': Num; 'curr': Current proxy conns; 'total': Total proxy conns; 'svrsel_fail': Server selection failure; 'no_route': no route failure; 'snat_fail': source nat failure; 'feat': feat packet; 'cc': clear ctrl port packet; 'data_ssl': data ssl force; 'line_too_long': line too long; 'line_mem_freed': request line freed; 'invalid_start_line': invalid start line; 'auth_tls': auth tls cmd; 'prot': prot cmd; 'pbsz': pbsz cmd; 'pasv': pasv cmd; 'port': port cmd; 'request_dont_care': other cmd; 'client_auth_tls': client auth tls; 'cant_find_pasv': cant find pasv; 'pasv_addr_ne_server': psv addr not equal to svr; 'smp_create_fail': smp create fail; 'data_server_conn_fail': data svr conn fail; 'data_send_fail': data send fail; 'epsv': epsv command; 'cant_find_epsv': cant find epsv; 'data_curr': Current Data Proxy; 'data_total': Total Data Proxy; 'auth_unsupported': Unsupported auth; 'adat': adat cmd; 'unsupported_pbsz_value': Unsupported PBSZ; 'unsupported_prot_value': Unsupported PROT; 'unsupported_command': Unsupported cmd; 'control_to_clear': Control chn clear txt; 'control_to_ssl': Control chn ssl; 'bad_sequence': Bad Sequence; 'rsv_persist_conn_fail': Serv Sel Persist fail; 'smp_v6_fail': Serv Sel SMPv6 fail; 'smp_v4_fail': Serv Sel SMPv4 fail; 'insert_tuple_fail': Serv Sel insert tuple fail; 'cl_est_err': Client EST state erro; 'ser_connecting_err': Serv CTNG state error; 'server_response_err': Serv RESP state error; 'cl_request_err': Client RQ state error; 'data_conn_start_err': Data Start state error; 'data_serv_connecting_err': Data Serv CTNG error; 'data_serv_connected_err': Data Serv CTED error; 'request': Total FTP Request; 'capability': Capability cmd; 'start_tls': Total Start TLS cmd; 'login': Total Login cmd; 'realloc_error': Realloc error; 'alloc_error': Alloc error; 'boundary_error': Boundary error; 'negative_error': Negative error; **Type:** string **Supported Values:** all, num, curr, total, svrsel_fail, no_route, snat_fail, feat, cc, data_ssl, line_too_long, line_mem_freed, invalid_start_line, auth_tls, prot, pbsz, pasv, port, request_dont_care, client_auth_tls, cant_find_pasv, pasv_addr_ne_server, smp_create_fail, data_server_conn_fail, data_send_fail, epsv, cant_find_epsv, data_curr, data_total, auth_unsupported, adat, unsupported_pbsz_value, unsupported_prot_value, unsupported_command, control_to_clear, control_to_ssl, bad_sequence, rsv_persist_conn_fail, smp_v6_fail, smp_v4_fail, insert_tuple_fail, cl_est_err, ser_connecting_err, server_response_err, cl_request_err, data_conn_start_err, data_serv_connecting_err, data_serv_connected_err, request, capability, start_tls, login, realloc_error, alloc_error, boundary_error, negative_error .. _3076_ssl-cert-stats: ssl-cert-stats ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_mysql: mysql ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_mysql_sampling-enable: mysql_sampling-enable ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_proxy': Curr Proxy Conns; 'total_proxy': Total Proxy Conns; 'curr_be_enc': Curr BE Encryption Conns; 'total_be_enc': Total BE Encryption Conns; 'curr_fe_enc': Curr FE Encryption Conns; 'total_fe_enc': Total FE Encryption Conns; 'client_fin': Client FIN; 'server_fin': Server FIN; 'session_err': Session err; 'queries': DB Queries; 'commands': DB commands reply; **Type:** string **Supported Values:** all, curr_proxy, total_proxy, curr_be_enc, total_be_enc, curr_fe_enc, total_fe_enc, client_fin, server_fin, session_err, queries, commands .. _3076_aflex: aflex ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_domain-list-info: domain-list-info ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_spdy-proxy: spdy-proxy ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_spdy-proxy_sampling-enable: spdy-proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_proxy': Curr Proxy Conns; 'total_proxy': Total Proxy Conns; 'curr_http_proxy': Curr HTTP Proxy Conns; 'total_http_proxy': Total HTTP Proxy Conns; 'total_v2_proxy': Version 2 Streams; 'total_v3_proxy': Version 3 Streams; 'curr_stream': Curr Streams; 'total_stream': Total Streams; 'total_stream_succ': Streams(succ); 'client_rst': client_rst; 'server_rst': Server RST sent; 'client_goaway': client_goaway; 'server_goaway': Server GOAWAY sent; 'tcp_err': TCP sock error; 'inflate_ctx': Inflate context; 'deflate_ctx': Deflate context; 'ping_sent': PING sent; 'stream_not_found': STREAM not found; 'client_fin': Client FIN; 'server_fin': Server FIN; 'stream_close': Stream close; 'stream_err': Stream err; 'session_err': Session err; 'control_frame': Control frame received; 'syn_frame': SYN stream frame received; 'syn_reply_frame': SYN reply frame received; 'headers_frame': Headers frame received; 'settings_frame': Setting frame received; 'window_frame': Window update frame received; 'ping_frame': Ping frame received; 'data_frame': Data frame received; 'data_no_stream': Data no stream found; 'data_no_stream_no_goaway': Data no stream and no goaway; 'data_no_stream_goaway_close': Data no stream and no goaway and close session; 'est_cb_no_tuple': Est callback no tuple; 'data_cb_no_tuple': Data callback no tuple; 'ctx_alloc_fail': Context alloc fail; 'fin_close_session': FIN close session; 'server_rst_close_stream': Server RST close stream; 'stream_found': Stream found; 'close_stream_session_not_found': Close stream session not found; 'close_stream_stream_not_found': Close stream stream not found; 'close_stream_already_closed': Closing closed stream; 'close_stream_session_close': Stream close session close; 'close_session_already_closed': Closing closed session; 'max_concurrent_stream_limit': Max concurrent stream limit; 'stream_alloc_fail': Stream alloc fail; 'http_conn_alloc_fail': HTTP connection allocation fail; 'request_header_alloc_fail': Request/Header allocation fail; 'name_value_total_len_ex': Name value total length exceeded; 'name_value_zero_len': Name value zero name length; 'name_value_invalid_http_ver': Name value invalid http version; 'name_value_connection': Name value connection; 'name_value_keepalive': Name value keep alive; 'name_value_proxy_conn': Name value proxy-connection; 'name_value_trasnfer_encod': Name value transfer encoding; 'name_value_no_must_have': Name value no must have; 'decompress_fail': Decompress fail; 'syn_after_goaway': SYN after goaway; 'stream_lt_prev': Stream id less than previous; 'syn_stream_exist_or_even': Stream already exists; 'syn_unidir': Unidirectional SYN; 'syn_reply_alr_rcvd': SYN reply already received; 'client_rst_nostream': Close RST stream not found; 'window_no_stream': Window update no stream found; 'invalid_window_size': Invalid window size; 'unknown_control_frame': Unknown control frame; 'data_on_closed_stream': Data on closed stream; 'invalid_frame_size': Invalid frame size; 'invalid_version': Invalid version; 'header_after_session_close': Header after session close; 'compress_ctx_alloc_fail': Compression context allocation fail; 'header_compress_fail': Header compress fail; 'http_data_session_close': HTTP data session close; 'http_data_stream_not_found': HTTP data stream not found; 'close_stream_not_http_proxy': Close Stream not http-proxy; 'session_needs_requeue': Session needs requeue; 'new_stream_session_del': New Stream after Session delete; 'fin_stream_closed': HTTP FIN stream already closed; 'http_close_stream_closed': HTTP close stream already closed; 'http_err_stream_closed': HTTP error stream already closed; 'http_hdr_stream_close': HTTP header stream already closed; 'http_data_stream_close': HTTP data stream already closed; 'session_close': Session close; **Type:** string **Supported Values:** all, curr_proxy, total_proxy, curr_http_proxy, total_http_proxy, total_v2_proxy, total_v3_proxy, curr_stream, total_stream, total_stream_succ, client_rst, server_rst, client_goaway, server_goaway, tcp_err, inflate_ctx, deflate_ctx, ping_sent, stream_not_found, client_fin, server_fin, stream_close, stream_err, session_err, control_frame, syn_frame, syn_reply_frame, headers_frame, settings_frame, window_frame, ping_frame, data_frame, data_no_stream, data_no_stream_no_goaway, data_no_stream_goaway_close, est_cb_no_tuple, data_cb_no_tuple, ctx_alloc_fail, fin_close_session, server_rst_close_stream, stream_found, close_stream_session_not_found, close_stream_stream_not_found, close_stream_already_closed, close_stream_session_close, close_session_already_closed, max_concurrent_stream_limit, stream_alloc_fail, http_conn_alloc_fail, request_header_alloc_fail, name_value_total_len_ex, name_value_zero_len, name_value_invalid_http_ver, name_value_connection, name_value_keepalive, name_value_proxy_conn, name_value_trasnfer_encod, name_value_no_must_have, decompress_fail, syn_after_goaway, stream_lt_prev, syn_stream_exist_or_even, syn_unidir, syn_reply_alr_rcvd, client_rst_nostream, window_no_stream, invalid_window_size, unknown_control_frame, data_on_closed_stream, invalid_frame_size, invalid_version, header_after_session_close, compress_ctx_alloc_fail, header_compress_fail, http_data_session_close, http_data_stream_not_found, close_stream_not_http_proxy, session_needs_requeue, new_stream_session_del, fin_stream_closed, http_close_stream_closed, http_err_stream_closed, http_hdr_stream_close, http_data_stream_close, session_close .. _3076_fix: fix ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_fix_sampling-enable: fix_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_proxy': Current proxy conns; 'total_proxy': Total proxy conns; 'svrsel_fail': Server selection failure; 'noroute': No route failure; 'snat_fail': Source NAT failure; 'client_err': Client fail; 'server_err': Server fail; 'insert_clientip': Insert client IP; 'default_switching': Default switching; 'sender_switching': Sender ID switching; 'target_switching': Target ID switching; 'client_tls_conn': Client TLS conn; 'server_tls_conn': Server TLS conn; **Type:** string **Supported Values:** all, curr_proxy, total_proxy, svrsel_fail, noroute, snat_fail, client_err, server_err, insert_clientip, default_switching, sender_switching, target_switching, client_tls_conn, server_tls_conn .. _3076_mqtt: mqtt ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_mqtt_sampling-enable: mqtt_sampling-enable ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'recv_mqtt_connect': MQTT Connect; 'recv_mqtt_connack': MQTT Connack; 'recv_mqtt_publish': MQTT Publish; 'recv_mqtt_puback': MQTT Puback; 'recv_mqtt_pubrec': MQTT Pubrec; 'recv_mqtt_pubrel': MQTT Pubrel; 'recv_mqtt_pubcomp': MQTT Pubcomp; 'recv_mqtt_subscribe': MQTT Subscribe; 'recv_mqtt_suback': MQTT Suback; 'recv_mqtt_unsubscribe': MQTT Unsubscribe; 'recv_mqtt_unsuback': MQTT Unsuback; 'recv_mqtt_pingreq': MQTT Pingreq; 'recv_mqtt_pingresp': MQTT Pingresp; 'recv_mqtt_disconnect': MQTT Disconnect; 'recv_mqtt_auth': MQTT Auth; 'recv_mqtt_other': MQTT Unknown; 'curr_proxy': Current proxy conns; 'total_proxy': Total proxy conns; 'request': Total MQTT Commands; 'parse_connect_fail': Parse connect failure; 'parse_publish_fail': Parse publish failure; 'parse_subscribe_fail': Parse subscribe failure; 'parse_unsubscribe_fail': Parse unsubscribe failure; 'tuple_not_linked': tuple-not-linked failure; 'tuple_already_linked': tuple-already-linked failure; 'conn_null': Null conn; 'client_id_null': Null client id; 'session_exist': Session already exist; 'insertion_failed': Insertion failure; 'insertion_successful': Insertion successful; **Type:** string **Supported Values:** all, recv_mqtt_connect, recv_mqtt_connack, recv_mqtt_publish, recv_mqtt_puback, recv_mqtt_pubrec, recv_mqtt_pubrel, recv_mqtt_pubcomp, recv_mqtt_subscribe, recv_mqtt_suback, recv_mqtt_unsubscribe, recv_mqtt_unsuback, recv_mqtt_pingreq, recv_mqtt_pingresp, recv_mqtt_disconnect, recv_mqtt_auth, recv_mqtt_other, curr_proxy, total_proxy, request, parse_connect_fail, parse_publish_fail, parse_subscribe_fail, parse_unsubscribe_fail, tuple_not_linked, tuple_already_linked, conn_null, client_id_null, session_exist, insertion_failed, insertion_successful .. _3076_health-check-summary: health-check-summary ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_persist: persist ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_persist_sampling-enable: persist_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hash_tbl_trylock_fail': Hash tbl lock fail; 'hash_tbl_create_ok': Hash tbl create ok; 'hash_tbl_create_fail': Hash tbl create fail; 'hash_tbl_free': Hash tbl free; 'hash_tbl_rst_updown': Hash tbl reset (up/down); 'hash_tbl_rst_adddel': Hash tbl reset (add/del); 'url_hash_pri': URL hash persist (pri); 'url_hash_enqueue': URL hash persist (enQ); 'url_hash_sec': URL hash persist (sec); 'url_hash_fail': URL hash persist fail; 'header_hash_pri': Header hash persist(pri); 'header_hash_enqueue': Header hash persist(enQ); 'header_hash_sec': Header hash persist(sec); 'header_hash_fail': Header hash persist fail; 'src_ip': SRC IP persist ok; 'src_ip_enqueue': SRC IP persist enqueue; 'src_ip_fail': SRC IP persist fail; 'src_ip_new_sess_cache': SRC IP new sess (cache); 'src_ip_new_sess_cache_fail': SRC IP new sess fail (c); 'src_ip_new_sess_sel': SRC IP new sess (select); 'src_ip_new_sess_sel_fail': SRC IP new sess fail (s); 'src_ip_hash_pri': SRC IP hash persist(pri); 'src_ip_hash_enqueue': SRC IP hash persist(enQ); 'src_ip_hash_sec': SRC IP hash persist(sec); 'src_ip_hash_fail': SRC IP hash persist fail; 'src_ip_enforce': Enforce higher priority; 'dst_ip': DST IP persist ok; 'dst_ip_enqueue': DST IP persist enqueue; 'dst_ip_fail': DST IP persist fail; 'dst_ip_new_sess_cache': DST IP new sess (cache); 'dst_ip_new_sess_cache_fail': DST IP new sess fail (c); 'dst_ip_new_sess_sel': DST IP new sess (select); 'dst_ip_new_sess_sel_fail': DST IP new sess fail (s); 'dst_ip_hash_pri': DST IP hash persist(pri); 'dst_ip_hash_enqueue': DST IP hash persist(enQ); 'dst_ip_hash_sec': DST IP hash persist(sec); 'dst_ip_hash_fail': DST IP hash persist fail; 'cssl_sid_not_found': Client SSL SID not found; 'cssl_sid_match': Client SSL SID match; 'cssl_sid_not_match': Client SSL SID not match; 'sssl_sid_not_found': Server SSL SID not found; 'sssl_sid_reset': Server SSL SID reset; 'sssl_sid_match': Server SSL SID match; 'sssl_sid_not_match': Server SSL SID not match; 'ssl_sid_persist_ok': SSL SID persist ok; 'ssl_sid_persist_fail': SSL SID persist fail; 'ssl_sid_session_ok': Create SSL SID ok; 'ssl_sid_session_fail': Create SSL SID fail; 'cookie_persist_ok': Cookie persist ok; 'cookie_persist_fail': Cookie persist fail; 'cookie_not_found': Persist cookie not found; 'cookie_pass_thru': Persist cookie Pass-thru; 'cookie_invalid': Invalid persist cookie; **Type:** string **Supported Values:** all, hash_tbl_trylock_fail, hash_tbl_create_ok, hash_tbl_create_fail, hash_tbl_free, hash_tbl_rst_updown, hash_tbl_rst_adddel, url_hash_pri, url_hash_enqueue, url_hash_sec, url_hash_fail, header_hash_pri, header_hash_enqueue, header_hash_sec, header_hash_fail, src_ip, src_ip_enqueue, src_ip_fail, src_ip_new_sess_cache, src_ip_new_sess_cache_fail, src_ip_new_sess_sel, src_ip_new_sess_sel_fail, src_ip_hash_pri, src_ip_hash_enqueue, src_ip_hash_sec, src_ip_hash_fail, src_ip_enforce, dst_ip, dst_ip_enqueue, dst_ip_fail, dst_ip_new_sess_cache, dst_ip_new_sess_cache_fail, dst_ip_new_sess_sel, dst_ip_new_sess_sel_fail, dst_ip_hash_pri, dst_ip_hash_enqueue, dst_ip_hash_sec, dst_ip_hash_fail, cssl_sid_not_found, cssl_sid_match, cssl_sid_not_match, sssl_sid_not_found, sssl_sid_reset, sssl_sid_match, sssl_sid_not_match, ssl_sid_persist_ok, ssl_sid_persist_fail, ssl_sid_session_ok, ssl_sid_session_fail, cookie_persist_ok, cookie_persist_fail, cookie_not_found, cookie_pass_thru, cookie_invalid .. _3076_generic-proxy: generic-proxy ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_generic-proxy_sampling-enable: generic-proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num': Number; 'curr': Current; 'total': Total; 'svrsel_fail': Number of server selection failed; 'no_route': Number of no routes; 'snat_fail': Number of snat failures; 'client_fail': Number of client failures; 'server_fail': Number of server failures; 'no_sess': Number of no sessions; 'user_session': Number of user sessions; 'acr_out': Number of ACRs out; 'acr_in': Number of ACRs in; 'aca_out': Number of ACAs out; 'aca_in': Number of ACAs in; 'cea_out': Number of CEAs out; 'cea_in': Number of CEAs in; 'cer_out': Number of CERs out; 'cer_in': Number of CERs in; 'dwr_out': Number of DWRs out; 'dwr_in': Number of DWRs in; 'dwa_out': Number of DWAs out; 'dwa_in': Number of DWAs in; 'str_out': Number of STRs out; 'str_in': Number of STRs in; 'sta_out': Number of STAs out; 'sta_in': Number of STAs in; 'asr_out': Number of ASRs out; 'asr_in': Number of ASRs in; 'asa_out': Number of ASAs out; 'asa_in': Number of ASAs in; 'other_out': Number of other messages out; 'other_in': Number of other messages in; 'total_http_req_enter_gen': Total number of HTTP requests enter generic proxy; 'mismatch_fwd_id': Diameter mismatch fwd session id; 'mismatch_rev_id': Diameter mismatch rev session id; 'unkwn_cmd_code': Diameter unkown cmd code; 'no_session_id': Diameter no session id avp; 'no_fwd_tuple': Diameter no fwd tuple matched; 'no_rev_tuple': Diameter no rev tuple matched; 'dcmsg_fwd_in': Diameter cross cpu fwd in; 'dcmsg_fwd_out': Diameter cross cpu fwd out; 'dcmsg_rev_in': Diameter cross cpu rev in; 'dcmsg_rev_out': Diameter cross cpu rev out; 'dcmsg_error': Diameter cross cpu error; 'retry_client_request': Diameter retry client request; 'retry_client_request_fail': Diameter retry client request fail; 'reply_unknown_session_id': Reply with unknown session ID error info; 'ccr_out': Number of CCRs out; 'ccr_in': Number of CCRs in; 'cca_out': Number of CCAs out; 'cca_in': Number of CCAs in; 'ccr_i': Number of CCRs initial; 'ccr_u': Number of CCRs update; 'ccr_t': Number of CCRs terminate; 'cca_t': Number of CCAs terminate; 'terminate_on_cca_t': Diameter terminate on cca_t; 'forward_unknown_session_id': Forward server side message with unknown session id; 'update_latest_server': Update to the latest server that used a session id; 'client_select_fail': Fail to select client; 'close_conn_when_vport_down': Close client conn when virtual port is down; 'invalid_avp': AVP value contains illegal chars; 'reselect_fwd_tuple': Original client tuple does not exist so reselect another one; 'reselect_fwd_tuple_other_cpu': Original client tuple does not exist so reselect another one on other CPUs; 'reselect_rev_tuple': Original server tuple does not exist so reselect another one; 'conn_closed_by_client': Client initiates TCP close/reset; 'conn_closed_by_server': Server initiates TCP close/reset; 'reply_invalid_avp_value': Reply with invalid AVP error info; 'reply_unable_to_deliver': Reply with unable to deliver error info; 'reply_error_info_fail': Fail to reply error info to peer; 'dpr_out': Number of DPRs out; 'dpr_in': Number of DPRs in; 'dpa_out': Number of DPAs out; 'dpa_in': Number of DPAs in; **Type:** string **Supported Values:** all, num, curr, total, svrsel_fail, no_route, snat_fail, client_fail, server_fail, no_sess, user_session, acr_out, acr_in, aca_out, aca_in, cea_out, cea_in, cer_out, cer_in, dwr_out, dwr_in, dwa_out, dwa_in, str_out, str_in, sta_out, sta_in, asr_out, asr_in, asa_out, asa_in, other_out, other_in, total_http_req_enter_gen, mismatch_fwd_id, mismatch_rev_id, unkwn_cmd_code, no_session_id, no_fwd_tuple, no_rev_tuple, dcmsg_fwd_in, dcmsg_fwd_out, dcmsg_rev_in, dcmsg_rev_out, dcmsg_error, retry_client_request, retry_client_request_fail, reply_unknown_session_id, ccr_out, ccr_in, cca_out, cca_in, ccr_i, ccr_u, ccr_t, cca_t, terminate_on_cca_t, forward_unknown_session_id, update_latest_server, client_select_fail, close_conn_when_vport_down, invalid_avp, reselect_fwd_tuple, reselect_fwd_tuple_other_cpu, reselect_rev_tuple, conn_closed_by_client, conn_closed_by_server, reply_invalid_avp_value, reply_unable_to_deliver, reply_error_info_fail, dpr_out, dpr_in, dpa_out, dpa_in .. _3076_secure-gaming: secure-gaming ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_secure-gaming_sampling-enable: secure-gaming_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'secure_gaming_pass': Secure Gaming passed; 'secure_gaming_drop': Secure Gaming dropped; **Type:** string **Supported Values:** all, secure_gaming_pass, secure_gaming_drop .. _3076_http-proxy: http-proxy ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_http-proxy_sampling-enable: http-proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num': Num; 'curr_proxy': Curr Proxy Conns; 'total_proxy': Total Proxy Conns; 'req': HTTP requests; 'req_succ': HTTP requests(succ); 'noproxy': No proxy error; 'client_rst': Client RST; 'server_rst': Server RST; 'notuple': No tuple error; 'parsereq_fail': Parse req fail; 'svrsel_fail': Server selection fail; 'fwdreq_fail': Fwd req fail; 'fwdreq_fail_buff': Fwd req fail - buff; 'fwdreq_fail_rport': Fwd req fail - rport; 'fwdreq_fail_route': Fwd req fail - route; 'fwdreq_fail_persist': Fwd req fail - persist; 'fwdreq_fail_server': Fwd req fail - server; 'fwdreq_fail_tuple': Fwd req fail - tuple; 'fwdreqdata_fail': some help string; 'req_retran': Packets retrans; 'req_ofo': Packets ofo; 'server_resel': Server reselection; 'svr_prem_close': Server premature close; 'new_svrconn': Server conn made; 'snat_fail': Source NAT failure; 'tcpoutrst': Out RSTs; 'full_proxy': Full proxy tot; 'full_proxy_post': Full proxy POST; 'full_proxy_pipeline': Full proxy pipeline; 'full_proxy_fpga_err': Full proxy fpga err; 'req_over_limit': Request over limit; 'req_rate_over_limit': Request rate over limit; 'l4_switching': L4 switching; 'cookie_switching': Cookie switching; 'aflex_switching': aFleX switching; 'http_policy_switching': HTTP Policy switching; 'url_switching': URL switching; 'host_switching': Host switching; 'lb_switching': Normal LB switching; 'l4_switching_ok': L4 switching (succ); 'cookie_switching_ok': Cookie switching (succ); 'aflex_switching_ok': aFleX switching (succ); 'http_policy_switching_ok': HTTP Policy switching (succ); 'url_switching_ok': URL switching (succ); 'host_switching_ok': Host switching (succ); 'lb_switching_ok': Normal LB switch. (succ); 'l4_switching_enqueue': L4 switching (enQ); 'cookie_switching_enqueue': Cookie switching (enQ); 'aflex_switching_enqueue': aFleX switching (enQ); 'http_policy_switching_enqueue': HTTP Policy switching (enQ); 'url_switching_enqueue': URL switching (enQ); 'host_switching_enqueue': Host switching (enQ); 'lb_switching_enqueue': Normal LB switch. (enQ); 'retry_503': Retry on 503; 'aflex_retry': aFleX http retry; 'aflex_lb_reselect': aFleX lb reselect; 'aflex_lb_reselect_ok': aFleX lb reselect (succ); 'client_rst_request': Client RST - request; 'client_rst_connecting': Client RST - connecting; 'client_rst_connected': Client RST - connected; 'client_rst_response': Client RST - response; 'server_rst_request': Server RST - request; 'server_rst_connecting': Server RST - connecting; 'server_rst_connected': Server RST - connected; 'server_rst_response': Server RST - response; 'invalid_header': Invalid header; 'too_many_headers': Too many headers; 'line_too_long': Line too long; 'header_name_too_long': Header name too long; 'wrong_resp_header': Wrong response header; 'header_insert': Header insert; 'header_delete': Header delete; 'insert_client_ip': Insert client IP; 'negative_req_remain': Negative request remain; 'negative_resp_remain': Negative response remain; 'large_cookie': Large cookies; 'large_cookie_header': Large cookie headers; 'huge_cookie': Huge cookies; 'huge_cookie_header': Huge cookie headers; 'parse_cookie_fail': Parse cookie fail; 'parse_setcookie_fail': Parse set-cookie fail; 'asm_cookie_fail': Assemble cookie fail; 'asm_cookie_header_fail': Asm cookie header fail; 'asm_setcookie_fail': Assemble set-cookie fail; 'asm_setcookie_header_fail': Asm set-cookie hdr fail; 'client_req_unexp_flag': Client req unexp flags; 'connecting_fin': Connecting FIN; 'connecting_fin_retrans': Connecting FIN retran; 'connecting_fin_ofo': Connecting FIN ofo; 'connecting_rst': Connecting RST; 'connecting_rst_retrans': Connecting RST retran; 'connecting_rst_ofo': Connecting RST ofo; 'connecting_ack': Connecting ACK; 'pkts_ofo': Packets ofo; 'pkts_retrans': Packets retrans; 'pkts_retrans_ack_finwait': retrans ACK FWAIT; 'pkts_retrans_fin': retrans FIN; 'pkts_retrans_rst': retrans RST; 'pkts_retrans_push': retrans PSH; 'stale_sess': Stale sess; 'server_resel_failed': Server re-select failed; 'compression_before': Tot data before compress; 'compression_after': Tot data after compress; 'response_1xx': Status code 1XX; 'response_100': Status code 100; 'response_101': Status code 101; 'response_102': Status code 102; 'response_2xx': Status code 2XX; 'response_200': Status code 200; 'response_201': Status code 201; 'response_202': Status code 202; 'response_203': Status code 203; 'response_204': Status code 204; 'response_205': Status code 205; 'response_206': Status code 206; 'response_207': Status code 207; 'response_3xx': Status code 3XX; 'response_300': Status code 300; 'response_301': Status code 301; 'response_302': Status code 302; 'response_303': Status code 303; 'response_304': Status code 304; 'response_305': Status code 305; 'response_306': Status code 306; 'response_307': Status code 307; 'response_4xx': Status code 4XX; 'response_400': Status code 400; 'response_401': Status code 401; 'response_402': Status code 402; 'response_403': Status code 403; 'response_404': Status code 404; 'response_405': Status code 405; 'response_406': Status code 406; 'response_407': Status code 407; 'response_408': Status code 408; 'response_409': Status code 409; 'response_410': Status code 410; 'response_411': Status code 411; 'response_412': Status code 412; 'response_413': Status code 413; 'response_414': Status code 414; 'response_415': Status code 415; 'response_416': Status code 416; 'response_417': Status code 417; 'response_418': Status code 418; 'response_422': Status code 422; 'response_423': Status code 423; 'response_424': Status code 424; 'response_425': Status code 425; 'response_426': Status code 426; 'response_449': Status code 449; 'response_450': Status code 450; 'response_5xx': Status code 5XX; 'response_500': Status code 500; 'response_501': Status code 501; 'response_502': Status code 502; 'response_503': Status code 503; 'response_504': Status code 504; 'response_505': Status code 505; 'response_506': Status code 506; 'response_507': Status code 507; 'response_508': Status code 508; 'response_509': Status code 509; 'response_510': Status code 510; 'response_6xx': Status code 6XX; 'response_unknown': Status code unknown; 'req_http10': Request 1.0; 'req_http11': Request 1.1; 'response_http10': Resp 1.0; 'response_http11': Resp 1.1; 'req_get': Method GET; 'req_head': Method HEAD; 'req_put': Method PUT; 'req_post': Method POST; 'req_trace': Method TRACE; 'req_options': Method OPTIONS; 'req_connect': Method CONNECT; 'req_delete': Method DELETE; 'req_unknown': Method UNKNOWN; 'req_content_len': Req content len; 'rsp_content_len': Resp content len; 'rsp_chunk': Resp chunk encoding; 'req_chunk': Req chunk encoding; 'compress_rsp': Compress req; 'compress_del_accept_enc': Compress del accept enc; 'compress_resp_already_compressed': Resp already compressed; 'compress_content_type_excluded': Compress cont type excl; 'compress_no_content_type': Compress no cont type; 'compress_resp_lt_min': Compress resp less than min; 'compress_resp_no_cl_or_ce': Compress resp no CL/CE; 'compress_ratio_too_high': Compress ratio too high; 'cache_rsp': HTTP req (cache succ); 'close_on_ddos': Close on DDoS; 'req_http10_keepalive': 1.0 Keepalive; 'req_sz_1k': Req less than equal to 1K; 'req_sz_2k': Req less than equal to 2K; **Type:** string **Supported Values:** all, num, curr_proxy, total_proxy, req, req_succ, noproxy, client_rst, server_rst, notuple, parsereq_fail, svrsel_fail, fwdreq_fail, fwdreq_fail_buff, fwdreq_fail_rport, fwdreq_fail_route, fwdreq_fail_persist, fwdreq_fail_server, fwdreq_fail_tuple, fwdreqdata_fail, req_retran, req_ofo, server_resel, svr_prem_close, new_svrconn, snat_fail, tcpoutrst, full_proxy, full_proxy_post, full_proxy_pipeline, full_proxy_fpga_err, req_over_limit, req_rate_over_limit, l4_switching, cookie_switching, aflex_switching, http_policy_switching, url_switching, host_switching, lb_switching, l4_switching_ok, cookie_switching_ok, aflex_switching_ok, http_policy_switching_ok, url_switching_ok, host_switching_ok, lb_switching_ok, l4_switching_enqueue, cookie_switching_enqueue, aflex_switching_enqueue, http_policy_switching_enqueue, url_switching_enqueue, host_switching_enqueue, lb_switching_enqueue, retry_503, aflex_retry, aflex_lb_reselect, aflex_lb_reselect_ok, client_rst_request, client_rst_connecting, client_rst_connected, client_rst_response, server_rst_request, server_rst_connecting, server_rst_connected, server_rst_response, invalid_header, too_many_headers, line_too_long, header_name_too_long, wrong_resp_header, header_insert, header_delete, insert_client_ip, negative_req_remain, negative_resp_remain, large_cookie, large_cookie_header, huge_cookie, huge_cookie_header, parse_cookie_fail, parse_setcookie_fail, asm_cookie_fail, asm_cookie_header_fail, asm_setcookie_fail, asm_setcookie_header_fail, client_req_unexp_flag, connecting_fin, connecting_fin_retrans, connecting_fin_ofo, connecting_rst, connecting_rst_retrans, connecting_rst_ofo, connecting_ack, pkts_ofo, pkts_retrans, pkts_retrans_ack_finwait, pkts_retrans_fin, pkts_retrans_rst, pkts_retrans_push, stale_sess, server_resel_failed, compression_before, compression_after, response_1xx, response_100, response_101, response_102, response_2xx, response_200, response_201, response_202, response_203, response_204, response_205, response_206, response_207, response_3xx, response_300, response_301, response_302, response_303, response_304, response_305, response_306, response_307, response_4xx, response_400, response_401, response_402, response_403, response_404, response_405, response_406, response_407, response_408, response_409, response_410, response_411, response_412, response_413, response_414, response_415, response_416, response_417, response_418, response_422, response_423, response_424, response_425, response_426, response_449, response_450, response_5xx, response_500, response_501, response_502, response_503, response_504, response_505, response_506, response_507, response_508, response_509, response_510, response_6xx, response_unknown, req_http10, req_http11, response_http10, response_http11, req_get, req_head, req_put, req_post, req_trace, req_options, req_connect, req_delete, req_unknown, req_content_len, rsp_content_len, rsp_chunk, req_chunk, compress_rsp, compress_del_accept_enc, compress_resp_already_compressed, compress_content_type_excluded, compress_no_content_type, compress_resp_lt_min, compress_resp_no_cl_or_ce, compress_ratio_too_high, cache_rsp, close_on_ddos, req_http10_keepalive, req_sz_1k, req_sz_2k, req_sz_4k **counters2** **Description** 'req_sz_4k': Req less than equal to 4K; 'req_sz_8k': Req less than equal to 8K; 'req_sz_16k': Req less than equal to 16K; 'req_sz_32k': Req less than equal to 32K; 'req_sz_64k': Req less than equal to 64K; 'req_sz_256k': Req less than equal to 256K; 'req_sz_gt_256k': Req greater than 256K; 'rsp_sz_1k': Resp less than equal to 1K; 'rsp_sz_2k': Resp less than equal to 2K; 'rsp_sz_4k': Resp less than equal to 4K; 'rsp_sz_8k': Resp less than equal to 8K; 'rsp_sz_16k': Resp less than equal to 16K; 'rsp_sz_32k': Resp less than equal to 32K; 'rsp_sz_64k': Resp less than equal to 64K; 'rsp_sz_256k': Resp less than equal to 256K; 'rsp_sz_gt_256k': Resp greater than 256K; 'chunk_sz_512': Chunk less than equal to 512; 'chunk_sz_1k': Chunk less than equal to 1K; 'chunk_sz_2k': Chunk less than equal to 2K; 'chunk_sz_4k': Chunk less than equal to 4K; 'chunk_sz_gt_4k': Chunk greater than 4K; 'pconn_connecting': pconn connecting; 'pconn_connected': pconn connected; 'pconn_connecting_failed': pconn conn failed; 'chunk_bad': Bad Chunk; 'req_10u': Rsp time less than 10u; 'req_20u': Rsp time less than 20u; 'req_50u': Rsp time less than 50u; 'req_100u': Rsp time less than 100u; 'req_200u': Rsp time less than 200u; 'req_500u': Rsp time less than 500u; 'req_1m': Rsp time less than 1m; 'req_2m': Rsp time less than 2m; 'req_5m': Rsp time less than 5m; 'req_10m': Rsp time less than 10m; 'req_20m': Rsp time less than 20m; 'req_50m': Rsp time less than 50m; 'req_100m': Rsp time less than 100m; 'req_200m': Rsp time less than 200m; 'req_500m': Rsp time less than 500m; 'req_1s': Rsp time less than 1s; 'req_2s': Rsp time less than 2s; 'req_5s': Rsp time less than 5s; 'req_over_5s': Rsp time greater than equal to 5s; 'insert_client_port': Insert client Port; 'req_track': Method TRACK; 'connect_req': Total HTTP CONNECT requests; 'req_enter_ssli': Total HTTP requests enter SSLi; 'non_http_bypass': Non-HTTP bypass; 'decompression_before': Tot data before decompress; 'decompression_after': Tot data after decompress; 'req_http2': Request 2.0; 'response_http2': Resp 2.0; 'req_timeout_retry': Retry on Req Timeout; 'req_timeout_close': Close on Req Timeout; 'doh_req': DoH Requests; 'doh_req_get': DoH GET Requests; 'doh_req_post': DoH POST Requests; 'doh_non_doh_req': DoH non DoH Requests; 'doh_non_doh_req_get': DoH non DoH GET Requests; 'doh_non_doh_req_post': DoH non DoH POST Requests; 'doh_resp': DoH Responses; 'doh_tc_resp': DoH TC Responses; 'doh_udp_dns_req': DoH UDP DNS Requests; 'doh_udp_dns_resp': DoH UDP DNS Responses; 'doh_tcp_dns_req': DoH TCP DNS Requests; 'doh_tcp_dns_resp': DoH TCP DNS Responses; 'doh_req_send_failed': DoH Request Send Failed; 'doh_resp_send_failed': DoH Response Send Failed; 'doh_malloc_fail': DoH Memory alloc failed; 'doh_req_udp_retry': DoH UDP Retry; 'doh_req_udp_retry_fail': DoH UDP Retry failed; 'doh_req_tcp_retry': DoH TCP Retry; 'doh_req_tcp_retry_fail': DoH TCP Retry failed; 'doh_snat_failed': DoH Source NAT failed; 'doh_path_not_found': DoH URI Path not found; 'doh_get_dns_arg_failed': DoH GET dns arg not found in uri; 'doh_get_base64_decode_failed': DoH GET base64url decode failed; 'doh_post_content_type_mismatch': DoH POST content-type not found; 'doh_post_payload_not_found': DoH POST payload not found; 'doh_post_payload_extract_failed': DoH POST payload extract failed; 'doh_non_doh_method': DoH Non DoH HTTP request method rcvd; 'doh_tcp_send_failed': DoH serv TCP DNS send failed; 'doh_udp_send_failed': DoH serv UDP DNS send failed; 'doh_query_time_out': DoH serv Query timed out; 'doh_dns_query_type_a': DoH Query type A; 'doh_dns_query_type_aaaa': DoH Query type AAAA; 'doh_dns_query_type_ns': DoH Query type NS; 'doh_dns_query_type_cname': DoH Query type CNAME; 'doh_dns_query_type_any': DoH Query type ANY; 'doh_dns_query_type_srv': DoH Query type SRV; 'doh_dns_query_type_mx': DoH Query type MX; 'doh_dns_query_type_soa': DoH Query type SOA; 'doh_dns_query_type_others': DoH Query type Others; 'doh_resp_setup_failed': DoH Response setup failed; 'doh_resp_header_alloc_failed': DoH Resp hdr alloc failed; 'doh_resp_que_failed': DoH Resp queue failed; 'doh_resp_udp_frags': DoH UDP Frags Rcvd; 'doh_resp_tcp_frags': DoH TCP Frags Rcvd; 'doh_serv_sel_failed': DoH Server Select Failed; 'doh_retry_w_tcp': DoH Retry with TCP SG; 'doh_get_uri_too_long': DoH GET URI too long; 'doh_post_payload_too_large': DoH POST Payload too large; 'doh_dns_malformed_query': DoH DNS Malformed Query; 'doh_dns_resp_rcode_err_format': DoH DNS Response rcode ERR_FORMAT; 'doh_dns_resp_rcode_err_server': DoH DNS Response rcode ERR_SERVER; 'doh_dns_resp_rcode_err_name': DoH DNS Response rcode ERR_NAME; 'doh_dns_resp_rcode_err_type': DoH DNS Response rcode ERR_TYPE; 'doh_dns_resp_rcode_refuse': DoH DNS Response rcode REFUSE; 'doh_dns_resp_rcode_yxdomain': DoH DNS Response rcode YXDOMAIN; 'doh_dns_resp_rcode_yxrrset': DoH DNS Response rcode YXRRSET; 'doh_dns_resp_rcode_nxrrset': DoH DNS Response rcode NXRRSET; 'doh_dns_resp_rcode_notauth': DoH DNS Response rcode NOTAUTH; 'doh_dns_resp_rcode_notzone': DoH DNS Response rcode NOTZONE; 'doh_dns_resp_rcode_other': DoH DNS Response rcode OTHER; 'compression_before_br': Tot data before brotli compress; 'compression_after_br': Tot data after brotli compress; 'compression_before_total': Tot data before compress; 'compression_after_total': Tot data after compress; 'decompression_before_br': Tot data before brotli decompress; 'decompression_after_br': Tot data after brotli decompress; 'decompression_before_total': Tot data before decompress; 'decompression_after_total': Tot data after decompress; 'compress_rsp_br': Compress req with brotli; 'compress_rsp_total': Compress req; 'h2up_content_length_alias': HTTP2 content length alias; 'malformed_h2up_header_value': Malformed HTTP2 header value; 'malformed_h2up_scheme_value': Malformed HTTP2 scheme value; 'h2up_with_transfer_encoding': HTTP2 with transfer-encoding header; 'multiple_content_length': Multiple content-length headers; 'multiple_transfer_encoding': Multiple transfer-encoding headers; 'transfer_encoding_and_content_length': Transfer-encoding header with Content-Length header; 'get_and_payload': GET method with content-length header or transfer-encoding header; 'h2up_with_host_and_auth': HTTP2 with host header and authority header; 'req_http3': Request 3.0; 'response_http3': Resp 3.0; 'header_filter_rule_hit': Hit header filter rule; 'current_stream': Current Stream; 'stream_create': Stream Created; 'stream_free': Stream Free; 'end_stream_rcvd': End Stream Received; 'end_stream_sent': End Stream Sent; 'http1_client_idle_timeout': HTTP1 client idle timeout; 'http2_client_idle_timeout': HTTP2 client idle timeout; **Type:** string **Supported Values:** req_sz_8k, req_sz_16k, req_sz_32k, req_sz_64k, req_sz_256k, req_sz_gt_256k, rsp_sz_1k, rsp_sz_2k, rsp_sz_4k, rsp_sz_8k, rsp_sz_16k, rsp_sz_32k, rsp_sz_64k, rsp_sz_256k, rsp_sz_gt_256k, chunk_sz_512, chunk_sz_1k, chunk_sz_2k, chunk_sz_4k, chunk_sz_gt_4k, pconn_connecting, pconn_connected, pconn_connecting_failed, chunk_bad, req_10u, req_20u, req_50u, req_100u, req_200u, req_500u, req_1m, req_2m, req_5m, req_10m, req_20m, req_50m, req_100m, req_200m, req_500m, req_1s, req_2s, req_5s, req_over_5s, insert_client_port, req_track, connect_req, req_enter_ssli, non_http_bypass, decompression_before, decompression_after, req_http2, response_http2, req_timeout_retry, req_timeout_close, doh_req, doh_req_get, doh_req_post, doh_non_doh_req, doh_non_doh_req_get, doh_non_doh_req_post, doh_resp, doh_tc_resp, doh_udp_dns_req, doh_udp_dns_resp, doh_tcp_dns_req, doh_tcp_dns_resp, doh_req_send_failed, doh_resp_send_failed, doh_malloc_fail, doh_req_udp_retry, doh_req_udp_retry_fail, doh_req_tcp_retry, doh_req_tcp_retry_fail, doh_snat_failed, doh_path_not_found, doh_get_dns_arg_failed, doh_get_base64_decode_failed, doh_post_content_type_mismatch, doh_post_payload_not_found, doh_post_payload_extract_failed, doh_non_doh_method, doh_tcp_send_failed, doh_udp_send_failed, doh_query_time_out, doh_dns_query_type_a, doh_dns_query_type_aaaa, doh_dns_query_type_ns, doh_dns_query_type_cname, doh_dns_query_type_any, doh_dns_query_type_srv, doh_dns_query_type_mx, doh_dns_query_type_soa, doh_dns_query_type_others, doh_resp_setup_failed, doh_resp_header_alloc_failed, doh_resp_que_failed, doh_resp_udp_frags, doh_resp_tcp_frags, doh_serv_sel_failed, doh_retry_w_tcp, doh_get_uri_too_long, doh_post_payload_too_large, doh_dns_malformed_query, doh_dns_resp_rcode_err_format, doh_dns_resp_rcode_err_server, doh_dns_resp_rcode_err_name, doh_dns_resp_rcode_err_type, doh_dns_resp_rcode_refuse, doh_dns_resp_rcode_yxdomain, doh_dns_resp_rcode_yxrrset, doh_dns_resp_rcode_nxrrset, doh_dns_resp_rcode_notauth, doh_dns_resp_rcode_notzone, doh_dns_resp_rcode_other, compression_before_br, compression_after_br, compression_before_total, compression_after_total, decompression_before_br, decompression_after_br, decompression_before_total, decompression_after_total, compress_rsp_br, compress_rsp_total, h2up_content_length_alias, malformed_h2up_header_value, malformed_h2up_scheme_value, h2up_with_transfer_encoding, multiple_content_length, multiple_transfer_encoding, transfer_encoding_and_content_length, get_and_payload, h2up_with_host_and_auth, req_http3, response_http3, header_filter_rule_hit, http1_client_idle_timeout, http2_client_idle_timeout, http_disallowed_methods, http_allowed_methods, req_http11_new_proxy .. _3076_aflow: aflow ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_aflow_sampling-enable: aflow_sampling-enable ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'pause_conn': Pause connection; 'pause_conn_fail': Pause connection fail; 'resume_conn': Resume connection; 'event_resume_conn': Resume conn by event; 'timer_resume_conn': Resume conn by timer; 'try_to_resume_conn': Resume conn by trying; 'retry_resume_conn': Resume conn by retry; 'error_resume_conn': Resume conn by error; 'open_new_server_conn': Open new server conn; 'reuse_server_idle_conn': Reuse idle server conn; 'inc_aflow_limit': Inc aFlow limit; **Type:** string **Supported Values:** all, pause_conn, pause_conn_fail, resume_conn, event_resume_conn, timer_resume_conn, try_to_resume_conn, retry_resume_conn, error_resume_conn, open_new_server_conn, reuse_server_idle_conn, inc_aflow_limit .. _3076_icap: icap ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_icap_sampling-enable: icap_sampling-enable ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'reqmod_request': Reqmod Request Stats; 'respmod_request': Respmod Request Stats; 'reqmod_request_after_100': Reqmod Request Sent After 100 Cont Stats; 'respmod_request_after_100': Respmod Request Sent After 100 Cont Stats; 'reqmod_response': Reqmod Response Stats; 'respmod_response': Respmod Response Stats; 'reqmod_response_after_100': Reqmod Response After 100 Cont Stats; 'respmod_response_after_100': Respmod Response After 100 Cont Stats; 'chunk_no_allow_204': Chunk so no Allow 204 Stats; 'len_exceed_no_allow_204': Length Exceeded so no Allow 204 Stats; 'result_continue': Result Continue Stats; 'result_icap_response': Result ICAP Response Stats; 'result_100_continue': Result 100 Continue Stats; 'result_other': Result Other Stats; 'status_2xx': Status 2xx Stats; 'status_200': Status 200 Stats; 'status_201': Status 201 Stats; 'status_202': Status 202 Stats; 'status_203': Status 203 Stats; 'status_204': Status 204 Stats; 'status_205': Status 205 Stats; 'status_206': Status 206 Stats; 'status_207': Status 207 Stats; 'status_1xx': Status 1xx Stats; 'status_100': Status 100 Stats; 'status_101': Status 101 Stats; 'status_102': Status 102 Stats; 'status_3xx': Status 3xx Stats; 'status_300': Status 300 Stats; 'status_301': Status 301 Stats; 'status_302': Status 302 Stats; 'status_303': Status 303 Stats; 'status_304': Status 304 Stats; 'status_305': Status 305 Stats; 'status_306': Status 306 Stats; 'status_307': Status 307 Stats; 'status_4xx': Status 4xx Stats; 'status_400': Status 400 Stats; 'status_401': Status 401 Stats; 'status_402': Status 402 Stats; 'status_403': Status 403 Stats; 'status_404': Status 404 Stats; 'status_405': Status 405 Stats; 'status_406': Status 406 Stats; 'status_407': Status 407 Stats; 'status_408': Status 408 Stats; 'status_409': Status 409 Stats; 'status_410': Status 410 Stats; 'status_411': Status 411 Stats; 'status_412': Status 412 Stats; 'status_413': Status 413 Stats; 'status_414': Status 414 Stats; 'status_415': Status 415 Stats; 'status_416': Status 416 Stats; 'status_417': Status 417 Stats; 'status_418': Status 418 Stats; 'status_419': Status 419 Stats; 'status_420': Status 420 Stats; 'status_422': Status 422 Stats; 'status_423': Status 423 Stats; 'status_424': Status 424 Stats; 'status_425': Status 425 Stats; 'status_426': Status 426 Stats; 'status_449': Status 449 Stats; 'status_450': Status 450 Stats; 'status_5xx': Status 5xx Stats; 'status_500': Status 500 Stats; 'status_501': Status 501 Stats; 'status_502': Status 502 Stats; 'status_503': Status 503 Stats; 'status_504': Status 504 Stats; 'status_505': Status 505 Stats; 'status_506': Status 506 Stats; 'status_507': Status 507 Stats; 'status_508': Status 508 Stats; 'status_509': Status 509 Stats; 'status_510': Status 510 Stats; 'status_6xx': Status 6xx Stats; 'status_unknown': Status Unknown Stats; 'send_option_req': Send Option Req Stats; 'app_serv_conn_no_pcb_err': App Server Conn no ES PCB Err Stats; 'app_serv_conn_err': App Server Conn Err Stats; 'chunk1_hdr_err': Chunk Hdr Err1 Stats; 'chunk2_hdr_err': Chunk Hdr Err2 Stats; 'chunk_bad_trail_err': Chunk Bad Trail Err Stats; 'no_payload_next_buff_err': No Payload In Next Buff Err Stats; 'no_payload_buff_err': No Payload Buff Err Stats; 'resp_hdr_incomplete_err': Resp Hdr Incomplete Err Stats; 'serv_sel_fail_err': Server Select Fail Err Stats; 'start_icap_conn_fail_err': Start ICAP conn fail Stats; 'prep_req_fail_err': Prepare ICAP req fail Err Stats; 'icap_ver_err': ICAP Ver Err Stats; 'icap_line_err': ICAP Line Err Stats; 'encap_hdr_incomplete_err': Encap HDR Incomplete Err Stats; 'no_icap_resp_err': No ICAP Resp Err Stats; 'resp_line_read_err': Resp Line Read Err Stats; 'resp_line_parse_err': Resp Line Parse Err Stats; 'resp_hdr_err': Resp Hdr Err Stats; 'req_hdr_incomplete_err': Req Hdr Incomplete Err Stats; 'no_status_code_err': No Status Code Err Stats; 'http_resp_line_read_err': HTTP Response Line Read Err Stats; 'http_resp_line_parse_err': HTTP Response Line Parse Err Stats; 'http_resp_hdr_err': HTTP Resp Hdr Err Stats; 'recv_option_resp': Send Option Req Stats; **Type:** string **Supported Values:** all, reqmod_request, respmod_request, reqmod_request_after_100, respmod_request_after_100, reqmod_response, respmod_response, reqmod_response_after_100, respmod_response_after_100, chunk_no_allow_204, len_exceed_no_allow_204, result_continue, result_icap_response, result_100_continue, result_other, status_2xx, status_200, status_201, status_202, status_203, status_204, status_205, status_206, status_207, status_1xx, status_100, status_101, status_102, status_3xx, status_300, status_301, status_302, status_303, status_304, status_305, status_306, status_307, status_4xx, status_400, status_401, status_402, status_403, status_404, status_405, status_406, status_407, status_408, status_409, status_410, status_411, status_412, status_413, status_414, status_415, status_416, status_417, status_418, status_419, status_420, status_422, status_423, status_424, status_425, status_426, status_449, status_450, status_5xx, status_500, status_501, status_502, status_503, status_504, status_505, status_506, status_507, status_508, status_509, status_510, status_6xx, status_unknown, send_option_req, app_serv_conn_no_pcb_err, app_serv_conn_err, chunk1_hdr_err, chunk2_hdr_err, chunk_bad_trail_err, no_payload_next_buff_err, no_payload_buff_err, resp_hdr_incomplete_err, serv_sel_fail_err, start_icap_conn_fail_err, prep_req_fail_err, icap_ver_err, icap_line_err, encap_hdr_incomplete_err, no_icap_resp_err, resp_line_read_err, resp_line_parse_err, resp_hdr_err, req_hdr_incomplete_err, no_status_code_err, http_resp_line_read_err, http_resp_line_parse_err, http_resp_hdr_err, recv_option_resp, http_connect_reqmod_request .. _3076_ssl: ssl ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sni-automap-attributes** **Description:** sni-automap-attributes is a **JSON Block**. Please see below for :ref:`3076_ssl_sni-automap-attributes` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl/sni-automap-attributes ` .. _3076_ssl_sni-automap-attributes: ssl_sni-automap-attributes ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sni-delete-factor** **Description** Contexts are deleted in groups of this value. Default is 50 **Type:** number **Range:** 1-10000 **Default:** 50 **sni-lower-limit** **Description** Lower limit for free SNI contexts count. Default is 500 **Type:** number **Range:** 1-65536 **Default:** 500 **sni-upper-limit** **Description** Upper limit for free SNI contexts count. Default is 2000 **Type:** number **Range:** 1-65536 **Default:** 2000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ftp-data: ftp-data ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ftp-data_sampling-enable: ftp-data_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'sessions_num': Total Data Sessions; 'port_out_of_range': Drop Data Port out of range; **Type:** string **Supported Values:** all, sessions_num, port_out_of_range .. _3076_sport-rate-limit: sport-rate-limit ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_sport-rate-limit_sampling-enable: sport-rate-limit_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'alloc_sport': Alloc'd src port entry; 'alloc_sportip': Alloc'd src port-ip entry; 'freed_sport': Freed src port entry; 'freed_sportip': Freed src port-ip entry; 'total_drop': Total rate exceed drop; 'total_reset': Total rate exceed reset; 'total_log': Total log sent; **Type:** string **Supported Values:** all, alloc_sport, alloc_sportip, freed_sport, freed_sportip, total_drop, total_reset, total_log .. _3076_ssl-counters: ssl-counters ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-forward-proxy: ssl-forward-proxy ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-forward-proxy_sampling-enable: ssl-forward-proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'cert_create': Certificates created; 'cert_expr': Certificates expired; 'cert_hit': Certificate cache hits; 'cert_miss': Certificate cache miss; 'conn_bypass': Connections bypassed; 'conn_inspect': Connections inspected; 'bypass-failsafe-ssl-sessions': Bypass Failsafe SSL sessions; 'bypass-sni-sessions': Bypass SNI sessions; 'bypass-client-auth-sessions': Bypass Client Auth sessions; 'failed-in-ssl-handshakes': Failed in SSL handshakes; 'failed-in-crypto-operations': Failed in crypto operations; 'failed-in-tcp': Failed in TCP; 'failed-in-certificate-verification': Failed in Certificate verification; 'failed-in-certificate-signing': Failed in Certificate signing; 'invalid-ocsp-stapling-response': Invalid OCSP Stapling Response; 'revoked-ocsp-response': Revoked OCSP Response; 'unsupported-ssl-version': Unsupported SSL version; 'certificates-in-cache': Certificates in cache; 'connections-failed': Connections failed; 'aflex-bypass': Bypass triggered by aFleX; 'bypass-cert-subject-sessions': Bypass Cert Subject sessions; 'bypass-cert-issuer-sessions': Bypass Cert issuer sessions; 'bypass-cert-san-sessions': Bypass Cert SAN sessions; 'bypass-no-sni-sessions': Bypass NO SNI sessions; 'reset-no-sni-sessions': Reset No SNI sessions; 'bypass-esni-sessions': Bypass ESNI sessions; 'drop-esni-sessions': Drop ESNI sessions; 'bypass-username-sessions': Bypass Username sessions; 'bypass-ad-group-sessions': Bypass AD-group sessions; 'tot_conn_in_buff': Total buffered async connections; 'curr_conn_in_buff': Current buffered async connections; 'async_conn_timeout': SSLi Async connections failures due to timeout; 'async_conn_limit_drop': SSLi Async connections failures due to limit; 'cert_in_cache': Certificates in cache used by HC SSLi App; 'bypass-client-ip-sessions': Bypass Client IP sessions; 'bypass-server-ip-sessions': Bypass Server IP sessions; **Type:** string **Supported Values:** all, cert_create, cert_expr, cert_hit, cert_miss, conn_bypass, conn_inspect, bypass-failsafe-ssl-sessions, bypass-sni-sessions, bypass-client-auth-sessions, failed-in-ssl-handshakes, failed-in-crypto-operations, failed-in-tcp, failed-in-certificate-verification, failed-in-certificate-signing, invalid-ocsp-stapling-response, revoked-ocsp-response, unsupported-ssl-version, certificates-in-cache, connections-failed, aflex-bypass, bypass-cert-subject-sessions, bypass-cert-issuer-sessions, bypass-cert-san-sessions, bypass-no-sni-sessions, reset-no-sni-sessions, bypass-esni-sessions, drop-esni-sessions, bypass-username-sessions, bypass-ad-group-sessions, tot_conn_in_buff, curr_conn_in_buff, async_conn_timeout, async_conn_limit_drop, cert_in_cache, bypass-client-ip-sessions, bypass-server-ip-sessions .. _3076_server-group-list: server-group-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **member-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/server-group/{name}/member/{name} ` **name** **Description** server-group name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **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 .. _3076_server-group-list_member-list: server-group-list_member-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name** **Description** Member name **Type:** string **Format:** comp-string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/server ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_server-group-list_sampling-enable: server-group-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; **Type:** string **Supported Values:** all .. _3076_health-down-reason: health-down-reason ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_l4: l4 ^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_l4_sampling-enable: l4_sampling-enable ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'intcp': TCP received; 'synreceived': TCP SYN received; 'tcp_fwd_last_ack': L4 rcv fwd last ACK; 'tcp_rev_last_ack': L4 rcv rev last ACK; 'tcp_rev_fin': L4 rcv rev FIN; 'tcp_fwd_fin': L4 rcv fwd FIN; 'tcp_fwd_ackfin': L4 rcv fwd FIN|ACK; 'inudp': UDP received; 'syncookiessent': TCP SYN cookie snt; 'syncookiessent_ts': TCP SYN cookie snt ts; 'syncookiessentfailed': TCP SYN cookie snt fail; 'outrst': TCP out RST; 'outrst_nosyn': TCP out RST no SYN; 'outrst_broker': TCP out RST L4 proxy; 'outrst_ack_attack': TCP out RST ACK attack; 'outrst_aflex': TCP out RST aFleX; 'outrst_stale_sess': TCP out RST stale sess; 'syn_stale_sess': SYN stale sess drop; 'outrst_tcpproxy': TCP out RST TCP proxy; 'svrselfail': Server sel failure; 'noroute': IP out noroute; 'snat_fail': Source NAT failure; 'snat_no_fwd_route': Source NAT no fwd route; 'snat_no_rev_route': Source NAT no rev route; 'snat_icmp_error_process': Source NAT ICMP Process; 'snat_icmp_no_match': Source NAT ICMP No Match; 'smart_nat_id_mismatch': Auto NAT id mismatch; 'syncookiescheckfailed': TCP SYN cookie failed; 'novport_drop': NAT no session drops; 'no_vport_drop': vport not matching drops; 'nosyn_drop': No SYN pkt drops; 'nosyn_drop_fin': No SYN pkt drops - FIN; 'nosyn_drop_rst': No SYN pkt drops - RST; 'nosyn_drop_ack': No SYN pkt drops - ACK; 'connlimit_drop': Conn Limit drops; 'connlimit_reset': Conn Limit resets; 'conn_rate_limit_drop': Conn rate limit drops; 'conn_rate_limit_reset': Conn rate limit resets; 'proxy_nosock_drop': Proxy no sock drops; 'drop_aflex': aFleX drops; 'sess_aged_out': Session aged out; 'tcp_sess_aged_out': TCP Session aged out; 'udp_sess_aged_out': UDP Session aged out; 'other_sess_aged_out': Other Session aged out; 'tcp_no_slb': TCP no SLB; 'udp_no_slb': UDP no SLB; 'throttle_syn': SYN Throttle; 'drop_gslb': Drop GSLB; 'inband_hm_retry': Inband HM retry; 'inband_hm_reassign': Inband HM reassign; 'auto_reassign': Auto-reselect server; 'fast_aging_set': Fast aging set; 'fast_aging_reset': Fast aging reset; 'dns_policy_drop': DNS Policy Drop; 'tcp_invalid_drop': TCP invalid drop; 'anomaly_out_seq': Anomaly out of sequence; 'anomaly_zero_win': Anomaly zero window; 'anomaly_bad_content': Anomaly bad content; 'anomaly_pbslb_drop': Anomaly pbslb drop; 'no_resourse_drop': No resource drop; 'reset_unknown_conn': Reset unknown conn; 'reset_l7_on_failover': RST L7 on failover; 'ignore_msl': ignore msl; 'l2_dsr': L2 DSR received; 'l3_dsr': L3 DSR received; 'port_preserve_attempt': NAT Port Preserve Try; 'port_preserve_succ': NAT Port Preserve Succ; 'tcpsyndata_drop': TCP SYN With Data Drop; 'tcpotherflags_drop': TCP SYN Other Flags Drop; 'bw_rate_limit_exceed': BW-Limit Exceed drop; 'bw_watermark_drop': BW-Watermark drop; 'l4_cps_exceed': L4 CPS exceed drop; 'nat_cps_exceed': NAT CPS exceed drop; 'l7_cps_exceed': L7 CPS exceed drop; 'ssl_cps_exceed': SSL CPS exceed drop; 'ssl_tpt_exceed': SSL TPT exceed drop; 'ssl_watermark_drop': SSL TPT-Watermark drop; 'concurrent_conn_exceed': L3V Conn Limit Drop; 'svr_syn_handshake_fail': L4 server handshake fail; 'stateless_conn_timeout': L4 stateless Conn TO; 'tcp_ax_rexmit_syn': L4 AX re-xmit SYN; 'tcp_syn_rcv_ack': L4 rcv ACK on SYN; 'tcp_syn_rcv_rst': L4 rcv RST on SYN; 'tcp_sess_noest_aged_out': TCP no-Est Sess aged out; 'tcp_sess_noest_csyn_rcv_aged_out': no-Est CSYN rcv aged out; 'tcp_sess_noest_ssyn_xmit_aged_out': no-Est SSYN snt aged out; 'tcp_rexmit_syn': L4 rcv rexmit SYN; 'tcp_rexmit_syn_delq': L4 rcv rexmit SYN (delq); 'tcp_rexmit_synack': L4 rcv rexmit SYN|ACK; 'tcp_rexmit_synack_delq': L4 rcv rexmit SYN|ACK DQ; 'tcp_fwd_fin_dup': L4 rcv fwd FIN dup; 'tcp_rev_fin_dup': L4 rcv rev FIN dup; 'tcp_rev_ackfin': L4 rcv rev FIN|ACK; 'tcp_fwd_rst': L4 rcv fwd RST; 'tcp_rev_rst': L4 rcv rev RST; 'udp_req_oneplus_no_resp': L4 UDP reqs no rsp; 'udp_req_one_oneplus_resp': L4 UDP req rsps; 'udp_req_resp_notmatch': L4 UDP req/rsp not match; 'udp_req_more_resp': L4 UDP req greater than rsps; 'udp_resp_more_req': L4 UDP rsps greater than reqs; 'udp_req_oneplus': L4 UDP reqs; 'udp_resp_oneplus': L4 UDP rsps; 'out_seq_ack_drop': Out of sequence ACK drop; 'tcp_est': L4 TCP Established; 'synattack': L4 SYN attack; 'syn_rate': TCP SYN rate per sec; 'syncookie_buff_drop': TCP SYN cookie buff drop; 'syncookie_buff_queue': TCP SYN cookie buff queue; 'skip_insert_client_ip': Skip Insert-client-ip; 'synreceived_hw': TCP SYN (HW SYN cookie); 'dns_id_switch': DNS query id switch; 'server_down_del': Server Down Del switch; 'dnssec_switch': DNSSEC SG switch; 'rate_drop_reset_unkn': Rate Drop reset; 'tcp_connections_closed': TCP Connections Closed; 'gtp_c_invalid_port': Invalid Packet Received on GTP VIP; 'gtp_c_invalid_header': Invalid Header Received on GTP VIP; 'gtp_c_invalid_message': Non Create Session/PDP Context Request/Response Received on GTP VIP; 'reselect_svrselfail': Server reselect failure; 'snat_port_overload_fail': Snat port overload fail; 'snat_force_preserve_alloc': Snat port preserve allocated; 'snat_force_preserve_free': Snat port preserve freed; 'proxy_header_insert': PROXY protocol header inserted; 'proxy_header_rexmit': PROXY protocol header retransmitted; 'proxy_prot_error': PROXY protocol error; 'proxy_prot_drop': PROXY protocol drop; 'slb_gtp_proxy_pkt_rcv_rr': SLB GTP proxy packet received on RR; 'slb_gtp_proxy_smp_match': SLB GTP proxy helper session found; 'slb_gtp_proxy_smp_no_match': SLB GTP proxy helper session not found; 'slb_gtp_proxy_c_process_local_rr': SLB GTP proxy messageprocessed locally on RR; 'slb_gtp_proxy_smp_creation_failed': SLB GTP proxy helper session creation failed; 'slb_gtp_proxy_smp_created': SLB GTP proxy helper session created; 'slb_gtp_proxy_smp_free_not_found': SLB GTP proxy session helper not found during cleanup; 'slb_gtp_proxy_smp_freed': SLB GTP proxy session helper freed; 'slb_gtp_proxy_retx_requests': SLB GTP proxy retx requests; 'pbslb_entry_limit_exceed': pbslb entry limit Exceed; **Type:** string **Supported Values:** all, intcp, synreceived, tcp_fwd_last_ack, tcp_rev_last_ack, tcp_rev_fin, tcp_fwd_fin, tcp_fwd_ackfin, inudp, syncookiessent, syncookiessent_ts, syncookiessentfailed, outrst, outrst_nosyn, outrst_broker, outrst_ack_attack, outrst_aflex, outrst_stale_sess, syn_stale_sess, outrst_tcpproxy, svrselfail, noroute, snat_fail, snat_no_fwd_route, snat_no_rev_route, snat_icmp_error_process, snat_icmp_no_match, smart_nat_id_mismatch, syncookiescheckfailed, novport_drop, no_vport_drop, nosyn_drop, nosyn_drop_fin, nosyn_drop_rst, nosyn_drop_ack, connlimit_drop, connlimit_reset, conn_rate_limit_drop, conn_rate_limit_reset, proxy_nosock_drop, drop_aflex, sess_aged_out, tcp_sess_aged_out, udp_sess_aged_out, other_sess_aged_out, tcp_no_slb, udp_no_slb, throttle_syn, drop_gslb, inband_hm_retry, inband_hm_reassign, auto_reassign, fast_aging_set, fast_aging_reset, dns_policy_drop, tcp_invalid_drop, anomaly_out_seq, anomaly_zero_win, anomaly_bad_content, anomaly_pbslb_drop, no_resourse_drop, reset_unknown_conn, reset_l7_on_failover, ignore_msl, l2_dsr, l3_dsr, port_preserve_attempt, port_preserve_succ, tcpsyndata_drop, tcpotherflags_drop, bw_rate_limit_exceed, bw_watermark_drop, l4_cps_exceed, nat_cps_exceed, l7_cps_exceed, ssl_cps_exceed, ssl_tpt_exceed, ssl_watermark_drop, concurrent_conn_exceed, svr_syn_handshake_fail, stateless_conn_timeout, tcp_ax_rexmit_syn, tcp_syn_rcv_ack, tcp_syn_rcv_rst, tcp_sess_noest_aged_out, tcp_sess_noest_csyn_rcv_aged_out, tcp_sess_noest_ssyn_xmit_aged_out, tcp_rexmit_syn, tcp_rexmit_syn_delq, tcp_rexmit_synack, tcp_rexmit_synack_delq, tcp_fwd_fin_dup, tcp_rev_fin_dup, tcp_rev_ackfin, tcp_fwd_rst, tcp_rev_rst, udp_req_oneplus_no_resp, udp_req_one_oneplus_resp, udp_req_resp_notmatch, udp_req_more_resp, udp_resp_more_req, udp_req_oneplus, udp_resp_oneplus, out_seq_ack_drop, tcp_est, synattack, syn_rate, syncookie_buff_drop, syncookie_buff_queue, skip_insert_client_ip, synreceived_hw, dns_id_switch, server_down_del, dnssec_switch, rate_drop_reset_unkn, tcp_connections_closed, gtp_c_invalid_port, gtp_c_invalid_header, gtp_c_invalid_message, reselect_svrselfail, snat_port_overload_fail, snat_force_preserve_alloc, snat_force_preserve_free, proxy_header_insert, proxy_header_rexmit, proxy_prot_error, proxy_prot_drop, slb_gtp_proxy_pkt_rcv_rr, slb_gtp_proxy_smp_match, slb_gtp_proxy_smp_no_match, slb_gtp_proxy_c_process_local_rr, slb_gtp_proxy_smp_creation_failed, slb_gtp_proxy_smp_created, slb_gtp_proxy_smp_free_not_found, slb_gtp_proxy_smp_freed, slb_gtp_proxy_retx_requests, pbslb_entry_limit_exceed, fast_path_reroute, fast_path_l2_reroute .. _3076_common: common ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **N5-new** **Description** HW assisted N5 SSL module with TLS 1.3 and TLS 1.2 support using OpenSSL 1.1.1 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** N5-new,software, software-tls13, QAT, N5-old, and software-tls13-offload are mutually exclusive **N5-old** **Description** HW assisted N5 SSL module with TLS 1.2 support using OpenSSL 0.9.7 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** N5-old,software, software-tls13, QAT, N5-new, and software-tls13-offload are mutually exclusive **QAT** **Description** HW assisted QAT SSL module **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** QAT,software, software-tls13, N5-new, N5-old, and software-tls13-offload are mutually exclusive **aflex-table-entry-aging-interval** **Description** aFleX table entry aging interval in second **Type:** number **Range:** 1-3600 **Default:** 1 **aflex-table-entry-sync** **Description:** aflex-table-entry-sync is a **JSON Block**. Please see below for :ref:`3076_common_aflex-table-entry-sync` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/common/aflex-table-entry-sync ` **after-disable** **Description** Graceful shutdown after disable server/port and/or virtual server/port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allow-in-gateway-mode** **Description** Use source NAT gateway for L3 traffic for gateway mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **attack-resp-code** **Description** Custom response code **Type:** number **Range:** 400-599 **Default:** 410 **auto-nat-no-ip-refresh** **Description** 'enable': enable; 'disable': disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **auto-translate-port** **Description** Auto Translate Port range **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **buff-thresh** **Description** Set buffer threshold **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **buff-thresh-hw-buff** **Description** Set hardware buffer threshold **Type:** number **Range:** 1-2147483647 **buff-thresh-relieve-thresh** **Description** Relieve threshold **Type:** number **Range:** 0-2147483647 **buff-thresh-sys-buff-high** **Description** Set high water mark of system buffer **Type:** number **Range:** 0-2147483647 **buff-thresh-sys-buff-low** **Description** Set low water mark of system buffer **Type:** number **Range:** 0-2147483647 **cache-expire-time** **Description** Cache expiration time, default is 1 minute **Type:** number **Range:** 1-480 **Default:** 1 **cancel-stream-loop-limit** **Description** Set global cancel stream loop limit (cancel stream loop limit, default is 5) **Type:** number **Range:** 0-50 **Default:** 5 **cert-pinning** **Description:** cert-pinning is a **JSON Block**. Please see below for :ref:`3076_common_cert-pinning` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/common/cert-pinning ` **clientside-ip** **Description** Clientside IP address **Type:** string **Format:** ipv4-address **clientside-ipv6** **Description** Clientside IPv6 address **Type:** string **Format:** ipv6-address **compress-block-size** **Description** Set compression block size (Compression block size in bytes) **Type:** number **Range:** 6000-131008 **conn-rate-limit** **Description:** conn-rate-limit is a **JSON Block**. Please see below for :ref:`3076_common_conn-rate-limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/common/conn-rate-limit ` **custom-message** **Description** Block message **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **Mutual Exclusion:** custom-message and custom-page are mutually exclusive **custom-page** **Description** Specify the custom webpage name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** custom-page and custom-message are mutually exclusive **custom-signal-clist** **Description** Provide custom signal names **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **ddos-pkt-count-thresh** **Description** Set packet count threshold for DDOS, default is 100 **Type:** number **Range:** 1-256 **Default:** 100 **ddos-pkt-size-thresh** **Description** Set data packet size threshold for DDOS, default is 64 bytes **Type:** number **Range:** 1-256 **Default:** 64 **ddos-protection** **Description:** ddos-protection is a **JSON Block**. Please see below for :ref:`3076_common_ddos-protection` **Type:** Object **disable-adaptive-resource-check** **Description** Disable adaptive resource check based on buffer usage **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-persist-scoring** **Description** Disable Persist Scoring **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-port-masking** **Description** Disable masking of ports for CPU hashing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-server-auto-reselect** **Description** Disable auto reselection of server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-cache-age** **Description** Set DNS cache entry age, default is 300 seconds (1-1000000 seconds, default is 300 seconds) **Type:** number **Range:** 1-1000000 **Default:** 300 **dns-cache-age-min-threshold** **Description** Set DNS cache entry age minimum threshold, default is 0 seconds (1-1000000 seconds, default is 0 seconds) **Type:** number **Range:** 0-1000000 **Default:** 0 **dns-cache-aging-weight** **Description** Set DNS cache entry weight, default is 1 **Type:** number **Range:** 1-7 **Default:** 1 **dns-cache-enable** **Description** Enable DNS cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-cache-entry-size** **Description** Set DNS cache entry size, default is 256 bytes (1-4096 bytes, default is 256 bytes) **Type:** number **Range:** 1-4096 **Default:** 256 **dns-cache-sync** **Description** Enable DNS cache HA sync **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-cache-sync-entry-size** **Description** Only sync DNS cache with smaller size (1-4096 bytes, default is 256 bytes) **Type:** number **Range:** 1-4096 **Default:** 256 **dns-cache-sync-ttl-threshold** **Description** Only sync DNS cache with longer TTL (0-10000000 seconds, default is 0 second) **Type:** number **Range:** 0-10000000 **Default:** 0 **dns-cache-ttl-adjustment-enable** **Description** Enable DNS cache response ttl adjustment **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-negative-cache-enable** **Description** Enable DNS negative cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-persistent-cache-enable** **Description** Enable persistent DNS cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-persistent-cache-hit-threshold** **Description** Only save DNS cache with larger hit count (0-10000000, default is 0) **Type:** number **Range:** 0-10000000 **Default:** 0 **dns-persistent-cache-ttl-threshold** **Description** Only save DNS cache with longer TTL (0-10000000 seconds, default is 0 second) **Type:** number **Range:** 0-10000000 **Default:** 0 **dns-response-rate-limiting** **Description:** dns-response-rate-limiting is a **JSON Block**. Please see below for :ref:`3076_common_dns-response-rate-limiting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/common/dns-response-rate-limiting ` **dns-vip-stateless** **Description** Enable DNS VIP stateless mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **drop-icmp-to-vip-when-vip-down** **Description** Drop ICMP to VIP when VIP down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dsr-health-check-enable** **Description** Enable dsr-health-check (direct server return health check) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ecmp-hash** **Description** 'system-default': Use system default ecmp hashing algorithm; 'connection-based': Use connection information for hashing; **Type:** string **Supported Values:** system-default, connection-based **Default:** system-default **enable-ddos** **Description** Enable DDoS protection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable-fast-path-rerouting** **Description** Enable Fast-Path Rerouting **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable-l7-req-acct** **Description** Enable L7 request accounting **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **entity** **Description** 'server': Graceful shutdown server/port only; 'virtual-server': Graceful shutdown virtual server/port only; **Type:** string **Supported Values:** server, virtual-server **exclude-destination** **Description** 'local': Maximum local rate; 'remote': Maximum remote rate; (Maximum rates) **Type:** string **Supported Values:** local, remote **extended-stats** **Description** Enable global slb extended statistics **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fast-path-disable** **Description** Disable fast path in SLB processing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gateway-health-check** **Description** Enable gateway health check **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **graceful-shutdown** **Description** 1-65535, in unit of seconds **Type:** number **Range:** 1-65535 **graceful-shutdown-enable** **Description** Enable graceful shutdown **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **health-check-to-all-vip** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **honor-server-response-ttl** **Description** Honor the server reponse TTL **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **http-fast-enable** **Description** Enable Http Fast in SLB processing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hw-compression** **Description** Use hardware compression **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hw-syn-rr** **Description** Configure hardware SYN round robin (range 1-500000) **Type:** number **Range:** 1-500000 **interval** **Description** Specify the healthcheck interval, default is 5 seconds (Interval Value, in seconds (default 5)) **Type:** number **Range:** 1-180 **Default:** 5 **ipv4-offset** **Description** IPv4 Octet Offset for Hash **Type:** number **Range:** 0-3 **Default:** 0 **ipv6-subnet** **Description** IPv6 Octet Valid Subnet Length for Hash **Type:** number **Range:** 0-15 **Default:** 0 **l2l3-trunk-lb-disable** **Description** Disable L2/L3 trunk LB **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-for-reset-unknown-conn** **Description** Log when rate exceed **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **low-latency** **Description** Enable low latency mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-buff-queued-per-conn** **Description** Set per connection buffer threshold (Buffer value range 128-4096) **Type:** number **Range:** 128-4096 **Default:** 1000 **max-http-header-count** **Description** Set maximum number of HTTP headers allowed **Type:** number **Range:** 90-255 **Default:** 90 **max-local-rate** **Description** Set maximum local rate **Type:** number **Range:** 1-100 **Default:** 32 **max-persistent-cache** **Description** Define maximum persistent cache (Maximum persistent cache entry) **Type:** number **max-remote-rate** **Description** Set maximum remote rate **Type:** number **Range:** 1-1000000 **Default:** 15000 **monitor-mode-enable** **Description** Enable NG-WAF monitor mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **msl-time** **Description** Configure maximum session life, default is 2 seconds (1-39 seconds, default is 2 seconds) **Type:** number **Range:** 1-39 **Default:** 2 **mss-table** **Description** Set MSS table (128-750, default is 536) **Type:** number **Range:** 128-750 **Default:** 536 **multi-cpu** **Description** Specific NGWAF CPU **Type:** number **Range:** 0-28 **Default:** 0 **ngwaf-proxy-ipv4** **Description** IPv4 address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ngwaf-proxy-ipv4 and ngwaf-proxy-ipv6 are mutually exclusive **ngwaf-proxy-ipv6** **Description** IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ngwaf-proxy-ipv6 and ngwaf-proxy-ipv4 are mutually exclusive **ngwaf-proxy-port** **Description** Port **Type:** number **Range:** 1-65534 **no-auto-up-on-aflex** **Description** Don't automatically mark vport up when aFleX is bound **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **odd-even-nat-enable** **Description** Enable odd even nat pool allocation in dual blade systems **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **one-server-conn-hm-rate** **Description** One Server Conn Health Check Rate **Type:** number **Range:** 1-60 **override-port** **Description** Enable override port in DSR health check mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pbslb-entry-age** **Description** Set global pbslb entry age (minute) **Type:** number **Range:** 1-127 **Default:** 6 **pbslb-overflow-glid** **Description** Apply global limit id to overflow pbslb entry **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/glid ` **per-thr-percent** **Description** Percentage of default session count to use for per thread session table size **Type:** number **Range:** 1-100 **ping-sweep-detection** **Description** 'enable': Enable ping sweep detection; 'disable': Disable ping sweep detection(default); **Type:** string **Supported Values:** enable, disable **Default:** disable **pkt-rate-for-reset-unknown-conn** **Description** **Type:** number **Range:** 1-1048575 **player-id-check-enable** **Description** Enable the Player id check **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **port** **Description** Serverside port number for SNI transmission **Type:** number **Range:** 1-65535 **port-scan-detection** **Description** 'enable': Enable port scan detection; 'disable': Disable port scan detection(default); **Type:** string **Supported Values:** enable, disable **Default:** disable **pre-process-enable** **Description** Enable NG-WAF pre-processing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **quic** **Description:** quic is a **JSON Block**. Please see below for :ref:`3076_common_quic` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/common/quic ` **range** **Description** auto translate port range **Type:** number **Range:** 1-3 **range-end** **Description** port range end **Type:** number **Range:** 0-65535 **range-start** **Description** port range start **Type:** number **Range:** 0-65535 **rate-limit-logging** **Description** Configure rate limit logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **recursive-ns-cache** **Description** 'honor-packet-ttl': Honor the lowest TTL among NS records in the server response; 'honor-age-config': Honor the ttl/age settings based on acos dns cache configuration; **Type:** string **Supported Values:** honor-packet-ttl, honor-age-config **Default:** honor-packet-ttl **reset-stale-session** **Description** Send reset if session in delete queue receives a SYN packet **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **resolve-port-conflict** **Description** Enable client port service port conflicts **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **response-type** **Description** 'single-answer': Only cache DNS response with single answer; 'round-robin': Round robin; **Type:** string **Supported Values:** single-answer, round-robin **scale-out** **Description** Enable SLB scale out **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **scale-out-traffic-map** **Description** Set SLB scaleout traffic-map **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **serverside-ip** **Description** Serverside IP address **Type:** string **Format:** ipv4-address **serverside-ipv6** **Description** Serverside IPv6 address **Type:** string **Format:** ipv6-address **service-group-on-no-dest-nat-vports** **Description** 'allow-same': Allow the binding service-group on no-dest-nat virtual ports; 'enforce-different': Enforce that the same service-group can not be bound on different no-dest-nat virtual ports; **Type:** string **Supported Values:** allow-same, enforce-different **Default:** enforce-different **show-slb-server-legacy-cmd** **Description** Enable show slb server legacy command **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **show-slb-service-group-legacy-cmd** **Description** Enable show slb service-group legacy command **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **show-slb-virtual-server-legacy-cmd** **Description** Enable show slb virtual-server legacy command **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **snat-gwy-for-l3** **Description** Use source NAT gateway for L3 traffic for transparent mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **snat-on-vip** **Description** Enable source NAT traffic against VIP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **snat-preserve** **Description:** snat-preserve is a **JSON Block**. Please see below for :ref:`3076_common_snat-preserve` **Type:** Object **software** **Description** Software **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** software,software-tls13, QAT, N5-new, N5-old, and software-tls13-offload are mutually exclusive **software-tls13** **Description** Software TLS1.3 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** software-tls13,software, QAT, N5-new, N5-old, and software-tls13-offload are mutually exclusive **software-tls13-offload** **Description** Software TLS1.3 with CPU Offload Support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** software-tls13-offload,software, software-tls13, QAT, N5-new, and N5-old are mutually exclusive **sort-res** **Description** Enable SLB sorting of resource names **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-module-usage-enable** **Description** Enable SSL module usage calculations for QAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-n5-delay-tx-enable** **Description** Enable delay transmission for N5-new **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-ratelimit-cfg** **Description:** ssl-ratelimit-cfg is a **JSON Block**. Please see below for :ref:`3076_common_ssl-ratelimit-cfg` **Type:** Object **ssli-cert-not-ready-inspect-limit** **Description** SSLI asynchronized connection max number, default is 2000 (set to 0 for unlimited size) **Type:** number **Range:** 0-2147483647 **Default:** 2000 **ssli-cert-not-ready-inspect-timeout** **Description** SSLI asynchronized connection timeout, default is 10 seconds (seconds, set to 0 for never timeout) **Type:** number **Range:** 0-2147483647 **Default:** 10 **ssli-silent-termination-enable** **Description** Terminate the SSLi sessions silently without sending RST/FIN packet **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssli-sni-hash-enable** **Description** Enable SSLi SNI hash table **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stateless-sg-multi-binding** **Description** Enable stateless service groups to be assigned to multiple L2/L3 DSR VIPs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stats-data-disable** **Description** Disable global slb data statistics **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **substitute-source-mac** **Description** Substitute Source MAC Address to that of the outgoing interface **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timeout** **Description** Specify the healthcheck timeout value, default is 15 seconds (Timeout Value, in seconds (default 15)) **Type:** number **Range:** 1-360 **Default:** 15 **traffic-map-type** **Description** 'vport': traffic-map per vport; 'global': global traffic-map; **Type:** string **Supported Values:** vport, global **Default:** vport **ttl-threshold** **Description** Only cache DNS response with longer TTL **Type:** number **Range:** 1-10000000 **use-default-sess-count** **Description** Use default session count **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-https-proxy** **Description** NG-WAF connects to Cloud through proxy server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-mgmt-port** **Description** Use management port to connect **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-mss-tab** **Description** Use MSS based on internal table for SLB processing **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 **vport-global** **Description** Configure periodic showtech vport paging global limit **Type:** number **Range:** 0-512 **vport-l3v** **Description** Configure periodic showtech vport paging l3v limit **Type:** number **Range:** 0-128 .. _3076_common_aflex-table-entry-sync: common_aflex-table-entry-sync ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **aflex-table-entry-sync-enable** **Description** Enable aflex table sync **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **aflex-table-entry-sync-max-key-len** **Description** aflex table entry max key length to sync **Type:** number **Range:** 0-1000 **Default:** 1000 **aflex-table-entry-sync-max-value-len** **Description** aflex table entry max value length to sync **Type:** number **Range:** 0-1000 **Default:** 1000 **aflex-table-entry-sync-min-lifetime** **Description** aflex table entry minimum lifetime to sync **Type:** number **Range:** 0-65535 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_common_cert-pinning: common_cert-pinning ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **candidate-list-feedback-opt-in** **Description:** candidate-list-feedback-opt-in is a **JSON Block**. Please see below for :ref:`3076_common_cert-pinning_candidate-list-feedback-opt-in` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/common/cert-pinning/candidate-list-feedback-opt-in ` **ttl** **Description** The ttl of local cert pinning candidate list, multiple of 10 minutes, default is 144 (1440 minutes) **Type:** number **Range:** 1-1008 **Default:** 144 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_common_cert-pinning_candidate-list-feedback-opt-in: common_cert-pinning_candidate-list-feedback-opt-in ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **daily** **Description** Every day **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** daily and weekly are mutually exclusive **day-time** **Description** Time of day to update (hh:mm) in 24 hour local time **Type:** string **Format:** time-hhmm **enable** **Description** Enable the feedback function **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **schedule** **Description** schedule the uploading time, default is daily 00:00 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-mgmt-port** **Description** Use management port to connect **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 **week-day** **Description** 'Monday': Monday; 'Tuesday': Tuesday; 'Wednesday': Wednesday; 'Thursday': Thursday; 'Friday': Friday; 'Saturday': Saturday; 'Sunday': Sunday; **Type:** string **Supported Values:** Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday **week-time** **Description** Time of day to update (hh:mm) in 24 hour local time **Type:** string **Format:** time-hhmm **weekly** **Description** Every week **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** weekly and daily are mutually exclusive .. _3076_common_dns-response-rate-limiting: common_dns-response-rate-limiting ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **max-table-entries** **Description** Maximum number of entries allowed **Type:** number **Range:** 1000-4194304 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_common_ssl-ratelimit-cfg: common_ssl-ratelimit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **disable-rate** **Description** Disable HW SSL Rate limit for N5-new **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disable-rate, tls12-rate, and tls13-rate are mutually exclusive **tls12-rate** **Description** Enabling Rateliming for TLS1.2 HW requests per chip in 1K - default 120 **Type:** number **Range:** 1-1000 **Default:** 120 **Mutual Exclusion:** tls12-rate and disable-rate are mutually exclusive **tls13-rate** **Description** Enabling Rateliming for TLS1.3 HW requests per chip in 1K - default 72 **Type:** number **Range:** 1-200 **Default:** 72 **Mutual Exclusion:** tls13-rate and disable-rate are mutually exclusive .. _3076_common_quic: common_quic ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cid-len** **Description** Length of CID **Type:** number **Range:** 4-20 **Default:** 4 **cpu-offset** **Description** Offset for Encoded CPU **Type:** number **Range:** 0-15 **Default:** 12 **enable-hash** **Description** Enable CID Hashing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable-signature** **Description** Enable CID Signature Validation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **quic-lb-offset** **Description** Offset for QUIC-LB **Type:** number **Range:** 0-15 **Default:** 8 **signature** **Description** Set CID Signature **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **signature-len** **Description** Offset for CID Signature **Type:** number **Range:** 1-4 **Default:** 3 **signature-offset** **Description** Offset for CID Signature **Type:** number **Range:** 0-15 **Default:** 4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_common_conn-rate-limit: common_conn-rate-limit ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **src-ip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/common/conn-rate-limit/src-ip/{disable-ipv6-support}+{protocol} ` .. _3076_common_conn-rate-limit_src-ip-list: common_conn-rate-limit_src-ip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **disable-ipv6-support** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exceed-action** **Description** Set action if threshold exceeded **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **limit** **Description** Set max connections per period **Type:** number **Range:** 1-1000000 **limit-period** **Description** '100': 100 ms; '1000': 1000 ms; **Type:** string **Supported Values:** 100, 1000 **lock-out** **Description** Set lockout period in seconds if threshold exceeded **Type:** number **Range:** 1-3600 **log** **Description** Send log if threshold exceeded **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **protocol** **Description** 'tcp': Set TCP connection rate limit; 'udp': Set UDP packet rate limit; **Type:** string **Supported Values:** tcp, udp **shared** **Description** Set threshold shared amongst all virtual ports **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 .. _3076_common_ddos-protection: common_ddos-protection ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ipd-enable-toggle** **Description** 'enable': Enable SLB DDoS protection; 'disable': Disable SLB DDoS protection (default); **Type:** string **Supported Values:** enable, disable **Default:** disable **logging** **Description:** logging is a **JSON Block**. Please see below for :ref:`3076_common_ddos-protection_logging` **Type:** Object **packets-per-second** **Description:** packets-per-second is a **JSON Block**. Please see below for :ref:`3076_common_ddos-protection_packets-per-second` **Type:** Object .. _3076_common_ddos-protection_packets-per-second: common_ddos-protection_packets-per-second ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ipd-tcp** **Description** Configure packets-per-second threshold per TCP port (default: 200) **Type:** number **Range:** 0-65535 **Default:** 200 **ipd-udp** **Description** Configure packets-per-second threshold per UDP port (default: 200) **Type:** number **Range:** 0-65535 **Default:** 200 .. _3076_common_ddos-protection_logging: common_ddos-protection_logging ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ipd-logging-toggle** **Description** 'enable': Enable SLB DDoS protection logging (default); 'disable': Disable SLB DDoS protection logging; **Type:** string **Supported Values:** enable, disable **Default:** enable .. _3076_common_snat-preserve: common_snat-preserve ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **range** **Type:** List .. _3076_common_snat-preserve_range: common_snat-preserve_range ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port1** **Description** start port **Type:** number **Range:** 1025-65535 **Default:** 1025 **port2** **Description** end port which is greater than start **Type:** number **Range:** 1025-65535 **Default:** 1025 .. _3076_ssl-scep-cert-status: ssl-scep-cert-status ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-cert-pinning-candidate-list: ssl-cert-pinning-candidate-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ac-class-list-list: ac-class-list-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ac-list** **Type:** List **name** **Description** Specify name of the class list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** test **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _3076_ac-class-list-list_ac-list: ac-class-list-list_ac-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ac-key-string** **Description** Specify key string **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **ac-key-value** **Description** Specify value string **Type:** string **Format:** string-rlx **Maximum Length:** 639 characters **Maximum Length:** 1 characters **ac-match-type** **Description** 'contains': String contains another string; 'ends-with': String ends with another string; 'equals': String equals another string; 'starts-with': String starts with another string; **Type:** string **Supported Values:** contains, ends-with, equals, starts-with **action** **Description** 'add': Add the entry; 'delete': Delete the entry; **Type:** string **Supported Values:** add, delete .. _3076_health-check-details: health-check-details ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_health-stat: health-stat ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_health-stat_sampling-enable: health-stat_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num_burst': Number of burst; 'max_jiffie': Maximum number of jiffies; 'min_jiffie': Minimum number of jiffies; 'avg_jiffie': Average number of jiffies; 'open_socket': Number of open sockets; 'open_socket_failed': Number of failed open sockets; 'close_socket': Number of closed sockets; 'connect_failed': Number of failed connections; 'send_packet': Number of packets sent; 'send_packet_failed': Number of packet send failures; 'recv_packet': Number of received packets; 'recv_packet_failed': Number of failed packet receives; 'retry_times': Retry times; 'timeout': Timouet value; 'unexpected_error': Number of unexpected errors; 'conn_imdt_succ': Number of connection immediete success; 'sock_close_before_17': Number of sockets closed before l7; 'sock_close_without_notify': Number of sockets closed without notify; 'curr_health_rate': Current health rate; 'ext_health_rate': External health rate; 'ext_health_rate_val': External health rate value; 'total_number': Total number; 'status_up': Number of status ups; 'status_down': Number of status downs; 'status_unkn': Number of status unknowns; 'status_other': Number of other status; 'running_time': Running time; 'config_health_rate': Config health rate; 'ssl_post_handshake_packet': Number of ssl post handshake packets before client sends request; 'timeout_with_packet': Number of pin timeouts while socket has packets; **Type:** string **Supported Values:** all, num_burst, max_jiffie, min_jiffie, avg_jiffie, open_socket, open_socket_failed, close_socket, connect_failed, send_packet, send_packet_failed, recv_packet, recv_packet_failed, retry_times, timeout, unexpected_error, conn_imdt_succ, sock_close_before_17, sock_close_without_notify, curr_health_rate, ext_health_rate, ext_health_rate_val, total_number, status_up, status_down, status_unkn, status_other, running_time, config_health_rate, ssl_post_handshake_packet, timeout_with_packet .. _3076_fwd-policy-snat-pt-only: fwd-policy-snat-pt-only ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-stats: ssl-stats ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_dns-response-rate-limiting: dns-response-rate-limiting ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_dns-response-rate-limiting_sampling-enable: dns-response-rate-limiting_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_entries': Current Entry Count; 'total_created': Total Entry Created; 'total_inserted': Total Entry Inserted; 'total_withdrew': Total Entry Withdrew; 'total_ready_to_free': Total Entry Ready To Free; 'total_freed': Total Entry Freed; 'total_logs': Total Logs; 'total_overflow_entry_hits': Total Overflow Entry Hits; 'total_refill': Total Refills; 'total_credit_exceeded': Total Credit Exceeded; 'other_thread_refill': Other Thread Refilling; 'err_entry_create_failed': Entry Creation Failure; 'err_entry_create_oom': Entry Creation Out of Memory; 'err_entry_ext_create_oom': Entry Extension Creation Out of Memory; 'err_entry_insert_failed': Entry Insert Failed; 'err_vport_fail_match': Failed to Match Vport; **Type:** string **Supported Values:** all, curr_entries, total_created, total_inserted, total_withdrew, total_ready_to_free, total_freed, total_logs, total_overflow_entry_hits, total_refill, total_credit_exceeded, other_thread_refill, err_entry_create_failed, err_entry_create_oom, err_entry_ext_create_oom, err_entry_insert_failed, err_vport_fail_match .. _3076_ssl-cmp-cert-status: ssl-cmp-cert-status ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_player-id-list: player-id-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **player-record** **Type:** List .. _3076_player-id-list_player-record: player-id-list_player-record ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **game-server-ipv4** **Description** Specify IP address **Type:** string **Format:** ipv4-address **game-server-ipv6** **Description** Specify IPv6 address **Type:** string **Format:** ipv6-address **game-server-port-v4** **Description** Port **Type:** number **Range:** 0-65534 **game-server-port-v6** **Description** Port **Type:** number **Range:** 0-65534 **player-id** **Description** 64/32 bit player id based on config **Type:** number **Range:** 0-2147483647 .. _3076_template: template ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cache-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/cache/{name} ` **cipher-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/cipher/{name} ` **client-ssh-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssh/{name} ` **client-ssl-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssl/{name} ` **connection-reuse-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/connection-reuse/{name} ` **dblb-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dblb/{name} ` **diameter-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/diameter/{name} ` **dns-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name} ` **dns-logging-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns-logging/{name} ` **doh-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/doh/{name} ` **dynamic-service-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dynamic-service/{name} ` **external-service-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/external-service/{name} ` **fix-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/fix/{name} ` **ftp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/ftp/{name} ` **http-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/http/{name} ` **http-policy-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/http-policy/{name} ` **imap-pop3-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/imap-pop3/{name} ` **link-block-as-down** **Description:** link-block-as-down is a **JSON Block**. Please see below for :ref:`3076_template_link-block-as-down` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/link-block-as-down ` **link-cost-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/link-cost/{name} ` **link-down-on-restart** **Description:** link-down-on-restart is a **JSON Block**. Please see below for :ref:`3076_template_link-down-on-restart` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/link-down-on-restart ` **link-probe-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/link-probe/{name} ` **logging-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/logging/{name} ` **monitor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/monitor/{id} ` **mqtt-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/mqtt/{name} ` **persist** **Description:** persist is a **JSON Block**. Please see below for :ref:`3076_template_persist` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/persist ` **policy-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name} ` **port-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/port/{name} ` **quic-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/quic/{name} ` **reqmod-icap-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/reqmod-icap/{name} ` **respmod-icap-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/respmod-icap/{name} ` **server-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/server/{name} ` **server-ssh-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssh/{name} ` **server-ssl-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssl/{name} ` **sip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/sip/{name} ` **smpp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/smpp/{name} ` **smtp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/smtp/{name} ` **ssli-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/ssli/{name} ` **tcp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/tcp/{name} ` **tcp-proxy-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy/{name} ` **udp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/udp/{name} ` **virtual-port-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/virtual-port/{name} ` **virtual-server-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/virtual-server/{name} ` .. _3076_template_logging-list: template_logging-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **auto** **Description** 'auto': Configure auto NAT for logging, default is auto enabled; **Type:** string **Supported Values:** auto **Default:** auto **Mutual Exclusion:** auto and pool are mutually exclusive **format** **Description** Specify a format string for web logging (format string(less than 250 characters) for web logging) **Type:** string **Format:** string-rlx **Maximum Length:** 250 characters **Maximum Length:** 1 characters **keep-end** **Description** Number of unmasked characters at the end (default: 0) **Type:** number **Range:** 0-65535 **Default:** 0 **keep-start** **Description** Number of unmasked characters at the beginning (default: 0) **Type:** number **Range:** 0-65535 **Default:** 0 **local-logging** **Description** 1 to enable local logging (1 to enable local logging, default 0) **Type:** number **Range:** 0-1 **Default:** 0 **mask** **Description** Character to mask the matched pattern (default: X) **Type:** string **Maximum Length:** 1 characters **Maximum Length:** 1 characters **Default:** X **name** **Description** Logging Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **pcre-mask** **Description** Mask matched PCRE pattern in the log **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **pool** **Description** Specify NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** pool, shared-partition-pool, and auto are mutually exclusive **pool-shared** **Description** Specify NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **service-group** **Description** Bind a Service Group to the logging template (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **shared-partition-pool** **Description** Reference a NAT pool or pool group from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-pool and pool are mutually exclusive **shared-partition-tcp-proxy-template** **Description** Reference a TCP Proxy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive **tcp-proxy** **Description** TCP Proxy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **template-tcp-proxy-shared** **Description** TCP Proxy Template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **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 .. _3076_template_cache-list: template_cache-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **accept-reload-req** **Description** Accept reload requests via cache-control directives in HTTP headers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **age** **Description** Specify duration in seconds cached content valid, default is 3600 seconds (seconds that the cached content is valid (default 3600 seconds)) **Type:** number **Range:** 1-999999 **Default:** 3600 **default-policy-nocache** **Description** Specify default policy to be to not cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-insert-age** **Description** Disable insertion of age header in response served from RAM cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-insert-via** **Description** Disable insertion of via header in response served from RAM cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **local-uri-policy** **Type:** List **logging** **Description** Specify logging template (Logging Config name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/logging ` **max-cache-size** **Description** Specify maximum cache size in megabytes, default is 80MB (RAM cache size in megabytes (default 80MB)) **Type:** number **Range:** 1-4096 **Default:** 80 **max-content-size** **Description** Maximum size (bytes) of response that can be cached - default 81920 (80KB) **Type:** number **Range:** 0-268435455 **Default:** 81920 **min-content-size** **Description** Minimum size (bytes) of response that can be cached - default 512 **Type:** number **Range:** 0-268435455 **Default:** 512 **name** **Description** Specify cache template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **packet-capture-template** **Description** Name of the packet capture template to be bind with this object **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/slb-templ-cache-tmpl ` **remove-cookies** **Description** Remove cookies in response and cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **replacement-policy** **Description** 'LFU': LFU; **Type:** string **Supported Values:** LFU **Default:** LFU **sampling-enable** **Type:** List **uri-policy** **Type:** List **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 **verify-host** **Description** Verify request using host before sending response from RAM cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_cache-list_local-uri-policy: template_cache-list_local-uri-policy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **local-uri** **Description** Specify Local URI for caching (Specify URI pattern that the policy should be applied to, maximum 63 charaters) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_cache-list_sampling-enable: template_cache-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Cache hits; 'miss': Cache misses; 'bytes_served': Bytes served from cache; 'total_req': Total requests received; 'caching_req': Total requests to cache; 'nc_req_header': slbTemplateCacheNcReqHeader, help nc_req_header; 'nc_res_header': slbTemplateCacheNcResHeader, help nc_res_header; 'rv_success': some help string; 'rv_failure': slbTemplateCacheRvFailure, help rv_failure; 'ims_request': some help string; 'nm_response': some help string; 'rsp_type_CL': some help string; 'rsp_type_CE': some help string; 'rsp_type_304': some help string; 'rsp_type_other': some help string; 'rsp_no_compress': some help string; 'rsp_gzip': some help string; 'rsp_deflate': some help string; 'rsp_other': some help string; 'nocache_match': some help string; 'match': some help string; 'invalidate_match': some help string; 'content_toobig': slbTemplateCacheContentToobig, help content_toobig; 'content_toosmall': slbTemplateCacheContentToosmall, help content_toosmall; 'entry_create_failures': slbTemplateCacheEntryCreateFailures, help entry_create_failures; 'mem_size': some help string; 'entry_num': some help string; 'replaced_entry': some help string; 'aging_entry': some help string; 'cleaned_entry': some help string; 'rsp_type_stream': some help string; 'header_save_error': some help string; 'rsp_br': rsp_br; **Type:** string **Supported Values:** all, hits, miss, bytes_served, total_req, caching_req, nc_req_header, nc_res_header, rv_success, rv_failure, ims_request, nm_response, rsp_type_CL, rsp_type_CE, rsp_type_304, rsp_type_other, rsp_no_compress, rsp_gzip, rsp_deflate, rsp_other, nocache_match, match, invalidate_match, content_toobig, content_toosmall, entry_create_failures, mem_size, entry_num, replaced_entry, aging_entry, cleaned_entry, rsp_type_stream, header_save_error, rsp_br .. _3076_template_cache-list_uri-policy: template_cache-list_uri-policy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cache-action** **Description** 'cache': Specify if certain URIs should be cached; 'nocache': Specify if certain URIs should not be cached; **Type:** string **Supported Values:** cache, nocache **cache-value** **Description** Specify seconds that content should be cached, default is age specified in cache template **Type:** number **Range:** 1-999999 **invalidate** **Description** Specify if URI should invalidate cache entries matching pattern (pattern that would match entries to be invalidated (64 chars max)) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uri** **Description** Specify URI for cache policy (Specify URI pattern that the policy should be applied to, maximum 63 charaters) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_port-list: template_port-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **add** **Description** Slow start connection limit add by a number every interval (Add by this number every interval) **Type:** number **Range:** 1-4095 **Mutual Exclusion:** add and times are mutually exclusive **bw-rate-limit** **Description** Configure bandwidth rate limit on real server port (Bandwidth rate limit in Kbps) **Type:** number **Range:** 1-16777216 **bw-rate-limit-duration** **Description** Duration in seconds the observed rate needs to honor **Type:** number **Range:** 1-250 **bw-rate-limit-no-logging** **Description** Do not log bandwidth rate limit related state transitions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bw-rate-limit-resume** **Description** Resume server selection after bandwidth drops below this threshold (in Kbps) (Bandwidth rate limit resume threshold (in Kbps)) **Type:** number **Range:** 1-16777216 **conn-limit** **Description** Connection limit **Type:** number **Range:** 1-64000000 **Default:** 64000000 **conn-limit-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-rate-limit** **Description** Connection rate limit **Type:** number **Range:** 1-1048575 **conn-rate-limit-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dampening-flaps** **Description** service dampening flaps count (max-flaps allowed in flap period) **Type:** number **Range:** 1-255 **decrement** **Description** Decrease after every round of DNS query (default is 0) **Type:** number **Range:** 0-7 **Default:** 0 **del-session-on-server-down** **Description** Delete session if the server/port goes down (either disabled/hm down) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dest-nat** **Description** Destination NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **down-grace-period** **Description** Port down grace period (Down grace period in seconds) **Type:** number **Range:** 1-86400 **down-timer** **Description** The timer to bring the marked down server/port to up (default is 0, never bring up) (The timer to bring up server (in second, default is 0)) **Type:** number **Range:** 0-255 **Default:** 0 **dscp** **Description** Differentiated Services Code Point (DSCP to Real Server IP Mapping Value) **Type:** number **Range:** 1-63 **dynamic-member-priority** **Description** Set dynamic member's priority (Initial priority (default is 16)) **Type:** number **Range:** 1-16 **Default:** 16 **every** **Description** Slow start connection limit increment interval (default 10) **Type:** number **Range:** 1-60 **Default:** 10 **extended-stats** **Description** Enable extended statistics on real server port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **flap-period** **Description** take service out of rotation if max-flaps exceeded within time in seconds **Type:** number **Range:** 1-255 **health-check** **Description** Health Check Monitor (Health monitor name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable configured health check configuration **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive **inband-health-check** **Description** Use inband traffic to detect port's health status **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **initial-slow-start** **Description** Initial slow start connection limit (default 128) **Type:** number **Range:** 1-4095 **Default:** 128 **name** **Description** Port template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **no-ssl** **Description** No SSL **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rate-interval** **Description** '100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; **Type:** string **Supported Values:** 100ms, second **Default:** second **reassign** **Description** Maximum reassign times before declear the server/port down (default is 25) (The maximum reassign number) **Type:** number **Range:** 0-255 **Default:** 25 **request-rate-interval** **Description** '100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; **Type:** string **Supported Values:** 100ms, second **Default:** second **request-rate-limit** **Description** Request rate limit **Type:** number **Range:** 1-1048575 **request-rate-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **resel-on-reset** **Description** When receiving reset from server, do the server/port reselection (default is 0, don't do reselection) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset** **Description** Send client reset when connection rate over limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **restore-svc-time** **Description** put the service back to the rotation after time in seconds **Type:** number **Range:** 1-4095 **resume** **Description** Resume accepting new connection after connection number drops below threshold (Connection resume threshold) **Type:** number **Range:** 1-1048575 **retry** **Description** Maximum retry times before reassign this connection to another server/port (default is 2) (The maximum retry number) **Type:** number **Range:** 0-7 **Default:** 2 **shared-partition-pool** **Description** Reference a NAT pool or pool-group from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-pool and source-nat are mutually exclusive **slow-start** **Description** Slowly ramp up the connection number after port is up **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **source-nat** **Description** Source NAT (IP NAT Pool or pool group name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** source-nat and shared-partition-pool are mutually exclusive **stats-data-action** **Description** 'stats-data-enable': Enable statistical data collection for real server port; 'stats-data-disable': Disable statistical data collection for real server port; **Type:** string **Supported Values:** stats-data-enable, stats-data-disable **Default:** stats-data-enable **sub-group** **Description** Divide service group members into different sub groups (Sub group ID (default is 0)) **Type:** number **Range:** 0-15 **Default:** 0 **template-port-pool-shared** **Description** Source NAT (IP NAT Pool or pool group name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **till** **Description** Slow start ends when slow start connection limit reaches a number (default 4096) (Slow start ends when connection limit reaches this number) **Type:** number **Range:** 1-65535 **Default:** 4096 **times** **Description** Slow start connection limit multiply by a number every interval (default 2) (Multiply by this number every interval) **Type:** number **Range:** 2-10 **Default:** 2 **Mutual Exclusion:** times and add are mutually exclusive **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 **weight** **Description** Weight (port weight) **Type:** number **Range:** 1-1000 **Default:** 1 .. _3076_template_connection-reuse-list: template_connection-reuse-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **add-header** **Description** Insert HTTP Connection: keep-alive header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **keep-alive-conn** **Description** Keep a number of server connections open **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **limit-per-server** **Description** Max Server Connections allowed (Connections per Server Port (default 1000)) **Type:** number **Range:** 0-65535 **Default:** 1000 **name** **Description** Connection Reuse Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **num-conn-per-port** **Description** Connections per Server Port (default 100) **Type:** number **Range:** 1-1024 **Default:** 100 **preopen** **Description** Preopen server connection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timeout** **Description** Timeout in seconds. Multiple of 60 (default 2400) **Type:** number **Range:** 60-3600 **Default:** 2400 **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 .. _3076_template_link-cost-list: template_link-cost-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bandwidth-interval** **Description** Interval duration in seconds **Type:** number **Range:** 1-60 **Default:** 5 **name** **Description** Server Link-Cost Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **overage-bandwidth-cost** **Description** Configure overage bandwidth cost on real server (Overage bandwidth cost per Mbpi) **Type:** number **Range:** 0-4294967295 **Default:** 0 **prepaid-bandwidth** **Description** Configure prepaid bandwidth on real server (Prepaid Bandwidth in Mbpi) **Type:** number **Range:** 0-4294967295 **Default:** 0 **sampling-enable** **Type:** List **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 .. _3076_template_link-cost-list_sampling-enable: template_link-cost-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'link_total_fwd_bytes': Total bytes fwd for link; 'interval_fwd_bytes': Link Cost bytes processed in forward direction per interval; 'link_total_conn': Link Cost total connection; 'interval_avg_throughput': Link Cost average throughput per interval; 'interval_max_throughput': Link Cost max throughput per interval; **Type:** string **Supported Values:** all, link_total_fwd_bytes, interval_fwd_bytes, link_total_conn, interval_avg_throughput, interval_max_throughput .. _3076_template_reqmod-icap-list: template_reqmod-icap-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'continue': Continue; 'drop': Drop; 'reset': Reset; **Type:** string **Supported Values:** continue, drop, reset **Default:** continue **allowed-http-methods** **Description** List of allowed HTTP methods. Default is "Allow All". (List of HTTP methods allowed (default "Allow All")) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **bypass-ip-cfg** **Type:** List **disable-http-server-reset** **Description** Don't reset http server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fail-close** **Description** When template sg is down mark vport down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **failure-action** **Description** 'continue': Continue; 'drop': Drop; 'reset': Reset; **Type:** string **Supported Values:** continue, drop, reset **Default:** continue **include-protocol-in-uri** **Description** Include protocol and port in HTTP URI **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-only-allowed-method** **Description** Only log allowed HTTP method **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **logging** **Description** logging template (Logging template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/logging ` **min-payload-size** **Description** min-payload-size value 0 - 65535, default is 0 **Type:** number **Range:** 0-65535 **Default:** 0 **name** **Description** Reqmod ICAP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **preview** **Description** Preview value 1 - 32768, default is 32768 **Type:** number **Range:** 1-32768 **Default:** 32768 **server-ssl** **Description** Server SSL template (Server SSL template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssl ` **service-group** **Description** Bind a Service Group to the template (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **service-url** **Description** URL to send to ICAP server (Service URL Name) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **shared-partition-persist-source-ip-template** **Description** Reference a persist source ip template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-persist-source-ip-template and source-ip are mutually exclusive **shared-partition-tcp-proxy-template** **Description** Reference a TCP Proxy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive **source-ip** **Description** Source IP persistence template (Source IP persistence template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** source-ip and shared-partition-persist-source-ip-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip ` **tcp-proxy** **Description** TCP Proxy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **template-persist-source-ip-shared** **Description** Source IP Persistence Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip ` **template-tcp-proxy-shared** **Description** TCP Proxy Template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **timeout** **Description** Timeout value 1 - 200 in units of 200ms, default is 5 (default is 1000ms) (1 - 200 in units of 200ms, default is 5 (1000ms)) **Type:** number **Range:** 1-200 **Default:** 5 **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 **x-auth-url** **Description** Use URL format for authentication **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_reqmod-icap-list_bypass-ip-cfg: template_reqmod-icap-list_bypass-ip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bypass-ip** **Description** ip address to bypass reqmod-icap service **Type:** string **Format:** ipv4-address **mask** **Description** IP prefix mask **Type:** string **Format:** ipv4-netmask .. _3076_template_smpp-list: template_smpp-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-enquire-link** **Description** Respond client ENQUIRE_LINK packet directly instead of forwarding to server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** SMPP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **password** **Description** Configure the password used to bind **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **server-enquire-link** **Description** Send server ENQUIRE_LINK packet for every persist connection when enable conn-reuse **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-enquire-link-val** **Description** Set interval of keep-alive packet for each persistent connection (second, default is 30) **Type:** number **Range:** 5-300 **Default:** 30 **server-selection-per-request** **Description** Force server selection on every SMPP request when enable conn-reuse **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **user** **Description** Configure the user to bind (The name used to bind) **Type:** string **Format:** string-rlx **Maximum Length:** 63 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 .. _3076_template_smtp-list: template_smtp-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **LF-to-CRLF** **Description** Change the LF to CRLF for smtp end of line **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-domain-switching** **Type:** List **client-starttls-type** **Description** 'optional': STARTTLS is optional requirement; 'enforced': Must issue STARTTLS command before mail transaction; **Type:** string **Supported Values:** optional, enforced **command-disable** **Type:** List **error-code-to-client** **Description** Would transfer error code(554) to client, when getting it from connection establishing with real-server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** SMTP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **server-domain** **Description** Config the domain of the email servers (Server's domain, default is "mail-server-domain") **Type:** string **Format:** host **Maximum Length:** 254 characters **Maximum Length:** 1 characters **Default:** mail-server-domain **server-starttls-type** **Description** 'optional': STARTTLS is optional requirement; 'enforced': Must issue STARTTLS command before mail transaction; **Type:** string **Supported Values:** optional, enforced **service-ready-msg** **Description** Set SMTP service ready message (SMTP service ready message, default is "ESMTP mail service ready") **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** ESMTP mail service ready **template** **Description:** template is a **JSON Block**. Please see below for :ref:`3076_template_smtp-list_template` **Type:** Object **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_smtp-list_client-domain-switching: template_smtp-list_client-domain-switching ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **match-string** **Description** Domain name string **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters **service-group** **Description** Select service group (Service group name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **switching-type** **Description** 'contains': Specify domain name string if domain contains another string; 'ends-with': Specify domain name string if domain ends with another string; 'starts-with': Specify domain string if domain starts with another string; **Type:** string **Supported Values:** contains, ends-with, starts-with .. _3076_template_smtp-list_template: template_smtp-list_template ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **logging** **Description** Logging template (Logging Config name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/logging ` .. _3076_template_smtp-list_command-disable: template_smtp-list_command-disable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **disable-type** **Description** 'expn': Disable SMTP EXPN commands; 'turn': Disable SMTP TURN commands; 'vrfy': Disable SMTP VRFY commands; **Type:** string **Supported Values:** expn, turn, vrfy .. _3076_template_external-service-list: template_external-service-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'continue': Continue; 'drop': Drop; 'reset': Reset; **Type:** string **Supported Values:** continue, drop, reset **Default:** continue **bypass-ip-cfg** **Type:** List **failure-action** **Description** 'continue': Continue; 'drop': Drop; 'reset': Reset; **Type:** string **Supported Values:** continue, drop, reset **Default:** continue **name** **Description** External Service Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **request-header-forward-list** **Type:** List **service-group** **Description** Bind a Service Group to the template (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **shared-partition-persist-source-ip-template** **Description** Reference a persist source ip template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-persist-source-ip-template and source-ip are mutually exclusive **shared-partition-tcp-proxy-template** **Description** Reference a TCP Proxy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive **source-ip** **Description** Source IP persistence template (Source IP persistence template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** source-ip and shared-partition-persist-source-ip-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip ` **tcp-proxy** **Description** TCP Proxy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive **template-persist-source-ip-shared** **Description** Source IP Persistence Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip ` **template-tcp-proxy-shared** **Description** TCP Proxy Template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **timeout** **Description** Timeout value 1 - 200 in units of 200ms, default is 5 (default is 1000ms) (1 - 200 in units of 200ms, default is 5 (1000ms)) **Type:** number **Range:** 1-200 **Default:** 5 **type** **Description** 'skyfire-icap': Skyfire ICAP service; 'url-filter': URL filtering service; **Type:** string **Supported Values:** skyfire-icap, url-filter **Default:** url-filter **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 .. _3076_template_external-service-list_bypass-ip-cfg: template_external-service-list_bypass-ip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bypass-ip** **Description** ip address to bypass external service **Type:** string **Format:** ipv4-address **mask** **Description** IP prefix mask **Type:** string **Format:** ipv4-netmask .. _3076_template_external-service-list_request-header-forward-list: template_external-service-list_request-header-forward-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **request-header-forward** **Description** Request header to be forwarded to external service (Header Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_tcp-list: template_tcp-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **alive-if-active** **Description** keep connection alive if active traffic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **del-session-on-server-down** **Description** Delete session if the server/port goes down (either disabled/hm down) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** send reset to client when server is disabled **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disable and down are mutually exclusive **down** **Description** send reset to client when server is down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** down and disable are mutually exclusive **force-delete-timeout** **Description** The maximum time that a session can stay in the system before being delete (number (second)) **Type:** number **Range:** 1-31 **Mutual Exclusion:** force-delete-timeout and force-delete-timeout-100ms are mutually exclusive **force-delete-timeout-100ms** **Description** The maximum time that a session can stay in the system before being delete (number in 100ms) **Type:** number **Range:** 1-31 **Mutual Exclusion:** force-delete-timeout-100ms and force-delete-timeout are mutually exclusive **half-close-idle-timeout** **Description** TCP Half Close Idle Timeout (sec), default off (half close idle timeout in second, default off) **Type:** number **Range:** 60-120 **half-open-idle-timeout** **Description** TCP Half Open Idle Timeout (sec), default off (half open idle timeout in second, default off) **Type:** number **Range:** 1-60 **idle-timeout** **Description** Idle Timeout value (Interval of 60 seconds), default 120 seconds (idle timeout in second, default 120) **Type:** number **Range:** 1-2097151 **Default:** 120 **initial-window-size** **Description** Set the initial window size (number) **Type:** number **Range:** 1-65535 **insert-client-ip** **Description** Insert client ip into TCP option **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **lan-fast-ack** **Description** Enable fast TCP ack on LAN **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **logging** **Description** 'init': init only log; 'term': termination only log; 'both': both initial and termination log; **Type:** string **Supported Values:** init, term, both **name** **Description** Fast TCP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **proxy-header** **Description:** proxy-header is a **JSON Block**. Please see below for :ref:`3076_template_tcp-list_proxy-header` **Type:** Object **qos** **Description** QOS level (number) **Type:** number **Range:** 1-63 **re-select-if-server-down** **Description** re-select another server if service port is down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset-follow-fin** **Description** send reset to client or server upon receiving first fin **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset-fwd** **Description** send reset to server if error happens **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset-rev** **Description** send reset to client if error happens **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 .. _3076_template_tcp-list_proxy-header: template_tcp-list_proxy-header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **proxy-header-action** **Description** 'insert': Insert proxy header; **Type:** string **Supported Values:** insert **proxy-header-version** **Description** 'v1': version 1; 'v2': version 2; **Type:** string **Supported Values:** v1, v2 .. _3076_template_diameter-list: template_diameter-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **avp-code** **Description** avp code **Type:** number **Range:** 1-2147483647 **avp-list** **Type:** List **avp-string** **Description** pattern to be matched in the avp string name, max length 127 bytes **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **customize-cea** **Description** customizing cea response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dwr-time** **Description** dwr health-check timer interval (in 100 milli second unit, default is 100, 0 means unset this option) **Type:** number **Range:** 0-2147483647 **Default:** 100 **dwr-up-retry** **Description** number of successful dwr health-check before declaring target up **Type:** number **Range:** 1-7 **Default:** 3 **forward-to-latest-server** **Description** Forward client message to the latest server that sends message with the same session id **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-unknown-session-id** **Description** Forward server message even it has unknown session id **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **idle-timeout** **Description** user sesison idle timeout (in minutes, default is 5) **Type:** number **Range:** 1-65535 **Default:** 5 **load-balance-on-session-id** **Description** Load balance based on the session id **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **message-code-list** **Type:** List **multiple-origin-host** **Description** allowing multiple origin-host to a single server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** diameter template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **origin-host** **Description:** origin-host is a **JSON Block**. Please see below for :ref:`3076_template_diameter-list_origin-host` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/diameter/{name}/origin-host ` **origin-realm** **Description** origin-realm name avp **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters **product-name** **Description** product name avp **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters **relaxed-origin-host** **Description** Relaxed Origin-Host Format **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group-name** **Description** service group name, this is the service group that the message needs to be copied to **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **session-age** **Description** user session age allowed (default 10), this is not idle-time (in minutes) **Type:** number **Range:** 1-65535 **Default:** 10 **terminate-on-cca-t** **Description** remove diameter session when receiving CCA-T message **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 **vendor-id** **Description** vendor-id avp (Vendor Id) **Type:** number **Range:** 0-2147483647 **Default:** 0 .. _3076_template_diameter-list_message-code-list: template_diameter-list_message-code-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **message-code** **Description** **Type:** number **Range:** 1-2147483647 .. _3076_template_diameter-list_avp-list: template_diameter-list_avp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **avp** **Description** customize avps for cer to the server (avp number) **Type:** number **Range:** 0-2147483647 **int32** **Description** 32 bits integer **Type:** number **Range:** 0-2147483647 **Mutual Exclusion:** int32, int64, and string are mutually exclusive **int64** **Description** 64 bits integer **Type:** number **Range:** 0-2147483647 **Mutual Exclusion:** int64, int32, and string are mutually exclusive **mandatory** **Description** mandatory avp **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **string** **Description** String (string name, max length 127 bytes) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** string, int32, and int64 are mutually exclusive .. _3076_template_diameter-list_origin-host: template_diameter-list_origin-host ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **origin-host-name** **Description** origin-host name avp **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_udp-list: template_udp-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **age** **Description** short age (in sec), default is 31 **Type:** number **Range:** 1-31 **avp** **Description** '4': NAS-IP-address; '8': Framed-IP-Address; **Type:** string **Supported Values:** 4, 8 **disable-clear-session** **Description** Disable immediate clearing of session **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **idle-timeout** **Description** Idle Timeout value (Interval of 60 seconds), default 120 seconds (idle timeout in second, default 120) **Type:** number **Range:** 1-2097151 **Default:** 120 **immediate** **Description** Immediate Removal after Transaction **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** immediate and short are mutually exclusive **name** **Description** Fast UDP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **qos** **Description** QOS level (number) **Type:** number **Range:** 1-63 **radius-lb-method-hash-type** **Description** 'ip': IP-Hash; **Type:** string **Supported Values:** ip, ipv6 **re-select-if-server-down** **Description** re-select another server if service port is down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **short** **Description** Short lived session **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** short and immediate are mutually exclusive **stateless-conn-timeout** **Description** Stateless Current Connection Timeout value (5 - 120 seconds) (idle timeout in second, default 120) **Type:** number **Range:** 5-120 **Default:** 120 **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 **v6avp** **Description** '168': Framed-IPv6-Address; '97': Framed-IPv6-PrefixFramed-IPv6-Prefix; **Type:** string **Supported Values:** 168, 97 .. _3076_template_link-down-on-restart: template_link-down-on-restart ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_http-policy-list: template_http-policy-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cookie-name** **Description** name of cookie to match (Cookie Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **geo-location-match** **Type:** List **http-policy-match** **Type:** List **multi-match-rule-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/http-policy/{name}/multi-match-rule/{multi-match} ` **name** **Description** http-policy template name **Type:** string **Format:** string-rlx **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 .. _3076_template_http-policy-list_http-policy-match: template_http-policy-list_http-policy-match ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **match-string** **Description** URL String, use "[no-name]" for empty query-param-name match, use "[no-value]" for empty query-param-value match **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **match-type** **Description** 'contains': Select service group if URL string contains another string; 'ends-with': Select service group if URL string ends with another string; 'equals': Select service group if URL string equals another string; 'starts-with': Select service group if URL string starts with another string; **Type:** string **Supported Values:** contains, ends-with, equals, starts-with **service-group** **Description** Service Group to be used (Service Group Name) **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **type** **Description** 'cookie': cookie value match; 'host': hostname match; 'url': URL match; 'header-name': header name match; 'header-value': header value match; 'query-param-name': query parameter name; 'query-param-value': query parameter value; **Type:** string **Supported Values:** cookie, host, url, header-name, header-value, query-param-name, query-param-value .. _3076_template_http-policy-list_multi-match-rule-list: template_http-policy-list_multi-match-rule-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cookie-name-contains-string** **Description** Cookie value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **cookie-name-contains-type** **Description** 'contains': Cookie name contains string; **Type:** string **Supported Values:** contains **Mutual Exclusion:** cookie-name-contains-type,cookie-name-equals-type, cookie-name-starts-with-type, and cookie-name-ends-with-type are mutually exclusive **cookie-name-ends-with-string** **Description** Cookie name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **cookie-name-ends-with-type** **Description** 'ends-with': Cookie name ends-with string; **Type:** string **Supported Values:** ends-with **Mutual Exclusion:** cookie-name-ends-with-type,cookie-name-equals-type, cookie-name-contains-type, and cookie-name-starts-with-type are mutually exclusive **cookie-name-equals-string** **Description** Cookie name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **cookie-name-equals-type** **Description** 'equals': Cookie name equals to string; **Type:** string **Supported Values:** equals **Mutual Exclusion:** cookie-name-equals-type,cookie-name-contains-type, cookie-name-starts-with-type, and cookie-name-ends-with-type are mutually exclusive **cookie-name-starts-with-string** **Description** Cookie name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **cookie-name-starts-with-type** **Description** 'starts-with': Cookie name starts-with string; **Type:** string **Supported Values:** starts-with **Mutual Exclusion:** cookie-name-starts-with-type,cookie-name-equals-type, cookie-name-contains-type, and cookie-name-ends-with-type are mutually exclusive **cookie-value-contains-string** **Description** Cookie value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **cookie-value-contains-type** **Description** 'contains': Cookie value contains string; **Type:** string **Supported Values:** contains **Mutual Exclusion:** cookie-value-contains-type,cookie-value-equals-type, cookie-value-starts-with-type, and cookie-value-ends-with-type are mutually exclusive **cookie-value-ends-with-string** **Description** Cookie value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **cookie-value-ends-with-type** **Description** 'ends-with': Cookie value ends-with string; **Type:** string **Supported Values:** ends-with **Mutual Exclusion:** cookie-value-ends-with-type,cookie-value-equals-type, cookie-value-contains-type, and cookie-value-starts-with-type are mutually exclusive **cookie-value-equals-string** **Description** Cookie value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **cookie-value-equals-type** **Description** 'equals': Cookie value equals to string; **Type:** string **Supported Values:** equals **Mutual Exclusion:** cookie-value-equals-type,cookie-value-contains-type, cookie-value-starts-with-type, and cookie-value-ends-with-type are mutually exclusive **cookie-value-starts-with-string** **Description** Cookie value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **cookie-value-starts-with-type** **Description** 'starts-with': Cookie value starts-with string; **Type:** string **Supported Values:** starts-with **Mutual Exclusion:** cookie-value-starts-with-type,cookie-value-equals-type, cookie-value-contains-type, and cookie-value-ends-with-type are mutually exclusive **header-name-contains-string** **Description** Header name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-name-contains-type** **Description** 'contains': Header name contains string; **Type:** string **Supported Values:** contains **Mutual Exclusion:** header-name-contains-type,header-name-equals-type, header-name-starts-with-type, and header-name-ends-with-type are mutually exclusive **header-name-ends-with-string** **Description** Header name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-name-ends-with-type** **Description** 'ends-with': Header name ends-with string; **Type:** string **Supported Values:** ends-with **Mutual Exclusion:** header-name-ends-with-type,header-name-equals-type, header-name-contains-type, and header-name-starts-with-type are mutually exclusive **header-name-equals-string** **Description** Header name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-name-equals-type** **Description** 'equals': Header name equals to string; **Type:** string **Supported Values:** equals **Mutual Exclusion:** header-name-equals-type,header-name-contains-type, header-name-starts-with-type, and header-name-ends-with-type are mutually exclusive **header-name-starts-with-string** **Description** Header name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-name-starts-with-type** **Description** 'starts-with': Header name starts-with string; **Type:** string **Supported Values:** starts-with **Mutual Exclusion:** header-name-starts-with-type,header-name-equals-type, header-name-contains-type, and header-name-ends-with-type are mutually exclusive **header-value-contains-string** **Description** Header value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-value-contains-type** **Description** 'contains': Header value contains string; **Type:** string **Supported Values:** contains **Mutual Exclusion:** header-value-contains-type,header-value-equals-type, header-value-starts-with-type, and header-value-ends-with-type are mutually exclusive **header-value-ends-with-string** **Description** Header value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-value-ends-with-type** **Description** 'ends-with': Header value ends-with string; **Type:** string **Supported Values:** ends-with **Mutual Exclusion:** header-value-ends-with-type,header-value-equals-type, header-value-contains-type, and header-value-starts-with-type are mutually exclusive **header-value-equals-string** **Description** Header value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-value-equals-type** **Description** 'equals': Header value equals to string; **Type:** string **Supported Values:** equals **Mutual Exclusion:** header-value-equals-type,header-value-contains-type, header-value-starts-with-type, and header-value-ends-with-type are mutually exclusive **header-value-starts-with-string** **Description** Header value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-value-starts-with-type** **Description** 'starts-with': Header value starts-with string; **Type:** string **Supported Values:** starts-with **Mutual Exclusion:** header-value-starts-with-type,header-value-equals-type, header-value-contains-type, and header-value-ends-with-type are mutually exclusive **host-contains-string** **Description** Host string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **host-contains-type** **Description** 'contains': Host contains string; **Type:** string **Supported Values:** contains **Mutual Exclusion:** host-contains-type,host-equals-type, host-starts-with-type, and host-ends-with-type are mutually exclusive **host-ends-with-string** **Description** Host string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **host-ends-with-type** **Description** 'ends-with': Host ends-with string; **Type:** string **Supported Values:** ends-with **Mutual Exclusion:** host-ends-with-type,host-equals-type, host-contains-type, and host-starts-with-type are mutually exclusive **host-equals-string** **Description** Host string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **host-equals-type** **Description** 'equals': Host equals to string; **Type:** string **Supported Values:** equals **Mutual Exclusion:** host-equals-type,host-contains-type, host-starts-with-type, and host-ends-with-type are mutually exclusive **host-starts-with-string** **Description** Host string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **host-starts-with-type** **Description** 'starts-with': Host starts-with string; **Type:** string **Supported Values:** starts-with **Mutual Exclusion:** host-starts-with-type,host-equals-type, host-contains-type, and host-ends-with-type are mutually exclusive **multi-match** **Description** Specify a multi-match-rule name **Type:** string **Format:** string-rlx **Maximum Length:** 64 characters **Maximum Length:** 1 characters **query-param-name-contains-string** **Description** query parameter name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-param-name-contains-type** **Description** 'contains': query parameter name contains string; **Type:** string **Supported Values:** contains **Mutual Exclusion:** query-param-name-contains-type,query-param-name-equals-type, query-param-name-starts-with-type, and query-param-name-ends-with-type are mutually exclusive **query-param-name-ends-with-string** **Description** query parameter name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-param-name-ends-with-type** **Description** 'ends-with': query parameter name ends-with string; **Type:** string **Supported Values:** ends-with **Mutual Exclusion:** query-param-name-ends-with-type,query-param-name-equals-type, query-param-name-contains-type, and query-param-name-starts-with-type are mutually exclusive **query-param-name-equals-string** **Description** query parameter name string, use "[no-name]" for empty query-param-name match **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-param-name-equals-type** **Description** 'equals': query parameter name equals to string; **Type:** string **Supported Values:** equals **Mutual Exclusion:** query-param-name-equals-type,query-param-name-contains-type, query-param-name-starts-with-type, and query-param-name-ends-with-type are mutually exclusive **query-param-name-starts-with-string** **Description** query parameter name string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-param-name-starts-with-type** **Description** 'starts-with': query parameter name starts-with string; **Type:** string **Supported Values:** starts-with **Mutual Exclusion:** query-param-name-starts-with-type,query-param-name-equals-type, query-param-name-contains-type, and query-param-name-ends-with-type are mutually exclusive **query-param-value-contains-string** **Description** query parameter value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-param-value-contains-type** **Description** 'contains': query parameter value contains string; **Type:** string **Supported Values:** contains **Mutual Exclusion:** query-param-value-contains-type,query-param-value-equals-type, query-param-value-starts-with-type, and query-param-value-ends-with-type are mutually exclusive **query-param-value-ends-with-string** **Description** query parameter value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-param-value-ends-with-type** **Description** 'ends-with': query parameter value ends-with string; **Type:** string **Supported Values:** ends-with **Mutual Exclusion:** query-param-value-ends-with-type,query-param-value-equals-type, query-param-value-contains-type, and query-param-value-starts-with-type are mutually exclusive **query-param-value-equals-string** **Description** query parameter value string, use "[no-value]" for empty query-param-value match **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-param-value-equals-type** **Description** 'equals': query parameter value equals to string; **Type:** string **Supported Values:** equals **Mutual Exclusion:** query-param-value-equals-type,query-param-value-contains-type, query-param-value-starts-with-type, and query-param-value-ends-with-type are mutually exclusive **query-param-value-starts-with-string** **Description** query parameter value string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **query-param-value-starts-with-type** **Description** 'starts-with': query parameter value starts-with string; **Type:** string **Supported Values:** starts-with **Mutual Exclusion:** query-param-value-starts-with-type,query-param-value-equals-type, query-param-value-contains-type, and query-param-value-ends-with-type are mutually exclusive **seq-num** **Description** Specify a sequence number **Type:** number **Range:** 1-8192 **service-group** **Description** Service Group to be used (Service Group Name) **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **url-contains-string** **Description** URL string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **url-contains-type** **Description** 'contains': URL contains string; **Type:** string **Supported Values:** contains **Mutual Exclusion:** url-contains-type,url-equals-type, url-starts-with-type, and url-ends-with-type are mutually exclusive **url-ends-with-string** **Description** URL string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **url-ends-with-type** **Description** 'ends-with': URL ends-with string; **Type:** string **Supported Values:** ends-with **Mutual Exclusion:** url-ends-with-type,url-equals-type, url-contains-type, and url-starts-with-type are mutually exclusive **url-equals-string** **Description** URL string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **url-equals-type** **Description** 'equals': URL equals to string; **Type:** string **Supported Values:** equals **Mutual Exclusion:** url-equals-type,url-contains-type, url-starts-with-type, and url-ends-with-type are mutually exclusive **url-starts-with-string** **Description** URL string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **url-starts-with-type** **Description** 'starts-with': URL starts-with string; **Type:** string **Supported Values:** starts-with **Mutual Exclusion:** url-starts-with-type,url-equals-type, url-contains-type, and url-ends-with-type are mutually exclusive **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 .. _3076_template_http-policy-list_geo-location-match: template_http-policy-list_geo-location-match ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **geo-location** **Description** Geolocation name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **geo-location-service-group** **Description** Service Group to be used (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` .. _3076_template_link-probe-list: template_link-probe-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **destination** **Description:** destination is a **JSON Block**. Please see below for :ref:`3076_template_link-probe-list_destination` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/link-probe/{name}/destination ` **disable** **Description** Disable Probe template **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **expected-status-code** **Description** Specify response code range (e.g. 200,400-430), default is 200 (Format is xx,xx-xx (xx between [100, 899]), default is 200) **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters **Default:** 200 **name** **Description** probe template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **probe-interval** **Description** Time between each probe that needs to be sent out (in seconds, default is 5) **Type:** number **Range:** 1-7200 **Default:** 5 **probes-per-test** **Description** Total number of probes to be sent out for each test **Type:** number **Range:** 1-10 **Default:** 5 **rtt-method** **Description** 'http-rtt': Calculate Round Trip Time between HTTP request and response; 'tcp-srtt': Use TCP Smoothed round trip time in the HTTP connection; **Type:** string **Supported Values:** http-rtt, tcp-srtt **Default:** http-rtt **selection-rule** **Description** 'threshold': Use all links below a threshold before selecting the fastest link; 'fastest-link-always': Always use the link with the lowest average latency; **Type:** string **Supported Values:** threshold, fastest-link-always **Default:** fastest-link-always **test-interval** **Description** time interval between subsequent tests (in seconds, default is 60) **Type:** number **Range:** 1-7200 **Default:** 60 **threshold-value** **Description** Use all links below a threshold before selecting the fastest link (RTT in milliseconds) **Type:** number **Range:** 0-65534 **Default:** 0 **url** **Description** Specify URL to which probes should be sent out. Default is / **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **Default:** / **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 .. _3076_template_link-probe-list_destination: template_link-probe-list_destination ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **hostname** **Description** Target Hostname **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **resolve-as** **Description** 'resolve-to-ipv4': Use A Query only to resolve the configured hostname; 'resolve-to-ipv6': Use AAAA Query only to resolve the configured hostname; **Type:** string **Supported Values:** resolve-to-ipv4, resolve-to-ipv6 **Mutual Exclusion:** resolve-as, static-ipv4-addr, and static-ipv6-addr are mutually exclusive **static-ipv4-addr** **Description** Target IPv4 Address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** static-ipv4-addr, resolve-as, and static-ipv6-addr are mutually exclusive **static-ipv6-addr** **Description** Target IPv6 Address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** static-ipv6-addr, resolve-as, and static-ipv4-addr are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list: template_client-ssl-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ad-group-list** **Description** Forward proxy bypass if ad-group matches class-list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **alert-type** **Description** 'fatal': Log fatal alerts; **Type:** string **Supported Values:** fatal **auth-sg** **Description** Specify authorization LDAP service group **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** auth-sg and authen-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/aam/authentication/service-group ` **auth-sg-dn** **Description** Use Subject DN as LDAP search base DN **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **auth-sg-filter** **Description** Specify LDAP search filter **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **auth-username** **Description** Specify the Username Field in the Client Certificate(If multi-fields are specificed, prior one has higher priority) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **auth-username-attribute** **Description** Specify attribute name of username for client SSL authorization **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters **authen-name** **Description** Specify authorization LDAP server name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** authen-name and auth-sg are mutually exclusive **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/ldap ` **authorization** **Description** Specify LDAP server for client SSL authorizaiton **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bypass-cert-issuer-class-list-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bypass-cert-issuer-class-list-name and bypass-cert-issuer-multi-class-list-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/class-list ` **bypass-cert-issuer-multi-class-list** **Type:** List **bypass-cert-san-class-list-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bypass-cert-san-class-list-name and bypass-cert-san-multi-class-list-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/class-list ` **bypass-cert-san-multi-class-list** **Type:** List **bypass-cert-subject-class-list-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bypass-cert-subject-class-list-name and bypass-cert-subject-multi-class-list-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/class-list ` **bypass-cert-subject-multi-class-list** **Type:** List **ca-certs** **Type:** List **cache-persistence-list-name** **Description** Class List Name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **case-insensitive** **Description** Case insensitive forward proxy bypass **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **central-cert-pin-list** **Description** Forward proxy bypass if SNI string is contained in central updated cert-pinning-candidate list **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cert-revoke-action** **Description** 'bypass': bypass SSLi processing; 'continue': continue the connection; 'drop': close the connection; 'block': block the connection with a warning page; **Type:** string **Supported Values:** bypass, continue, drop, block **Default:** bypass **cert-unknown-action** **Description** 'bypass': bypass SSLi processing; 'continue': continue the connection; 'drop': close the connection; 'block': block the connection with a warning page; **Type:** string **Supported Values:** bypass, continue, drop, block **Default:** bypass **certificate-issuer-contains-list** **Type:** List **certificate-issuer-ends-with-list** **Type:** List **certificate-issuer-equals-list** **Type:** List **certificate-issuer-starts-with-list** **Type:** List **certificate-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssl/{name}/certificate/{cert} ` **certificate-san-contains-list** **Type:** List **certificate-san-ends-with-list** **Type:** List **certificate-san-equals-list** **Type:** List **certificate-san-starts-with-list** **Type:** List **certificate-subject-contains-list** **Type:** List **certificate-subject-ends-with-list** **Type:** List **certificate-subject-equals-list** **Type:** List **certificate-subject-starts-with-list** **Type:** List **chain-cert** **Description** Chain Certificate Name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **Mutual Exclusion:** chain-cert and chain-cert-shared-str are mutually exclusive **chain-cert-shared-str** **Description** Chain Certificate Name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **Mutual Exclusion:** chain-cert-shared-str and chain-cert are mutually exclusive **cipher-without-prio-list** **Type:** List **class-list-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** class-list-name and multi-clist-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/class-list ` **client-auth-case-insensitive** **Description** Case insensitive forward proxy client auth bypass **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-auth-class-list** **Description** Forward proxy client auth bypass if SNI string matches class-list (Class List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **client-auth-contains-list** **Type:** List **client-auth-ends-with-list** **Type:** List **client-auth-equals-list** **Type:** List **client-auth-starts-with-list** **Type:** List **client-certificate** **Description** 'Ignore': Don't request client certificate; 'Require': Require client certificate; 'Request': Request client certificate; **Type:** string **Supported Values:** Ignore, Require, Request **Default:** Ignore **client-ipv4-list** **Type:** List **client-ipv6-list** **Type:** List **close-notify** **Description** Send close notification when terminate connection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **contains-list** **Type:** List **crl-certs** **Type:** List **dgversion** **Description** Lower TLS/SSL version can be downgraded **Type:** number **Range:** 30-34 **Default:** 31 **dh-type** **Description** '1024': 1024; '1024-dsa': 1024-dsa; '2048': 2048; **Type:** string **Supported Values:** 1024, 1024-dsa, 2048 **direct-client-server-auth** **Description** Let backend server does SSL client authentication directly **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-sslv3** **Description** Reject Client requests for SSL version 3 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **early-data** **Description** Enable TLS 1.3 early data (0-RTT) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ec-list** **Type:** List **enable-ssli-ftp-alg** **Description** Enable SSLi FTP over TLS support at which port **Type:** number **Range:** 1-65535 **enable-tls-alert-logging** **Description** Enable TLS alert logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ends-with-list** **Type:** List **equals-list** **Type:** List **exception-ad-group-list** **Description** Exceptions to forward proxy bypass if ad-group matches class-list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **exception-certificate-issuer-cl-name** **Description** Exceptions to forward-proxy-bypass **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **exception-certificate-san-cl-name** **Description** Exceptions to forward-proxy-bypass **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **exception-certificate-subject-cl-name** **Description** Exceptions to forward-proxy-bypass **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **exception-client-ipv4-list** **Type:** List **exception-client-ipv6-list** **Type:** List **exception-server-ipv4-list** **Type:** List **exception-server-ipv6-list** **Type:** List **exception-sni-cl-name** **Description** Exceptions to forward-proxy-bypass **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **exception-user-name-list** **Description** Exceptions to forward proxy bypass if user-name matches class-list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **exception-web-category** **Description:** exception-web-category is a **JSON Block**. Please see below for :ref:`3076_template_client-ssl-list_exception-web-category` **Type:** Object **exception-web-reputation** **Description:** exception-web-reputation is a **JSON Block**. Please see below for :ref:`3076_template_client-ssl-list_exception-web-reputation` **Type:** Object **expire-hours** **Description** Certificate lifetime in hours **Type:** number **Range:** 1-168 **forward-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **Mutual Exclusion:** forward-encrypted and fp-ca-certificate are mutually exclusive **forward-passphrase** **Description** Password Phrase **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** forward-passphrase and fp-ca-certificate are mutually exclusive **forward-proxy-alt-sign** **Description** Forward proxy alternate signing cert and key **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-block-message** **Description** Message to be included on the block page (Message, enclose in quotes if spaces are present) **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **forward-proxy-ca-cert** **Description** CA Certificate for forward proxy (SSL forward proxy CA Certificate Name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **Mutual Exclusion:** forward-proxy-ca-cert,fp-ca-certificate, fp-ca-key, fp-ca-key-pass-phrase, fp-ca-key-passphrase, fp-ca-key-encrypted, fp-ca-chain-cert, and fp-ca-certificate-shared are mutually exclusive **forward-proxy-ca-key** **Description** CA Private Key for forward proxy (SSL forward proxy CA Key Name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **Mutual Exclusion:** forward-proxy-ca-key,fp-ca-certificate, fp-ca-key, fp-ca-key-pass-phrase, fp-ca-key-passphrase, fp-ca-key-encrypted, fp-ca-chain-cert, and fp-ca-certificate-shared are mutually exclusive **forward-proxy-cert-cache-limit** **Description** Certificate cache size limit, default is 524288 (set to 0 for unlimited size) **Type:** number **Range:** 0-2147483647 **Default:** 524288 **forward-proxy-cert-cache-timeout** **Description** Certificate cache timeout, default is 1 hour (seconds, set to 0 for never timeout) **Type:** number **Range:** 0-2147483647 **Default:** 3600 **forward-proxy-cert-expiry** **Description** Adjust certificate expiry relative to the time when it is created on the device **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-cert-not-ready-action** **Description** 'bypass': bypass the connection; 'reset': reset the connection; 'intercept': wait for cert and then inspect the connection; **Type:** string **Supported Values:** bypass, reset, intercept **Default:** bypass **forward-proxy-cert-revoke-action** **Description** Action taken if a certificate is irreversibly revoked, bypass SSLi processing by default **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **forward-proxy-cert-unknown-action** **Description** Action taken if a certificate revocation status is unknown, bypass SSLi processing by default **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **forward-proxy-crl-disable** **Description** Disable Certificate Revocation List checking for forward proxy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-decrypted-dscp** **Description** Apply a DSCP to decrypted and bypassed traffic (DSCP to apply to decrypted traffic) **Type:** number **Range:** 1-63 **forward-proxy-decrypted-dscp-bypass** **Description** DSCP to apply to bypassed traffic **Type:** number **Range:** 1-63 **forward-proxy-enable** **Description** Enable SSL forward proxy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** forward-proxy-enable and ssli-inbound-enable are mutually exclusive **forward-proxy-esni-action** **Description** Action taken if receiving encrypted server name indication extension in client hello MSG, bypass the connection by default **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-failsafe-disable** **Description** Disable Failsafe for SSL forward proxy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-hash-persistence-interval** **Description** Set the time interval to save the hash persistence certs (Interval value, in minutes) **Type:** number **Range:** 1-720 **Default:** 30 **forward-proxy-log-disable** **Description** Disable SSL forward proxy logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-no-shared-cipher-action** **Description** Action taken if handshake fails due to no shared ciper, close the connection by default **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **forward-proxy-no-sni-action** **Description** 'intercept': intercept in no SNI case; 'bypass': bypass in no SNI case; 'reset': reset in no SNI case; **Type:** string **Supported Values:** intercept, bypass, reset **Default:** intercept **forward-proxy-ocsp-disable** **Description** Disable ocsp-stapling for forward proxy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-require-sni-cert-matched** **Description** 'no-match-action-inspect': Inspected if not matched; 'no-match-action-drop': Dropped if not matched; **Type:** string **Supported Values:** no-match-action-inspect, no-match-action-drop **forward-proxy-selfsign-redir** **Description** Redirect connections to pages with self signed certs to a warning page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-ssl-version** **Description** TLS/SSL version, default is TLS1.2 (TLS/SSL version: 31-TLSv1.0, 32-TLSv1.1, 33-TLSv1.2 and 34-TLSv1.3) **Type:** number **Range:** 31-34 **Default:** 33 **forward-proxy-trusted-ca-lists** **Type:** List **forward-proxy-verify-cert-fail-action** **Description** Action taken if certificate verification fails, close the connection by default **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **fp-alt-cert** **Description** CA Certificate for forward proxy alternate signing (Certificate name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **fp-alt-chain-cert** **Description** Chain Certificate (Chain Certificate Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **fp-alt-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **fp-alt-key** **Description** CA Private Key for forward proxy alternate signing (Key name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **fp-alt-passphrase** **Description** Password Phrase **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **fp-alt-shared** **Description** Alternate CA Certificate and Private Key Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fp-ca-certificate** **Description** CA Certificate for forward proxy (SSL forward proxy CA Certificate Name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fp-ca-certificate,forward-proxy-ca-cert, fp-ca-shared, forward-proxy-ca-key, forward-passphrase, forward-encrypted, and fp-ca-key-shared are mutually exclusive **fp-ca-certificate-shared** **Description** CA Private Key Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** fp-ca-certificate-shared, forward-proxy-ca-cert, and forward-proxy-ca-key are mutually exclusive **fp-ca-chain-cert** **Description** Chain Certificate (Chain Certificate Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fp-ca-chain-cert, forward-proxy-ca-cert, and forward-proxy-ca-key are mutually exclusive **fp-ca-key** **Description** CA Private Key for forward proxy (SSL forward proxy CA Key Name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fp-ca-key, forward-proxy-ca-cert, and forward-proxy-ca-key are mutually exclusive **fp-ca-key-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **Mutual Exclusion:** fp-ca-key-encrypted, forward-proxy-ca-cert, and forward-proxy-ca-key are mutually exclusive **fp-ca-key-passphrase** **Description** Password Phrase **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fp-ca-key-passphrase, forward-proxy-ca-cert, and forward-proxy-ca-key are mutually exclusive **fp-ca-key-shared** **Description** CA Private Key Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** fp-ca-key-shared and fp-ca-certificate are mutually exclusive **fp-ca-shared** **Description** CA Certificate Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** fp-ca-shared and fp-ca-certificate are mutually exclusive **fp-cert-ext-aia-ca-issuers** **Description** CA Issuers (Authority Information Access URI) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fp-cert-ext-aia-ca-issuers and fp-cert-ext-aia-ocsp are mutually exclusive **fp-cert-ext-aia-ocsp** **Description** OCSP (Authority Information Access URI) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fp-cert-ext-aia-ocsp and fp-cert-ext-aia-ca-issuers are mutually exclusive **fp-cert-ext-crldp** **Description** CRL Distribution Point (CRL Distribution Point URI) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **fp-cert-fetch-autonat** **Description** 'auto': Configure auto NAT for server certificate fetching; **Type:** string **Supported Values:** auto **Mutual Exclusion:** fp-cert-fetch-autonat and fp-cert-fetch-natpool-name are mutually exclusive **fp-cert-fetch-autonat-precedence** **Description** Set this NAT pool as higher precedence than other source NAT like configued under template policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fp-cert-fetch-natpool-name** **Description** Specify NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fp-cert-fetch-natpool-name, shared-partition-pool, and fp-cert-fetch-autonat are mutually exclusive **fp-cert-fetch-natpool-name-shared** **Description** Specify NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **fp-cert-fetch-natpool-precedence** **Description** Set this NAT pool as higher precedence than other source NAT like configued under template policy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fp-esni-action** **Description** 'bypass': bypass SSLi processing; 'drop': close the connection; **Type:** string **Supported Values:** bypass, drop **Default:** bypass **handshake-logging-enable** **Description** Enable SSL handshake logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hsm-type** **Description** 'thales-embed': Thales embed key; 'thales-hwcrhk': Thales hwcrhk Key; **Type:** string **Supported Values:** thales-embed, thales-hwcrhk **inspect-certificate-issuer-cl-name** **Description** Forward proxy Inspect if Certificate issuer matches class-list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **inspect-certificate-san-cl-name** **Description** Forward proxy Inspect if Certificate Subject Alternative Name matches class-list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **inspect-certificate-subject-cl-name** **Description** Forward proxy Inspect if Certificate Subject matches class-list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **inspect-list-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **ja3-enable** **Description** Enable JA3 features **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ja3-insert-http-header** **Description** Insert the JA3 hash into this request as a HTTP header (HTTP Header Name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **ja3-reject-class-list** **Description** Drop request if the JA3 hash matches this class-list (type string-case-insensitive) (Class-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **ja3-reject-max-number-per-host** **Description** Drop request if numbers of JA3 of this client address exceeded **Type:** number **Range:** 1-256 **ja3-ttl** **Description** seconds to keep each JA3 record **Type:** number **Range:** 1-86400 **Default:** 600 **ldap-base-dn-from-cert** **Description** Use Subject DN as LDAP search base DN **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ldap-search-filter** **Description** Specify LDAP search filter **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **local-cert-pin-list** **Description:** local-cert-pin-list is a **JSON Block**. Please see below for :ref:`3076_template_client-ssl-list_local-cert-pin-list` **Type:** Object **local-logging** **Description** Enable local logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **multi-class-list** **Type:** List **name** **Description** Client SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **no-anti-replay** **Description** Disable anti-replay protection for TLS 1.3 early data (0-RTT data) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no-shared-cipher-action** **Description** 'bypass': bypass SSLi processing; 'drop': close the connection; **Type:** string **Supported Values:** bypass, drop **Default:** drop **non-ssl-bypass-l4session** **Description** Handle the non-ssl session as L4 for performance optimization **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **non-ssl-bypass-service-group** **Description** Service Group for Bypass non-ssl traffic (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **notafter** **Description** notAfter date **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **notafterday** **Description** Day **Type:** number **Range:** 1-31 **notaftermonth** **Description** Month **Type:** number **Range:** 1-12 **notafteryear** **Description** Year **Type:** number **Range:** 2005-2035 **notbefore** **Description** notBefore date **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **notbeforeday** **Description** Day **Type:** number **Range:** 1-31 **notbeforemonth** **Description** Month **Type:** number **Range:** 1-12 **notbeforeyear** **Description** Year **Type:** number **Range:** 2005-2035 **ocsp-stapling** **Description** Config OCSP stapling support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ocspst-ca-cert** **Description** CA certificate **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **ocspst-ocsp** **Description** Specify OCSP Authentication **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ocspst-sg** **Description** Specify authentication service group **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** ocspst-sg and ocspst-srvr are mutually exclusive **Reference Object:** :doc:`/axapi/v3/aam/authentication/service-group ` **ocspst-sg-days** **Description** Specify update period, in days **Type:** number **Range:** 1-31 **Mutual Exclusion:** ocspst-sg-days, ocspst-sg-hours, and ocspst-sg-minutes are mutually exclusive **ocspst-sg-hours** **Description** Specify update period, in hours **Type:** number **Range:** 1-23 **Default:** 1 **Mutual Exclusion:** ocspst-sg-hours, ocspst-sg-days, and ocspst-sg-minutes are mutually exclusive **ocspst-sg-minutes** **Description** Specify update period, in minutes **Type:** number **Range:** 1-59 **Mutual Exclusion:** ocspst-sg-minutes, ocspst-sg-days, and ocspst-sg-hours are mutually exclusive **ocspst-sg-timeout** **Description** Specify retry timeout (Default is 30 mins) **Type:** number **Range:** 1-44640 **Default:** 30 **ocspst-srvr** **Description** Specify OCSP authentication server **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** ocspst-srvr and ocspst-sg are mutually exclusive **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/ocsp ` **ocspst-srvr-days** **Description** Specify update period, in days **Type:** number **Range:** 1-31 **Mutual Exclusion:** ocspst-srvr-days, ocspst-srvr-hours, and ocspst-srvr-minutes are mutually exclusive **ocspst-srvr-hours** **Description** Specify update period, in hours **Type:** number **Range:** 1-23 **Default:** 1 **Mutual Exclusion:** ocspst-srvr-hours, ocspst-srvr-days, and ocspst-srvr-minutes are mutually exclusive **ocspst-srvr-minutes** **Description** Specify update period, in minutes **Type:** number **Range:** 1-59 **Mutual Exclusion:** ocspst-srvr-minutes, ocspst-srvr-days, and ocspst-srvr-hours are mutually exclusive **ocspst-srvr-timeout** **Description** Specify retry timeout (Default is 30 mins) **Type:** number **Range:** 1-44640 **Default:** 30 **renegotiation-disable** **Description** Disable SSL renegotiation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **req-ca-lists** **Type:** List **require-web-category** **Description** Wait for web category to be resolved before taking bypass decision **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-ipv4-list** **Type:** List **server-ipv6-list** **Type:** List **server-name-auto-map** **Description** Enable automatic mapping of server name indication in Client hello extension **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-name-list** **Type:** List **session-cache-size** **Description** Session Cache Size (Maximum cache size. Default value 0 (Session ID reuse disabled)) **Type:** number **session-cache-timeout** **Description** Session Cache Timeout (Timeout value, in seconds. Default value 0 (Session cache timeout disabled)) **Type:** number **Range:** 0-604800 **Default:** 0 **session-ticket-disable** **Description** Disable client side session ticket support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **session-ticket-lifetime** **Description** Session ticket lifetime in seconds from stateless session resumption (Lifetime value in seconds. Default value 0 (Session ticket lifetime is 7200 seconds)) **Type:** number **Range:** 0-2147483647 **Default:** 0 **shared-partition-cipher-template** **Description** Reference a cipher template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-cipher-template, template-cipher, and cipher-wo-prio are mutually exclusive **shared-partition-pool** **Description** Reference a NAT pool or pool group from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-pool and fp-cert-fetch-natpool-name are mutually exclusive **sni-bypass-enable-log** **Description** Enable logging when bypass event happens, disabled by default **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sni-bypass-expired-cert** **Description** Bypass when certificate expired **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sni-bypass-explicit-list** **Description** Bypass when matched explicit bypass list (Specify class list name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **sni-bypass-missing-cert** **Description** Bypass when missing cert/key **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sni-enable-log** **Description** Enable logging of sni-auto-map failures. Disable by default **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-false-start-disable** **Description** disable SSL False Start **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssli-inbound-enable** **Description** Enable inbound SSLi **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** ssli-inbound-enable and forward-proxy-enable are mutually exclusive **ssli-logging** **Description** SSLi logging level, default is error logging only **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sslilogging** **Description** 'disable': Disable all logging; 'all': enable all logging(error, info); **Type:** string **Supported Values:** disable, all **sslv2-bypass-service-group** **Description** Service Group for Bypass SSLV2 (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **starts-with-list** **Type:** List **template-cipher** **Description** Cipher Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-cipher, shared-partition-cipher-template, and cipher-wo-prio are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/cipher ` **template-cipher-shared** **Description** Cipher Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/cipher ` **template-hsm** **Description** HSM Template (HSM Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/hsm/template ` **user-name-list** **Description** Forward proxy bypass if user-name matches class-list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **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 **verify-cert-fail-action** **Description** 'bypass': bypass SSLi processing; 'continue': continue the connection; 'drop': close the connection; 'block': block the connection with a warning page; **Type:** string **Supported Values:** bypass, continue, drop, block **Default:** drop **version** **Description** TLS/SSL version, default is the highest number supported (TLS/SSL version: 30-SSLv3.0, 31-TLSv1.0, 32-TLSv1.1, 33-TLSv1.2 and 34-TLSv1.3) **Type:** number **Range:** 1-34 **web-category** **Description:** web-category is a **JSON Block**. Please see below for :ref:`3076_template_client-ssl-list_web-category` **Type:** Object **web-reputation** **Description:** web-reputation is a **JSON Block**. Please see below for :ref:`3076_template_client-ssl-list_web-reputation` **Type:** Object .. _3076_template_client-ssl-list_bypass-cert-subject-multi-class-list: template_client-ssl-list_bypass-cert-subject-multi-class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bypass-cert-subject-multi-class-list-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bypass-cert-subject-multi-class-list-name and bypass-cert-subject-class-list-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_certificate-san-contains-list: template_client-ssl-list_certificate-san-contains-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-san-contains** **Description** Forward proxy bypass if Certificate SAN contains another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_equals-list: template_client-ssl-list_equals-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **equals** **Description** Forward proxy bypass if SNI string equals another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_client-ipv6-list: template_client-ssl-list_client-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-ipv6-list-name** **Description** IPV6 client class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_forward-proxy-trusted-ca-lists: template_client-ssl-list_forward-proxy-trusted-ca-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **forward-proxy-trusted-ca** **Description** Forward proxy trusted CA file (CA file name) **Type:** string **Maximum Length:** 255 characters **Maximum Length:** 1 characters **fp-trusted-ca-shared** **Description** Trusted CA Certificate Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_client-ssl-list_ec-list: template_client-ssl-list_ec-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ec** **Description** 'secp256r1': X9_62_prime256v1; 'secp384r1': secp384r1; **Type:** string **Supported Values:** secp256r1, secp384r1 .. _3076_template_client-ssl-list_contains-list: template_client-ssl-list_contains-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **contains** **Description** Forward proxy bypass if SNI string contains another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_ends-with-list: template_client-ssl-list_ends-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ends-with** **Description** Forward proxy bypass if SNI string ends with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_ca-certs: template_client-ssl-list_ca-certs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ca-cert** **Description** CA Certificate (CA Certificate Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **ca-shared** **Description** CA Certificate Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-ocsp** **Description** Specify ocsp authentication server(s) for client certificate verification **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-ocsp-sg** **Description** Specify service-group (Service group name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/aam/authentication/service-group ` **client-ocsp-srvr** **Description** Specify authentication server **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/ocsp/instance ` .. _3076_template_client-ssl-list_client-auth-contains-list: template_client-ssl-list_client-auth-contains-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-auth-contains** **Description** Forward proxy bypass if SNI string contains another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_certificate-subject-contains-list: template_client-ssl-list_certificate-subject-contains-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-subject-contains** **Description** Forward proxy bypass if Certificate Subject contains another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_req-ca-lists: template_client-ssl-list_req-ca-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-cert-req-ca-shared** **Description** CA Certificate Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-certificate-Request-CA** **Description** Send CA lists in certificate request (CA Certificate Name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_certificate-subject-starts-with-list: template_client-ssl-list_certificate-subject-starts-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-subject-starts** **Description** Forward proxy bypass if Certificate Subject starts with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_web-reputation: template_client-ssl-list_web-reputation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bypass-low-risk** **Description** Bypass when reputation score is greater than or equal to 61 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** bypass-low-risk,bypass-trustworthy, bypass-moderate-risk, bypass-suspicious, bypass-malicious, and bypass-threshold are mutually exclusive **bypass-malicious** **Description** Bypass when reputation score is greater than or equal to 1 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** bypass-malicious,bypass-trustworthy, bypass-low-risk, bypass-moderate-risk, bypass-suspicious, and bypass-threshold are mutually exclusive **bypass-moderate-risk** **Description** Bypass when reputation score is greater than or equal to 41 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** bypass-moderate-risk,bypass-trustworthy, bypass-low-risk, bypass-suspicious, bypass-malicious, and bypass-threshold are mutually exclusive **bypass-suspicious** **Description** Bypass when reputation score is greater than or equal to 21 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** bypass-suspicious,bypass-trustworthy, bypass-low-risk, bypass-moderate-risk, bypass-malicious, and bypass-threshold are mutually exclusive **bypass-threshold** **Description** Bypass when reputation score is greater than or equal to the customized score (1-100) **Type:** number **Range:** 1-100 **Mutual Exclusion:** bypass-threshold,bypass-trustworthy, bypass-low-risk, bypass-moderate-risk, bypass-suspicious, and bypass-malicious are mutually exclusive **bypass-trustworthy** **Description** Bypass when reputation score is greater than or equal to 81 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** bypass-trustworthy,bypass-low-risk, bypass-moderate-risk, bypass-suspicious, bypass-malicious, and bypass-threshold are mutually exclusive .. _3076_template_client-ssl-list_bypass-cert-issuer-multi-class-list: template_client-ssl-list_bypass-cert-issuer-multi-class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bypass-cert-issuer-multi-class-list-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bypass-cert-issuer-multi-class-list-name and bypass-cert-issuer-class-list-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_client-auth-equals-list: template_client-ssl-list_client-auth-equals-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-auth-equals** **Description** Forward proxy bypass if SNI string equals another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_certificate-issuer-equals-list: template_client-ssl-list_certificate-issuer-equals-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-issuer-equals** **Description** Forward proxy bypass if Certificate issuer equals another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_certificate-san-ends-with-list: template_client-ssl-list_certificate-san-ends-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-san-ends-with** **Description** Forward proxy bypass if Certificate SAN ends with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_crl-certs: template_client-ssl-list_crl-certs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **crl** **Description** Certificate Revocation Lists (Certificate Revocation Lists file name) **Type:** string **Maximum Length:** 255 characters **Maximum Length:** 1 characters **crl-shared** **Description** Certificate Revocation Lists Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_client-ssl-list_certificate-list: template_client-ssl-list_certificate-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cert** **Description** Certificate Name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **chain-cert** **Description** Chain Certificate (Chain Certificate Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **key** **Description** Server Private Key (Key Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **key-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **passphrase** **Description** Password Phrase **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** Server Certificate and Key Partition Shared **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 .. _3076_template_client-ssl-list_client-ipv4-list: template_client-ssl-list_client-ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-ipv4-list-name** **Description** IPV4 client class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_multi-class-list: template_client-ssl-list_multi-class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **multi-clist-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** multi-clist-name and class-list-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_certificate-issuer-ends-with-list: template_client-ssl-list_certificate-issuer-ends-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-issuer-ends-with** **Description** Forward proxy bypass if Certificate issuer ends with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_exception-server-ipv4-list: template_client-ssl-list_exception-server-ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exception-server-ipv4-list-name** **Description** IPV4 exception server class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_web-category: template_client-ssl-list_web-category ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **abortion** **Description** Category Abortion **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **adult-and-pornography** **Description** Category Adult and Pornography **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **alcohol-and-tobacco** **Description** Category Alcohol and Tobacco **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **auctions** **Description** Category Auctions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bot-nets** **Description** Category Bot Nets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **business-and-economy** **Description** Category Business and Economy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cdns** **Description** Category CDNs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cheating** **Description** Category Cheating **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **computer-and-internet-info** **Description** Category Computer and Internet Info **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **computer-and-internet-security** **Description** Category Computer and Internet Security **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cult-and-occult** **Description** Category Cult and Occult **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dating** **Description** Category Dating **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dead-sites** **Description** Category Dead Sites (db Ops only) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **drugs** **Description** Category Abused Drugs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamically-generated-content** **Description** Dynamically Generated Content **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **educational-institutions** **Description** Category Educational Institutions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **entertainment-and-arts** **Description** Category Entertainment and Arts **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fashion-and-beauty** **Description** Category Fashion and Beauty **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **financial-services** **Description** Category Financial Services **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gambling** **Description** Category Gambling **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **games** **Description** Category Games **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **government** **Description** Category Government **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gross** **Description** Category Gross **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hacking** **Description** Category Hacking **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hate-and-racism** **Description** Category Hate and Racism **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **health-and-medicine** **Description** Category Health and Medicine **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **home-and-garden** **Description** Category Home and Garden **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hunting-and-fishing** **Description** Category Hunting and Fishing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **illegal** **Description** Category Illegal **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **illegal-pornography** **Description** Category Illegal join Adult and Pornography **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **image-and-video-search** **Description** Category Image and Video Search **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **internet-communications** **Description** Category Internet Communications **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **internet-portals** **Description** Category Internet Portals **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **job-search** **Description** Category Job Search **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **keyloggers-and-monitoring** **Description** Category Keyloggers and Monitoring **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **kids** **Description** Category Kids **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **legal** **Description** Category Legal **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **local-information** **Description** Category Local Information **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **malware-sites** **Description** Category Malware Sites **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **marijuana** **Description** Category Marijuana **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **military** **Description** Category Military **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **motor-vehicles** **Description** Category Motor Vehicles **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **music** **Description** Category Music **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **news-and-media** **Description** Category News and Media **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **nudity** **Description** Category Nudity **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **nudity-artistic** **Description** Category Nudity join Entertainment and Arts **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **online-greeting-cards** **Description** Category Online Greeting cards **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **parked-domains** **Description** Category Parked Domains **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pay-to-surf** **Description** Category Pay to Surf **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-to-peer** **Description** Category Peer to Peer **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **personal-sites-and-blogs** **Description** Category Personal sites and Blogs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **personal-storage** **Description** Category Personal Storage **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **philosophy-and-politics** **Description** Category Philosophy and Political Advocacy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **phishing-and-other-fraud** **Description** Category Phishing and Other Frauds **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **proxy-avoid-and-anonymizers** **Description** Category Proxy Avoid and Anonymizers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **questionable** **Description** Category Questionable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **real-estate** **Description** Category Real Estate **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **recreation-and-hobbies** **Description** Category Recreation and Hobbies **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reference-and-research** **Description** Category Reference and Research **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **religion** **Description** Category Religion **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **search-engines** **Description** Category Search Engines **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sex-education** **Description** Category Sex Education **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **shareware-and-freeware** **Description** Category Shareware and Freeware **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **shopping** **Description** Category Shopping **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **social-network** **Description** Category Social Network **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **society** **Description** Category Society **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **spam-urls** **Description** Category SPAM URLs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sports** **Description** Category Sports **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **spyware-and-adware** **Description** Category Spyware and Adware **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stock-advice-and-tools** **Description** Category Stock Advice and Tools **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **streaming-media** **Description** Category Streaming Media **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **swimsuits-and-intimate-apparel** **Description** Category Swimsuits and Intimate Apparel **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **training-and-tools** **Description** Category Training and Tools **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **translation** **Description** Category Translation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **travel** **Description** Category Travel **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uncategorized** **Description** Uncategorized URLs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **violence** **Description** Category Violence **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weapons** **Description** Category Weapons **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **web-advertisements** **Description** Category Web Advertisements **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **web-based-email** **Description** Category Web based email **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **web-hosting-sites** **Description** Category Web Hosting Sites **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_client-ssl-list_certificate-san-equals-list: template_client-ssl-list_certificate-san-equals-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-san-equals** **Description** Forward proxy bypass if Certificate SAN equals another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_exception-client-ipv4-list: template_client-ssl-list_exception-client-ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exception-client-ipv4-list-name** **Description** IPV4 exception client class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_certificate-issuer-contains-list: template_client-ssl-list_certificate-issuer-contains-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-issuer-contains** **Description** Forward proxy bypass if Certificate issuer contains another string (Certificate issuer) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_client-auth-starts-with-list: template_client-ssl-list_client-auth-starts-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-auth-starts-with** **Description** Forward proxy bypass if SNI string starts with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_certificate-subject-ends-with-list: template_client-ssl-list_certificate-subject-ends-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-subject-ends-with** **Description** Forward proxy bypass if Certificate Subject ends with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_bypass-cert-san-multi-class-list: template_client-ssl-list_bypass-cert-san-multi-class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bypass-cert-san-multi-class-list-name** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bypass-cert-san-multi-class-list-name and bypass-cert-san-class-list-name are mutually exclusive **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_server-name-list: template_client-ssl-list_server-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **server-cert** **Description** Server Certificate associated to SNI (Server Certificate Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **server-cert-regex** **Description** Server Certificate associated to SNI regex (Server Certificate Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **server-chain** **Description** Server Certificate Chain associated to SNI (Server Certificate Chain Name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **server-chain-regex** **Description** Server Certificate Chain associated to SNI regex (Server Certificate Chain Name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **server-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **server-encrypted-regex** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **server-key** **Description** Server Private Key associated to SNI (Server Private Key Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **server-key-regex** **Description** Server Private Key associated to SNI regex (Server Private Key Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **server-name** **Description** Server name indication in Client hello extension (Server name String) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **server-name-alternate** **Description** Specific the second certifcate **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-name-regex** **Description** Server name indication in Client hello extension with regular expression (Server name String with regex) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **server-name-regex-alternate** **Description** Specific the second certifcate **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-passphrase** **Description** help Password Phrase **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **server-passphrase-regex** **Description** help Password Phrase **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **server-shared** **Description** Server Name Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-shared-regex** **Description** Server Name Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sni-regex-shared-partition-client-ssl-template** **Description** Reference a Client SSL template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sni-regex-template** **Description** Template associated to SNI regex **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sni-regex-template-client-ssl** **Description** Client SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssl ` **sni-regex-template-client-ssl-shared-name** **Description** Client SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssl ` **sni-shared-partition-client-ssl-template** **Description** Reference a Client SSL template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sni-template** **Description** Template associated to SNI **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sni-template-client-ssl** **Description** Client SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssl ` **sni-template-client-ssl-shared-name** **Description** Client SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssl ` .. _3076_template_client-ssl-list_exception-web-category: template_client-ssl-list_exception-web-category ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **exception-abortion** **Description** Category Abortion **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-adult-and-pornography** **Description** Category Adult and Pornography **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-alcohol-and-tobacco** **Description** Category Alcohol and Tobacco **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-auctions** **Description** Category Auctions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-bot-nets** **Description** Category Bot Nets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-business-and-economy** **Description** Category Business and Economy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-cdns** **Description** Category CDNs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-cheating** **Description** Category Cheating **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-computer-and-internet-info** **Description** Category Computer and Internet Info **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-computer-and-internet-security** **Description** Category Computer and Internet Security **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-cult-and-occult** **Description** Category Cult and Occult **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-dating** **Description** Category Dating **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-dead-sites** **Description** Category Dead Sites (db Ops only) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-drugs** **Description** Category Abused Drugs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-dynamically-generated-content** **Description** Dynamically Generated Content **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-educational-institutions** **Description** Category Educational Institutions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-entertainment-and-arts** **Description** Category Entertainment and Arts **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-fashion-and-beauty** **Description** Category Fashion and Beauty **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-financial-services** **Description** Category Financial Services **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-gambling** **Description** Category Gambling **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-games** **Description** Category Games **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-government** **Description** Category Government **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-gross** **Description** Category Gross **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-hacking** **Description** Category Hacking **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-hate-and-racism** **Description** Category Hate and Racism **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-health-and-medicine** **Description** Category Health and Medicine **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-home-and-garden** **Description** Category Home and Garden **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-hunting-and-fishing** **Description** Category Hunting and Fishing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-illegal** **Description** Category Illegal **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-illegal-pornography** **Description** Category Illegal join Adult and Pornography **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-image-and-video-search** **Description** Category Image and Video Search **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-internet-communications** **Description** Category Internet Communications **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-internet-portals** **Description** Category Internet Portals **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-job-search** **Description** Category Job Search **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-keyloggers-and-monitoring** **Description** Category Keyloggers and Monitoring **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-kids** **Description** Category Kids **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-legal** **Description** Category Legal **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-local-information** **Description** Category Local Information **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-malware-sites** **Description** Category Malware Sites **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-marijuana** **Description** Category Marijuana **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-military** **Description** Category Military **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-motor-vehicles** **Description** Category Motor Vehicles **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-music** **Description** Category Music **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-news-and-media** **Description** Category News and Media **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-nudity** **Description** Category Nudity **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-nudity-artistic** **Description** Category Nudity join Entertainment and Arts **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-online-greeting-cards** **Description** Category Online Greeting cards **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-parked-domains** **Description** Category Parked Domains **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-pay-to-surf** **Description** Category Pay to Surf **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-peer-to-peer** **Description** Category Peer to Peer **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-personal-sites-and-blogs** **Description** Category Personal sites and Blogs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-personal-storage** **Description** Category Personal Storage **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-philosophy-and-politics** **Description** Category Philosophy and Political Advocacy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-phishing-and-other-fraud** **Description** Category Phishing and Other Frauds **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-proxy-avoid-and-anonymizers** **Description** Category Proxy Avoid and Anonymizers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-questionable** **Description** Category Questionable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-real-estate** **Description** Category Real Estate **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-recreation-and-hobbies** **Description** Category Recreation and Hobbies **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-reference-and-research** **Description** Category Reference and Research **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-religion** **Description** Category Religion **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-search-engines** **Description** Category Search Engines **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-sex-education** **Description** Category Sex Education **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-shareware-and-freeware** **Description** Category Shareware and Freeware **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-shopping** **Description** Category Shopping **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-social-network** **Description** Category Social Network **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-society** **Description** Category Society **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-spam-urls** **Description** Category SPAM URLs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-sports** **Description** Category Sports **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-spyware-and-adware** **Description** Category Spyware and Adware **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-stock-advice-and-tools** **Description** Category Stock Advice and Tools **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-streaming-media** **Description** Category Streaming Media **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-swimsuits-and-intimate-apparel** **Description** Category Swimsuits and Intimate Apparel **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-training-and-tools** **Description** Category Training and Tools **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-translation** **Description** Category Translation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-travel** **Description** Category Travel **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-uncategorized** **Description** Uncategorized URLs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-violence** **Description** Category Violence **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-weapons** **Description** Category Weapons **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-web-advertisements** **Description** Category Web Advertisements **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-web-based-email** **Description** Category Web based email **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exception-web-hosting-sites** **Description** Category Web Hosting Sites **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_client-ssl-list_exception-server-ipv6-list: template_client-ssl-list_exception-server-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exception-server-ipv6-list-name** **Description** IPV6 exception server class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_certificate-issuer-starts-with-list: template_client-ssl-list_certificate-issuer-starts-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-issuer-starts** **Description** Forward proxy bypass if Certificate issuer starts with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_certificate-san-starts-with-list: template_client-ssl-list_certificate-san-starts-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-san-starts** **Description** Forward proxy bypass if Certificate SAN starts with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_server-ipv4-list: template_client-ssl-list_server-ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **server-ipv4-list-name** **Description** IPV4 server class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_client-auth-ends-with-list: template_client-ssl-list_client-auth-ends-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-auth-ends-with** **Description** Forward proxy bypass if SNI string ends with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_exception-client-ipv6-list: template_client-ssl-list_exception-client-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exception-client-ipv6-list-name** **Description** IPV6 exception client class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_exception-web-reputation: template_client-ssl-list_exception-web-reputation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **exception-low-risk** **Description** Intercept when reputation score is less than or equal to 80 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** exception-low-risk,exception-trustworthy, exception-moderate-risk, exception-suspicious, exception-malicious, and exception-threshold are mutually exclusive **exception-malicious** **Description** Intercept when reputation score is less than or equal to 20 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** exception-malicious,exception-trustworthy, exception-low-risk, exception-moderate-risk, exception-suspicious, and exception-threshold are mutually exclusive **exception-moderate-risk** **Description** Intercept when reputation score is less than or equal to 60 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** exception-moderate-risk,exception-trustworthy, exception-low-risk, exception-suspicious, exception-malicious, and exception-threshold are mutually exclusive **exception-suspicious** **Description** Intercept when reputation score is less than or equal to 40 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** exception-suspicious,exception-trustworthy, exception-low-risk, exception-moderate-risk, exception-malicious, and exception-threshold are mutually exclusive **exception-threshold** **Description** Intercept when reputation score is less than or equal to a customized value (1-100) **Type:** number **Range:** 1-100 **Mutual Exclusion:** exception-threshold,exception-trustworthy, exception-low-risk, exception-moderate-risk, exception-suspicious, and exception-malicious are mutually exclusive **exception-trustworthy** **Description** Intercept when reputation score is less than or equal to 100 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** exception-trustworthy,exception-low-risk, exception-moderate-risk, exception-suspicious, exception-malicious, and exception-threshold are mutually exclusive .. _3076_template_client-ssl-list_local-cert-pin-list: template_client-ssl-list_local-cert-pin-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **local-cert-pin-list-bypass-fail-count** **Description** Set the connection fail count as bypass criteria (Bypass when connection failure count is greater than the criteria (1-65536)) **Type:** number **Range:** 1-65536 .. _3076_template_client-ssl-list_server-ipv6-list: template_client-ssl-list_server-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **server-ipv6-list-name** **Description** IPV6 server class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_client-ssl-list_certificate-subject-equals-list: template_client-ssl-list_certificate-subject-equals-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **certificate-subject-equals** **Description** Forward proxy bypass if Certificate Subject equals another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_client-ssl-list_cipher-without-prio-list: template_client-ssl-list_cipher-without-prio-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cipher-wo-prio** **Description** 'SSL3_RSA_DES_192_CBC3_SHA': TLS_RSA_WITH_3DES_EDE_CBC_SHA (0x000A); 'SSL3_RSA_RC4_128_MD5': TLS_RSA_WITH_RC4_128_MD5 (0x0004); 'SSL3_RSA_RC4_128_SHA': TLS_RSA_WITH_RC4_128_SHA (0x0005); 'TLS1_RSA_AES_128_SHA': TLS_RSA_WITH_AES_128_CBC_SHA (0x002F); 'TLS1_RSA_AES_256_SHA': TLS_RSA_WITH_AES_256_CBC_SHA (0x0035); 'TLS1_RSA_AES_128_SHA256': TLS_RSA_WITH_AES_128_CBC_SHA256 (0x003C); 'TLS1_RSA_AES_256_SHA256': TLS_RSA_WITH_AES_256_CBC_SHA256 (0x003D); 'TLS1_DHE_RSA_AES_128_GCM_SHA256': TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (0x009E); 'TLS1_DHE_RSA_AES_128_SHA': TLS_DHE_RSA_WITH_AES_128_CBC_SHA (0x0033); 'TLS1_DHE_RSA_AES_128_SHA256': TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 (0x0067); 'TLS1_DHE_RSA_AES_256_GCM_SHA384': TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (0x009F); 'TLS1_DHE_RSA_AES_256_SHA': TLS_DHE_RSA_WITH_AES_256_CBC_SHA (0x0039); 'TLS1_DHE_RSA_AES_256_SHA256': TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 (0x006B); 'TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 (0xC02B); 'TLS1_ECDHE_ECDSA_AES_128_SHA': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA (0xC009); 'TLS1_ECDHE_ECDSA_AES_128_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 (0xC023); 'TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 (0xC02C); 'TLS1_ECDHE_ECDSA_AES_256_SHA': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA (0xC00A); 'TLS1_ECDHE_RSA_AES_128_GCM_SHA256': TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xC02F); 'TLS1_ECDHE_RSA_AES_128_SHA': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (0xC013); 'TLS1_ECDHE_RSA_AES_128_SHA256': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (0xC027); 'TLS1_ECDHE_RSA_AES_256_GCM_SHA384': TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xC030); 'TLS1_ECDHE_RSA_AES_256_SHA': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (0xC014); 'TLS1_RSA_AES_128_GCM_SHA256': TLS_RSA_WITH_AES_128_GCM_SHA256 (0x009C); 'TLS1_RSA_AES_256_GCM_SHA384': TLS_RSA_WITH_AES_256_GCM_SHA384 (0x009D); 'TLS1_ECDHE_RSA_AES_256_SHA384': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (0xC028); 'TLS1_ECDHE_ECDSA_AES_256_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 (0xC024); 'TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA8); 'TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA9); 'TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256': TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCAA); **Type:** string **Supported Values:** SSL3_RSA_DES_192_CBC3_SHA, SSL3_RSA_RC4_128_MD5, SSL3_RSA_RC4_128_SHA, TLS1_RSA_AES_128_SHA, TLS1_RSA_AES_256_SHA, TLS1_RSA_AES_128_SHA256, TLS1_RSA_AES_256_SHA256, TLS1_DHE_RSA_AES_128_GCM_SHA256, TLS1_DHE_RSA_AES_128_SHA, TLS1_DHE_RSA_AES_128_SHA256, TLS1_DHE_RSA_AES_256_GCM_SHA384, TLS1_DHE_RSA_AES_256_SHA, TLS1_DHE_RSA_AES_256_SHA256, TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256, TLS1_ECDHE_ECDSA_AES_128_SHA, TLS1_ECDHE_ECDSA_AES_128_SHA256, TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384, TLS1_ECDHE_ECDSA_AES_256_SHA, TLS1_ECDHE_RSA_AES_128_GCM_SHA256, TLS1_ECDHE_RSA_AES_128_SHA, TLS1_ECDHE_RSA_AES_128_SHA256, TLS1_ECDHE_RSA_AES_256_GCM_SHA384, TLS1_ECDHE_RSA_AES_256_SHA, TLS1_RSA_AES_128_GCM_SHA256, TLS1_RSA_AES_256_GCM_SHA384, TLS1_ECDHE_RSA_AES_256_SHA384, TLS1_ECDHE_ECDSA_AES_256_SHA384, TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256, TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256, TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256 **Mutual Exclusion:** cipher-wo-prio, template-cipher, and shared-partition-cipher-template are mutually exclusive .. _3076_template_client-ssl-list_starts-with-list: template_client-ssl-list_starts-with-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **starts-with** **Description** Forward proxy bypass if SNI string starts with another string **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_quic-list: template_quic-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **burst-len** **Description** Number of burst packet, default 16 **Type:** number **Range:** 16-360 **connection-id-length** **Description** Connection id length in byte, default 8 bytes **Type:** number **Range:** 1-20 **idle-timeout** **Description** Idle Timeout (interval of 60 seconds), default 120 seconds (idle timeout in second, default 120) **Type:** number **Range:** 1-3600 **initial-wnd** **Description** Initial window size in byte, default 10000 (Initial window size, default 10000) **Type:** number **Range:** 10000-100000 **key-update-to-client** **Description** Initiate key update on the client-side **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **key-update-to-server** **Description** Initiate key update on the server-side **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** QUIC Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **receive-buffer** **Description** Receive buffer size in byte, default 200000 (Receive buffer size, default 200000) **Type:** number **Range:** 30000-400000 **server-retry** **Description** Enable server retry **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 .. _3076_template_link-block-as-down: template_link-block-as-down ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dynamic-service-list: template_dynamic-service-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **class-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dynamic-service/{name}/class-list/{dns-class-list} ` **dns-server** **Type:** List **name** **Description** Dynamic Service Template Name **Type:** string **Format:** string-rlx **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 .. _3076_template_dynamic-service-list_dns-server: template_dynamic-service-list_dns-server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-dns-server** **Description** DNS Server IPv4 Address **Type:** string **Format:** ipv4-address **ipv6-dns-server** **Description** DNS Server IPv6 Address **Type:** string **Format:** ipv6-address .. _3076_template_dynamic-service-list_class-list-list: template_dynamic-service-list_class-list-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dns-class-list** **Description** Name of Aho-Corasick class-list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dns-server** **Type:** List **priority** **Description** Priority of the class-list(the larger number, the higher priority) **Type:** number **Range:** 1-64 **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 .. _3076_template_dynamic-service-list_class-list-list_dns-server: template_dynamic-service-list_class-list-list_dns-server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-dns-server** **Description** DNS Server IPv4 Address **Type:** string **Format:** ipv4-address **ipv6-dns-server** **Description** DNS Server IPv6 Address **Type:** string **Format:** ipv6-address .. _3076_template_dblb-list: template_dblb-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **calc-sha1** **Description:** calc-sha1 is a **JSON Block**. Please see below for :ref:`3076_template_dblb-list_calc-sha1` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dblb/{name}/calc-sha1 ` **class-list** **Description** Specify user/password string class list (Class list name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **name** **Description** DBLB template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **server-version** **Description** 'MSSQL2008': MSSQL server 2008 or 2008 R2; 'MSSQL2012': MSSQL server 2012; 'MySQL': MySQL server (any version); **Type:** string **Supported Values:** MSSQL2008, MSSQL2012, MySQL **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 .. _3076_template_dblb-list_calc-sha1: template_dblb-list_calc-sha1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sha1-value** **Description** Cleartext password **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_fix-list: template_fix-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **insert-client-ip** **Description** Insert client ip to tag 11447 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **logging** **Description** 'init': init only log; 'term': termination only log; 'both': both initial and termination log; **Type:** string **Supported Values:** init, term, both **name** **Description** FIX Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **tag-switching** **Type:** List **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 .. _3076_template_fix-list_tag-switching: template_fix-list_tag-switching ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **equals** **Description** Equals (Tag String) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **service-group** **Description** Create a Service Group comprising Servers (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **switching-type** **Description** 'sender-comp-id': Select service group based on SenderCompID; 'target-comp-id': Select service group based on TargetCompID; **Type:** string **Supported Values:** sender-comp-id, target-comp-id .. _3076_template_persist: template_persist ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cookie-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/persist/cookie/{name} ` **destination-ip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/persist/destination-ip/{name} ` **source-ip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip/{name} ` **ssl-sid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/persist/ssl-sid/{name} ` .. _3076_template_persist_destination-ip-list: template_persist_destination-ip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dont-honor-conn-rules** **Description** Do not observe connection rate rules **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hash-persist** **Description** Use hash value of destination IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-type** **Description** Persistence type **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** Destination IP persistence template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **netmask** **Description** IP subnet mask **Type:** string **Format:** ipv4-netmask **Default:** 255.255.255.255 **netmask6** **Description** IPV6 subnet mask **Type:** number **Range:** 1-128 **Default:** 128 **scan-all-members** **Description** Persist with SCAN of all members **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server** **Description** Persist to the same server, default is port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** server and service-group are mutually exclusive **service-group** **Description** Persist within the same service group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** service-group and server are mutually exclusive **timeout** **Description** Persistence timeout (in minutes) **Type:** number **Range:** 1-2000 **Default:** 5 **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 .. _3076_template_persist_source-ip-list: template_persist_source-ip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dont-honor-conn-rules** **Description** Do not observe connection rate rules **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enforce-higher-priority** **Description** Enforce to use high priority node if available **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hash-persist** **Description** Use hash value of source IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **incl-dst-ip** **Description** Include destination IP on the persist **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **incl-sport** **Description** Include source port on the persist **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-type** **Description** Persistence type **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** Source IP persistence template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **netmask** **Description** IP subnet mask **Type:** string **Format:** ipv4-netmask **Default:** 255.255.255.255 **netmask6** **Description** IPV6 subnet mask **Type:** number **Range:** 1-128 **Default:** 128 **primary-port** **Description** Primary port to create the persist session **Type:** number **Range:** 1-65534 **scan-all-members** **Description** Persist with SCAN of all members **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server** **Description** Persist to the same server, default is port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** server and service-group are mutually exclusive **service-group** **Description** Persist within the same service group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** service-group and server are mutually exclusive **timeout** **Description** Persistence timeout (in minutes) **Type:** number **Range:** 1-4321 **Default:** 5 **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 .. _3076_template_persist_cookie-list: template_persist_cookie-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cookie-name** **Description** Set cookie name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** sto-id **domain** **Description** Set cookie domain **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dont-honor-conn-rules** **Description** Do not observe connection rate rules **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **encrypt-level** **Description** Encryption level for cookie name / value **Type:** number **Range:** 0-1 **Default:** 1 **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **expire** **Description** Set cookie expiration time (Expiration in seconds) **Type:** number **Range:** 0-31536000 **Default:** 31536000 **httponly** **Description** Enable HttpOnly attribute **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **insert-always** **Description** Insert persist cookie to every reponse **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-type** **Description** Persist for server, default is port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** Cookie persistence (Cookie persistence template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **pass-phrase** **Description** Set passphrase for encryption **Type:** string **Format:** password **Maximum Length:** 8 characters **Maximum Length:** 8 characters **Default:** ACOS4KEY **pass-thru** **Description** Pass thru mode - Server sends the persist cookie **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **path** **Description** Set cookie path (Cookie path, default is "/") **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters **Default:** / **prefix** **Description** 'host': the cookie will have been set with a Secure attribute, a Path attribute with a value of /, and no Domain attribute; 'secure': the cookie will have been set with a Secure attribute; **Type:** string **Supported Values:** host, secure **samesite** **Description** 'none': none; 'lax': lax; 'strict': strict; **Type:** string **Supported Values:** none, lax, strict **scan-all-members** **Description** Persist within the same server SCAN **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **secure** **Description** Enable secure attribute **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server** **Description** Persist to the same server, default is port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** server and service-group are mutually exclusive **server-service-group** **Description** Persist to the same server and within the same service group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group** **Description** Persist within the same service group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** service-group and server are mutually exclusive **use-attribute** **Description** 'max-age': Use the Max-Age attribute; 'expires': Use the Expires attribute; 'all': Use all attributes; **Type:** string **Supported Values:** max-age, expires, all **Default:** expires **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 .. _3076_template_persist_ssl-sid-list: template_persist_ssl-sid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dont-honor-conn-rules** **Description** Do not observe connection rate rules **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** SSL session ID persistence template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **timeout** **Description** Persistence timeout (in minutes) **Type:** number **Range:** 1-2000 **Default:** 5 **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 .. _3076_template_doh-list: template_doh-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **conn-reuse** **Description** 'enable': Enable Connection Reuse; 'disable': Disable Connection-Reuse (Default); **Type:** string **Supported Values:** enable, disable **Default:** disable **dns** **Description** DNS Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Mutual Exclusion:** dns and shared-partition-dns-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/dns ` **dns-retry** **Description:** dns-retry is a **JSON Block**. Please see below for :ref:`3076_template_doh-list_dns-retry` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/doh/{name}/dns-retry ` **forwarder** **Description:** forwarder is a **JSON Block**. Please see below for :ref:`3076_template_doh-list_forwarder` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/doh/{name}/forwarder ` **name** **Description** DNS over HTTP(s) Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **non-dns-request** **Description** 'allow': Forward Non-DoH request to http server bound to vport; 'reject': Reject Non-DoH requests with HTTP 400 Bad Request (Default); **Type:** string **Supported Values:** allow, reject **Default:** reject **reject-status-code** **Description** '400': Status Code 400 BAD Request (Default); '500': Status Code 500 Internal Server Error; '501': Status Code 501 Not Implemented; **Type:** string **Supported Values:** 400, 500, 501 **Default:** 400 **shared-partition-dns-template** **Description** Reference a DNS template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-dns-template and dns are mutually exclusive **shared-partition-tcp-proxy-template** **Description** Reference a TCP Proxy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive **snat-pool** **Description** Source NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **source-nat** **Description** 'auto': Perform Source NAT Auto for service-group(Default) (Not supported with forwarding-ip); 'disable': Don't perform source-nat for server side DNS queries; 'pool': Perform Source NAT with specific pool; **Type:** string **Supported Values:** auto, disable, pool **Default:** auto **tcp-proxy** **Description** TCP Proxy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Mutual Exclusion:** tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **template-dns-shared** **Description** DNS Template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/dns ` **template-tcp-proxy-shared** **Description** TCP Proxy Template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **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 .. _3076_template_doh-list_forwarder: template_doh-list_forwarder ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bypass-doh** **Description** Forward valid DoH HTTP request as is, no DNS packet extraction (Bypass DoH) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** bypass-doh,forwarding-ipv4, forwarding-ipv6, tcp-service-group, and udp-service-group are mutually exclusive **forwarding-ipv4** **Description** SLB VIP IPv4 address to forward DOH query (IP address) **Type:** string **Format:** ipv4-address **Mutual Exclusion:** forwarding-ipv4,forwarding-ipv6, tcp-service-group, udp-service-group, and bypass-doh are mutually exclusive **forwarding-ipv6** **Description** SLB VIP IPv6 address to forward DOH query (IP address) **Type:** string **Format:** ipv6-address **Mutual Exclusion:** forwarding-ipv6,forwarding-ipv4, tcp-service-group, udp-service-group, and bypass-doh are mutually exclusive **tcp-service-group** **Description** Bind a TCP Service Group to the template (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** tcp-service-group,forwarding-ipv4, forwarding-ipv6, and bypass-doh are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **udp-service-group** **Description** Bind a UDP Service Group to the template (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** udp-service-group,forwarding-ipv4, forwarding-ipv6, and bypass-doh are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **v4-internal** **Description** Try to find this IP as a VIP in this L3v Partition and forward it internally to the VIP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **v4-l4-proto** **Description** 'tcp': Use TCP only when forwarding DNS traffic; 'udp': Use UDP only when forwarding DNS traffic; 'both': Use UDP 1st and if unreachable, retry with TCP when forwarding DNS traffic; **Type:** string **Supported Values:** tcp, udp, both **Default:** both **v4-port** **Description** Forwarding port number, Default is 53 **Type:** number **Range:** 1-65534 **Default:** 53 **v6-internal** **Description** Try to find this IP as a VIP in this L3v Partition and forward it internally to the VIP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **v6-l4-proto** **Description** 'tcp': Use TCP only when forwarding DNS traffic; 'udp': Use UDP only when forwarding DNS traffic; 'both': Use UDP 1st and if unreachable, retry with TCP when forwarding DNS traffic; **Type:** string **Supported Values:** tcp, udp, both **Default:** both **v6-port** **Description** Forwarding port number, Default is 53 **Type:** number **Range:** 1-65534 **Default:** 53 .. _3076_template_doh-list_dns-retry: template_doh-list_dns-retry ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **after-timeout** **Description** 'close': Close client side connection; 'retry-with-tcp': Retry DNS query to server using TCP (If UDP was tried initially. Close after.); **Type:** string **Supported Values:** close, retry-with-tcp **Default:** close **max-trials** **Description** Total number of times to try DNS query to server before closing client connection, default 3 **Type:** number **Range:** 1-5 **Default:** 3 **retry-interval** **Description** DNS Retry Interval value 1 - 400 in units of 100ms, default is 10 (default is 1000ms) (1 - 400 in units of 100ms, default is 10 (1000ms/1sec)) **Type:** number **Range:** 1-400 **Default:** 10 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_sip-list: template_sip-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-id** **Description** ACL id **Type:** number **Range:** 100-199 **Mutual Exclusion:** acl-id and acl-name-value are mutually exclusive **acl-name-value** **Description** IPv4 Access List Name **Type:** string **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Mutual Exclusion:** acl-name-value and acl-id are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ip/access-list ` **alg-dest-nat** **Description** Translate VIP to real server IP in SIP message when destination NAT is used **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **alg-source-nat** **Description** Translate source IP to NAT IP in SIP message when source NAT is used **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **call-id-persist-disable** **Description** Disable call-ID persistence **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-keep-alive** **Description** Respond client keep-alive packet directly instead of forwarding to server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-request-header** **Type:** List **client-response-header** **Type:** List **dialog-aware** **Description** Permit system processes dialog session **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **drop-when-client-fail** **Description** Drop current SIP message when select client fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** drop-when-client-fail and failed-client-selection-message are mutually exclusive **drop-when-server-fail** **Description** Drop current SIP message when select server fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** drop-when-server-fail and failed-server-selection-message are mutually exclusive **exclude-translation** **Type:** List **failed-client-selection** **Description** Define action when select client fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **failed-client-selection-message** **Description** Send SIP message (includs status code) to server when select client fail(Format: 3 digits(1XX~6XX) space reason) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** failed-client-selection-message and drop-when-client-fail are mutually exclusive **failed-server-selection** **Description** Define action when select server fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **failed-server-selection-message** **Description** Send SIP message (includs status code) to client when select server fail(Format: 3 digits(1XX~6XX) space reason) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** failed-server-selection-message and drop-when-server-fail are mutually exclusive **insert-client-ip** **Description** Insert Client IP address into SIP header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **interval** **Description** The interval of keep-alive packet for each persist connection (second) **Type:** number **Range:** 5-300 **Default:** 30 **keep-server-ip-if-match-acl** **Description** Use Real Server IP for addresses matching the ACL for a Call-Id **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** SIP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **pstn-gw** **Description** configure pstn gw host name for tel: uri translate to sip: uri (Hostname String, default is "pstn") **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** pstn **server-keep-alive** **Description** Send server keep-alive packet for every persist connection when enable conn-reuse **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-request-header** **Type:** List **server-response-header** **Type:** List **server-selection-per-request** **Description** Force server selection on every SIP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group** **Description** service group name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **smp-call-id-rtp-session** **Description** Create the across cpu call-id rtp session **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timeout** **Description** Time in minutes **Type:** number **Range:** 1-250 **Default:** 30 **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 .. _3076_template_sip-list_server-request-header: template_sip-list_server-request-header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **insert-condition-server-request** **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; **Type:** string **Supported Values:** insert-if-not-exist, insert-always **server-request-erase-all** **Description** Erase all headers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-request-header-erase** **Description** Erase a SIP header (Header Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **server-request-header-insert** **Description** Insert a SIP header (Header Content (Format: "name:value")) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _3076_template_sip-list_server-response-header: template_sip-list_server-response-header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **insert-condition-server-response** **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; **Type:** string **Supported Values:** insert-if-not-exist, insert-always **server-response-erase-all** **Description** Erase all headers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-response-header-erase** **Description** Erase a SIP header (Header Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **server-response-header-insert** **Description** Insert a SIP header (Header Content (Format: "name:value")) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _3076_template_sip-list_client-request-header: template_sip-list_client-request-header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-request-erase-all** **Description** Erase all headers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-request-header-erase** **Description** Erase a SIP header (Header Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **client-request-header-insert** **Description** Insert a SIP header (Header Content (Format: "name:value")) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **insert-condition-client-request** **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; **Type:** string **Supported Values:** insert-if-not-exist, insert-always .. _3076_template_sip-list_client-response-header: template_sip-list_client-response-header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **client-response-erase-all** **Description** Erase all headers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-response-header-erase** **Description** Erase a SIP header (Header Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **client-response-header-insert** **Description** Insert a SIP header (Header Content (Format: "name:value")) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **insert-condition-client-response** **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; **Type:** string **Supported Values:** insert-if-not-exist, insert-always .. _3076_template_sip-list_exclude-translation: template_sip-list_exclude-translation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **header-string** **Description** SIP header name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **translation-value** **Description** 'start-line': SIP request line or status line; 'header': SIP message headers; 'body': SIP message body; **Type:** string **Supported Values:** start-line, header, body .. _3076_template_respmod-icap-list: template_respmod-icap-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'continue': Continue; 'drop': Drop; 'reset': Reset; **Type:** string **Supported Values:** continue, drop, reset **Default:** continue **bypass-ip-cfg** **Type:** List **disable-http-server-reset** **Description** Don't reset http server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fail-close** **Description** When template sg is down mark vport down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **failure-action** **Description** 'continue': Continue; 'drop': Drop; 'reset': Reset; **Type:** string **Supported Values:** continue, drop, reset **Default:** continue **include-protocol-in-uri** **Description** Include protocol and port in HTTP URI **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-only-allowed-method** **Description** Only log allowed HTTP method **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **logging** **Description** logging template (Logging template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/logging ` **min-payload-size** **Description** min-payload-size value 0 - 65535, default is 0 **Type:** number **Range:** 0-65535 **Default:** 0 **name** **Description** Reqmod ICAP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **preview** **Description** Preview value 1 - 32768, default is 32768 **Type:** number **Range:** 1-32768 **Default:** 32768 **server-ssl** **Description** Server SSL template (Server SSL template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssl ` **service-group** **Description** Bind a Service Group to the template (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **service-url** **Description** URL to send to ICAP server (Service URL Name) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **shared-partition-persist-source-ip-template** **Description** Reference a persist source ip template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-persist-source-ip-template and source-ip are mutually exclusive **shared-partition-tcp-proxy-template** **Description** Reference a TCP Proxy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive **source-ip** **Description** Source IP persistence template (Source IP persistence template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** source-ip and shared-partition-persist-source-ip-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip ` **tcp-proxy** **Description** TCP Proxy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **template-persist-source-ip-shared** **Description** Source IP Persistence Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip ` **template-tcp-proxy-shared** **Description** TCP Proxy Template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **timeout** **Description** Timeout value 1 - 200 in units of 200ms, default is 5 (default is 1000ms) (1 - 200 in units of 200ms, default is 5 (1000ms)) **Type:** number **Range:** 1-200 **Default:** 5 **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 **x-auth-url** **Description** Use URL format for authentication **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_respmod-icap-list_bypass-ip-cfg: template_respmod-icap-list_bypass-ip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bypass-ip** **Description** ip address to bypass respmod-icap service **Type:** string **Format:** ipv4-address **mask** **Description** IP prefix mask **Type:** string **Format:** ipv4-netmask .. _3076_template_virtual-server-list: template_virtual-server-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **conn-limit** **Description** Connection limit **Type:** number **Range:** 1-64000000 **Default:** 64000000 **conn-limit-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-limit-reset** **Description** Send client reset when connection over limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-rate-limit** **Description** Connection rate limit **Type:** number **Range:** 1-1048575 **conn-rate-limit-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-rate-limit-reset** **Description** Send client reset when connection rate over limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-when-all-ports-down** **Description** Disable Virtual Server when all member ports are down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disable-when-all-ports-down and disable-when-any-port-down are mutually exclusive **disable-when-any-port-down** **Description** Disable Virtual Server when any member port is down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disable-when-any-port-down and disable-when-all-ports-down are mutually exclusive **icmp-lockup** **Description** Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period) **Type:** number **Range:** 1-65535 **icmp-lockup-period** **Description** Lockup period (second) **Type:** number **Range:** 1-16383 **icmp-rate-limit** **Description** ICMP rate limit (Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit) **Type:** number **Range:** 1-65535 **icmpv6-lockup** **Description** Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period) **Type:** number **Range:** 1-65535 **icmpv6-lockup-period** **Description** Lockup period (second) **Type:** number **Range:** 1-16383 **icmpv6-rate-limit** **Description** ICMPv6 rate limit (Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit) **Type:** number **Range:** 1-65535 **name** **Description** Virtual server template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **rate-interval** **Description** '100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; **Type:** string **Supported Values:** 100ms, second **Default:** second **subnet-gratuitous-arp** **Description** Send gratuitous ARP for every IP in the subnet virtual server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tcp-stack-tfo-active-conn-limit** **Description** The allowed active layer 7 tcp fast-open connection limit, default is zero (number) **Type:** number **Range:** 0-10000 **Default:** 0 **tcp-stack-tfo-backoff-time** **Description** The time tcp stack will wait before allowing new fast-open requests after security condition, default 600 seconds (number) **Type:** number **Range:** 1-14400 **Default:** 600 **tcp-stack-tfo-cookie-time-limit** **Description** The time limit (in seconds) that a layer 7 tcp fast-open cookie is valid, default is 60 seconds (number) **Type:** number **Range:** 1-14400 **Default:** 60 **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 .. _3076_template_client-ssh-list: template_client-ssh-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **forward-proxy-enable** **Description** Enable SSH forward proxy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-hostkey** **Description** Specify private-key (Key Name) **Type:** string **Maximum Length:** 255 characters **Maximum Length:** 1 characters **name** **Description** Client SSH Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **passphrase** **Description** Password Phrase **Type:** string **Format:** password **Maximum Length:** 63 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 .. _3076_template_ssli-list: template_ssli-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name** **Description** SSLi Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **type** **Description** 'http': HTTP service; 'xmpp': XMPP service; 'smtp': SMTP service; 'pop': POP service; 'ldap': LDAP service; 'ftp': FTP service; **Type:** string **Supported Values:** http, xmpp, smtp, pop, ldap, ftp **Default:** http **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 .. _3076_template_server-ssh-list: template_server-ssh-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **forward-proxy-enable** **Description** Enable SSH forward proxy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** Server SSH Template Name **Type:** string **Format:** string-rlx **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 .. _3076_template_dns-list: template_dns-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **add-padding-to-client** **Description** 'block-length': Block-Length Padding; 'random-block-length': Random-Block-Length Padding; **Type:** string **Supported Values:** block-length, random-block-length **cache-record-serving-policy** **Description** 'global': Follow global cofiguration (Default); 'no-change': No change in record order; 'round-robin': Round-robin; **Type:** string **Supported Values:** global, no-change, round-robin **cache-ttl-adjustment-enable** **Description** enable the ttl adjustment for dns cache response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **class-list** **Description:** class-list is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_class-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/class-list ` **default-policy** **Description** 'nocache': Cache disable; 'cache': Cache enable; **Type:** string **Supported Values:** nocache, cache **Default:** nocache **disable-dns-template** **Description** Disable DNS template **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-ra-cached-resp** **Description** Disable DNS recursive available flag in cached response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-rpz-attach-soa** **Description** Disable attaching SOA due to RPZ **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-logging** **Description** dns logging template (DNS Logging template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/dns-logging ` **dns64** **Description:** dns64 is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_dns64` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/dns64 ` **dnssec-service-group** **Description** Use different service group if DNSSEC DO bit set (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **drop** **Description** Drop the malformed query **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** drop and forward are mutually exclusive **enable-cache-sharing** **Description** Enable DNS cache sharing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward** **Description** Forward to service group (Service group name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** forward and drop are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **insert-ipv4** **Description** prefix-length to insert for IPv4 **Type:** number **Range:** 0-32 **insert-ipv6** **Description** prefix-length to insert for IPv6 **Type:** number **Range:** 0-128 **local-dns-resolution** **Description:** local-dns-resolution is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_local-dns-resolution` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/local-dns-resolution ` **max-cache-entry-size** **Description** Define maximum cache entry size (Maximum cache entry size per VIP (default 1024)) **Type:** number **Range:** 1-4096 **Default:** 1024 **max-cache-size** **Description** Define maximum cache size (Maximum cache entry per VIP) **Type:** number **max-query-length** **Description** Define Maximum DNS Query Length, default is unlimited (Specify Maximum Length) **Type:** number **Range:** 1-4095 **name** **Description** DNS Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **negative-dns-cache** **Description:** negative-dns-cache is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_negative-dns-cache` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/negative-dns-cache ` **period** **Description** Period in minutes **Type:** number **Range:** 1-10000 **query-class-filter** **Description:** query-class-filter is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_query-class-filter` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/query-class-filter ` **query-id-switch** **Description** Use DNS query ID to create sesion **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **query-type-filter** **Description:** query-type-filter is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_query-type-filter` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/query-type-filter ` **recursive-dns-resolution** **Description:** recursive-dns-resolution is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_recursive-dns-resolution` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution ` **redirect-to-tcp-port** **Description** Direct the client to retry with TCP for DNS UDP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **remove-aa-flag** **Description** Make answers created from cache non-authoritative **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **remove-csubnet** **Description** Remove EDNS(0) client subnet from client queries **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **remove-padding-to-server** **Description** Remove EDNS(0) padding to server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **response-rate-limiting** **Description:** response-rate-limiting is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_response-rate-limiting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/response-rate-limiting ` **rpz-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/rpz/{seq-id} ` **udp-retransmit** **Description:** udp-retransmit is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_udp-retransmit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/udp-retransmit ` **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 .. _3076_template_dns-list_response-rate-limiting: template_dns-list_response-rate-limiting ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **TC-rate** **Description** Every n'th response that would be rate-limited will respond with TC bit **Type:** number **Range:** 2-10 **Mutual Exclusion:** TC-rate and slip-rate are mutually exclusive **action** **Description** 'log-only': Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; 'rate-limit': Rate-Limit based on configuration (Default); 'whitelist': Whitelist, disable rate-limiting; **Type:** string **Supported Values:** log-only, rate-limit, whitelist **Default:** rate-limit **enable-log** **Description** Enable logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **filter-response-rate** **Description** Maximum allowed request rate for the filter. This should match average traffic. (default 10 per seconds) **Type:** number **Range:** 1-1000 **Default:** 10 **match-subnet** **Description** IP subnet mask (response rate by IP subnet mask) **Type:** string **Format:** ipv4-netmask **Default:** 255.255.255.255 **match-subnet-v6** **Description** IPV6 subnet mask (response rate by IPv6 subnet mask) **Type:** number **Range:** 1-128 **Default:** 128 **response-rate** **Description** Responses exceeding this rate within the window will be dropped (default 5 per second) **Type:** number **Range:** 1-1000 **Default:** 5 **rrl-class-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name} ` **slip-rate** **Description** Every n'th response that would be rate-limited will be let through instead **Type:** number **Range:** 2-10 **Mutual Exclusion:** slip-rate and TC-rate are mutually exclusive **src-ip-only** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **window** **Description** Rate-Limiting Interval in Seconds (default is one) **Type:** number **Range:** 1-60 **Default:** 1 .. _3076_template_dns-list_response-rate-limiting_rrl-class-list-list: template_dns-list_response-rate-limiting_rrl-class-list-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **lid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name}/lid/{lidnum} ` **name** **Description** Class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 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 .. _3076_template_dns-list_response-rate-limiting_rrl-class-list-list_lid-list: template_dns-list_response-rate-limiting_rrl-class-list-list_lid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **lid-action** **Description** 'log-only': Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; 'rate-limit': Rate-Limit based on configuration (Default); 'whitelist': Whitelist, disable rate-limiting; **Type:** string **Supported Values:** log-only, rate-limit, whitelist **Default:** rate-limit **lid-enable-log** **Description** Enable logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **lid-match-subnet** **Description** IP subnet mask (response rate by IP subnet mask) **Type:** string **Format:** ipv4-netmask **Default:** 255.255.255.255 **lid-match-subnet-v6** **Description** IPV6 subnet mask (response rate by IPv6 subnet mask) **Type:** number **Range:** 1-128 **Default:** 128 **lid-response-rate** **Description** Responses exceeding this rate within the window will be dropped (default 5 per second) **Type:** number **Range:** 1-1000 **Default:** 5 **lid-slip-rate** **Description** Every n'th response that would be rate-limited will be let through instead **Type:** number **Range:** 2-10 **Mutual Exclusion:** lid-slip-rate and lid-tc-rate are mutually exclusive **lid-src-ip-only** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **lid-tc-rate** **Description** Every n'th response that would be rate-limited will respond with TC bit **Type:** number **Range:** 2-10 **Mutual Exclusion:** lid-tc-rate and lid-slip-rate are mutually exclusive **lid-window** **Description** Rate-Limiting Interval in Seconds (default is one) **Type:** number **Range:** 1-60 **Default:** 1 **lidnum** **Description** Specify a limit ID **Type:** number **Range:** 1-1023 **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 .. _3076_template_dns-list_rpz-list: template_dns-list_rpz-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **logging** **Description:** logging is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_rpz-list_logging` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/rpz/{seq-id}/logging ` **name** **Description** Specify a Response Policy Zone name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **seq-id** **Description** sequential id of RPZ **Type:** number **Range:** 1-8 **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 .. _3076_template_dns-list_rpz-list_logging: template_dns-list_rpz-list_logging ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Log RPZ triggered action **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rpz-action** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_rpz-list_logging_rpz-action: template_dns-list_rpz-list_logging_rpz-action ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **str-rpz-action** **Description** 'drop': Log RPZ due to drop action; 'pass-thru': Log RPZ due to pass-thru action; 'nxdomain': Log RPZ due to nxdomain action; 'nodata': Log RPZ due to nodata action; 'tcp-only': Log RPZ due to tcp-only action; 'local-data': Log RPZ due to local-data action; **Type:** string **Supported Values:** drop, pass-thru, nxdomain, nodata, tcp-only, local-data .. _3076_template_dns-list_recursive-dns-resolution: template_dns-list_recursive-dns-resolution ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **csubnet-retry** **Description** retry when server REFUSED AX inserted EDNS(0) subnet, works only when insert-client-subnet is configured **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **default-recursive** **Description** Default recursive mode, forward query to bound service-group if hostnames matched **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dnssec-validation** **Description** 'enabled': Enable DNSSEC validation; 'disabled': Disable DNSSEC validation; **Type:** string **Supported Values:** enabled, disabled **Default:** disabled **fast-ns-selection** **Description** 'enabled': Enable fast NS selection; 'disabled': Disable fast NS selection; **Type:** string **Supported Values:** enabled, disabled **Default:** enabled **force-cname-resolution** **Description** 'enabled': Force CNAME resolution always; 'disabled': Use answer record in CNAME response if it exists, else resolve; **Type:** string **Supported Values:** enabled, disabled **Default:** enabled **full-response** **Description** Serve all records (authority and additional) when applicable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gateway-health-check** **Description:** gateway-health-check is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_recursive-dns-resolution_gateway-health-check` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check ` **host-list-cfg** **Type:** List **ipv4-nat-pool** **Description** IPv4 Source NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ipv6-nat-pool** **Description** IPv6 Source NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **lookup-order** **Description:** lookup-order is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_recursive-dns-resolution_lookup-order` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/lookup-order ` **max-trials** **Description** Total number of times to try DNS query to server before closing client connection, default 255 **Type:** number **Range:** 1-255 **Default:** 255 **ns-cache-lookup** **Description** 'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; **Type:** string **Supported Values:** disabled, enabled **Default:** enabled **request-for-pending-resolution** **Description** 'drop': Drop of the request during ongoing; 'respond-with-servfail': Respond with SERVFAIL of the request during ongoing; 'start-new-resolution': Start new resolution of the request during ongoing; **Type:** string **Supported Values:** drop, respond-with-servfail, start-new-resolution **Default:** respond-with-servfail **retries-per-level** **Description** Number of DNS query retries at each server level before closing client connection, default 6 **Type:** number **Range:** 1-6 **Default:** 6 **udp-initial-interval** **Description** UDP DNS Retry Interval value 1-6, default is 5 sec (1-6, default is 5sec) **Type:** number **Range:** 1-6 **Default:** 5 **udp-retry-interval** **Description** UDP DNS Retry Interval value 1-6, default is 1 sec (1-6 , default is 1 sec) **Type:** number **Range:** 1-6 **Default:** 1 **use-client-qid** **Description** Use client side query id for recursive query **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-service-group-response** **Description** 'disabled': Start Recursive Resolver if Server response doesnt have final answer; 'enabled': Forward Backend Server response to client and dont start recursive resolver; **Type:** string **Supported Values:** disabled, enabled **Default:** enabled **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_recursive-dns-resolution_lookup-order: template_dns-list_recursive-dns-resolution_lookup-order ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **query-type** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_recursive-dns-resolution_lookup-order_query-type: template_dns-list_recursive-dns-resolution_lookup-order_query-type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **num-query-type** **Description** Other query type value **Type:** number **Range:** 1-65535 **order** **Description** 'ipv4-precede-ipv6': Recursive lookup via IPv4 then IPv6; 'ipv6-precede-ipv4': Recursive lookup via IPv6 then IPv4; **Type:** string **Supported Values:** ipv4-precede-ipv6, ipv6-precede-ipv4 **str-query-type** **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 'ANY': All cached record; **Type:** string **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT, ANY .. _3076_template_dns-list_recursive-dns-resolution_gateway-health-check: template_dns-list_recursive-dns-resolution_gateway-health-check ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **gwhc-ns-cache-lookup** **Description** 'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; **Type:** string **Supported Values:** disabled, enabled **Default:** disabled **interval** **Description** Specify the health check interval, default is 10 sec (Interval value, in seconds (default 10)) **Type:** number **Range:** 1-300 **Default:** 10 **num-query-type** **Description** Other record type value **Type:** number **Range:** 1-65535 **Mutual Exclusion:** num-query-type and str-query-type are mutually exclusive **query-name** **Description** Specify the query name used in probe queries, default "a10networks.com" **Type:** string **Maximum Length:** 255 characters **Maximum Length:** 1 characters **Default:** a10networks.com **retry** **Description** Maximum number of DNS query retries at each server level before health check fails, default 6 (Retry count (default 6)) **Type:** number **Range:** 1-6 **Default:** 6 **retry-multi** **Description** Specify number of times that health check consecutively fails before declaring gateway DOWN, default 1 (retry-multi count (default 1)) **Type:** number **Range:** 1-10 **Default:** 1 **str-query-type** **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; **Type:** string **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT **Default:** A **Mutual Exclusion:** str-query-type and num-query-type are mutually exclusive **timeout** **Description** Specify the health check timeout before retrying or finish, default is 5 sec (Timeout value, in seconds (default 5)) **Type:** number **Range:** 1-6 **Default:** 5 **up-retry** **Description** Specify number of times that health check consecutively passes before declaring gateway UP, default 1 (up-retry count (default 1)) **Type:** number **Range:** 1-10 **Default:** 1 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_recursive-dns-resolution_host-list-cfg: template_dns-list_recursive-dns-resolution_host-list-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hostnames** **Description** Hostnames class-list name (dns type), perform resolution while query name matched **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_dns-list_class-list: template_dns-list_class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **lid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/class-list/lid/{lidnum} ` **name** **Description** Specify a class list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_class-list_lid-list: template_dns-list_class-list_lid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action-value** **Description** 'dns-cache-disable': Disable DNS cache when it exceeds limit; 'dns-cache-enable': Enable DNS cache when it exceeds limit; 'forward': Forward the traffic even it exceeds limit; **Type:** string **Supported Values:** dns-cache-disable, dns-cache-enable, forward **conn-rate-limit** **Description** Connection rate limit **Type:** number **Range:** 1-2147483647 **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`3076_template_dns-list_class-list_lid-list_dns` **Type:** Object **lidnum** **Description** Specify a limit ID **Type:** number **Range:** 1-1023 **lockout** **Description** Don't accept any new connection for certain time (Lockout duration in minutes) **Type:** number **Range:** 1-1023 **log** **Description** Log a message **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-interval** **Description** Log interval (minute, by default system will log every over limit instance) **Type:** number **Range:** 1-255 **over-limit-action** **Description** Action when exceeds limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **per** **Description** Per (Number of 100ms) **Type:** number **Range:** 1-65535 **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 .. _3076_template_dns-list_class-list_lid-list_dns: template_dns-list_class-list_lid-list_dns ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cache-action** **Description** 'cache-disable': Disable dns cache; 'cache-enable': Enable dns cache; **Type:** string **Supported Values:** cache-disable, cache-enable **Default:** cache-disable **honor-server-response-ttl** **Description** Honor the server reponse TTL **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ttl** **Description** TTL for cache entry (TTL in seconds) **Type:** number **Range:** 1-65535 **weight** **Description** Weight for cache entry **Type:** number **Range:** 1-7 .. _3076_template_dns-list_dns64: template_dns-list_dns64 ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cache** **Description** Use a cached A-query response to provide AAAA query responses for the same hostname **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **change-query** **Description** Always change incoming AAAA DNS Query to A **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enable DNS64 (Need to config this option before config any other dns64 options) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **parallel-query** **Description** Forward AAAA Query & generate A Query in parallel **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **retry** **Description** Retry count, default is 3 (Retry Number) **Type:** number **Range:** 0-15 **Default:** 3 **single-response-disable** **Description** Disable Single Response which is used to avoid ambiguity **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timeout** **Description** Timeout to send additional Queries, unit: second, default is 1 **Type:** number **Range:** 0-15 **Default:** 1 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_udp-retransmit: template_dns-list_udp-retransmit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **max-trials** **Description** Total number of times to try DNS query to server before closing client connection, default 3 **Type:** number **Range:** 1-5 **Default:** 3 **retry-interval** **Description** DNS Retry Interval value 1 - 400 in units of 100ms, default is 10 (default is 1000ms) (1 - 400 in units of 100ms, default is 10 (1000ms/1sec)) **Type:** number **Range:** 1-400 **Default:** 10 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_query-class-filter: template_dns-list_query-class-filter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **query-class** **Type:** List **query-class-action** **Description** 'allow': Allow only certain DNS query classes; 'deny': Deny only certain DNS query classes; **Type:** string **Supported Values:** allow, deny **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_query-class-filter_query-class: template_dns-list_query-class-filter_query-class ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **num-query-class** **Description** Other query class value **Type:** number **Range:** 1-65535 **str-query-class** **Description** 'INTERNET': INTERNET query class; 'CHAOS': CHAOS query class; 'HESIOD': HESIOD query class; 'NONE': NONE query class; 'ANY': ANY query class; **Type:** string **Supported Values:** INTERNET, CHAOS, HESIOD, NONE, ANY .. _3076_template_dns-list_local-dns-resolution: template_dns-list_local-dns-resolution ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **host-list-cfg** **Type:** List **local-resolver-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_local-dns-resolution_host-list-cfg: template_dns-list_local-dns-resolution_host-list-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hostnames** **Description** Hostnames class-list name (dns type) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _3076_template_dns-list_local-dns-resolution_local-resolver-cfg: template_dns-list_local-dns-resolution_local-resolver-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **local-resolver** **Description** Local dns servers (address) **Type:** string **Format:** ipv4-address .. _3076_template_dns-list_negative-dns-cache: template_dns-list_negative-dns-cache ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bypass-query-threshold** **Description** the threshold bypass the query, default is 100 **Type:** number **Range:** 1-65535 **Default:** 100 **enable-negative-dns-cache** **Description** Enable DNS negative cache (Need to turn-on the dns-cache for this feature) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-negative-cache-ttl** **Description** Max negative cache ttl, default is 2 hours **Type:** number **Range:** 0-604800 **Default:** 7200 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_query-type-filter: template_dns-list_query-type-filter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **query-type** **Type:** List **query-type-action** **Description** 'allow': Allow only certain DNS query types; 'deny': Deny only certain DNS query types; **Type:** string **Supported Values:** allow, deny **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-list_query-type-filter_query-type: template_dns-list_query-type-filter_query-type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **num-query-type** **Description** Other record type value **Type:** number **Range:** 1-65535 **str-query-type** **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 'ANY': All cached record; **Type:** string **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT, ANY .. _3076_template_http-list: template_http-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **100-cont-wait-for-req-complete** **Description** When REQ has Expect 100 and response is not 100, then wait for whole request to be sent **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowed-methods** **Description** Enable allowed-method check (List of allowed HTTP methods) **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **Mutual Exclusion:** allowed-methods and disallowed-methods are mutually exclusive **allowed-methods-action** **Description** 'drop': Respond 400 directly; **Type:** string **Supported Values:** drop **Default:** drop **bypass-sg** **Description** Select service group for non-http traffic (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **client-idle-timeout** **Description** Client session timeout if the next request is not received (timeout in seconds. 0 means disable, default is 0) **Type:** number **Range:** 0-120 **Default:** 0 **client-ip-hdr-replace** **Description** Replace the existing header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **client-port-hdr-replace** **Description** Replace the existing header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **compression-auto-disable-on-high-cpu** **Description** Auto-disable software compression on high cpu usage (Disable compression if cpu usage is above threshold. Default is off.) **Type:** number **Range:** 1-100 **compression-br-level** **Description** brotli compression level, default 1 (brotli compression level value, default is 1) **Type:** number **Range:** 1-9 **Default:** 1 **compression-br-sliding-window-size** **Description** brotli compression sliding window size, default 10 (brotli compression sliding window size in the form of log (i.e., 10 means 1k-16MB bytes)) **Type:** number **Range:** 10-24 **compression-content-type** **Type:** List **compression-enable** **Description** Enable Compression **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **compression-exclude-content-type** **Type:** List **compression-exclude-uri** **Type:** List **compression-keep-accept-encoding** **Description** Keep accept encoding **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **compression-keep-accept-encoding-enable** **Description** Enable Server Accept Encoding **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **compression-level** **Description** gzip compression level, default 1 (gzip compression level value, default is 1) **Type:** number **Range:** 1-9 **Default:** 1 **compression-method-order** **Description** Method Order (Order to decide which compression algorithm to be applied when multiple algorithms are acceptable) **Type:** string **Format:** string-rlx **Maximum Length:** 11 characters **Maximum Length:** 11 characters **compression-minimum-content-length** **Description** Minimum Content Length (Minimum content length for compression in bytes. Default is 120.) **Type:** number **Range:** 1-2147483647 **Default:** 120 **cookie-format** **Description** 'rfc6265': Follow rfc6265; **Type:** string **Supported Values:** rfc6265 **cookie-samesite** **Description** 'none': none; 'lax': lax; 'strict': strict; **Type:** string **Supported Values:** none, lax, strict **default-charset** **Description** 'iso-8859-1': Use ISO-8859-1 as the default charset; 'utf-8': Use UTF-8 as the default charset; 'us-ascii': Use US-ASCII as the default charset; **Type:** string **Supported Values:** iso-8859-1, utf-8, us-ascii **Default:** utf-8 **disallowed-methods** **Description** Enable disallowed-method check (List of disallowed HTTP methods) **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **Mutual Exclusion:** disallowed-methods and allowed-methods are mutually exclusive **disallowed-methods-action** **Description** 'drop': Respond 400 directly; **Type:** string **Supported Values:** drop **Default:** drop **failover-url** **Description** Failover to this URL (Failover URL Name) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **frame-limit** **Description** Limit the number of CONTINUATION, PING, PRIORITY, RESET, SETTINGS and empty frames in one HTTP2 connection, default 10000 **Type:** number **Range:** 0-65535 **Default:** 10000 **host-switching** **Type:** List **http-protocol-check** **Description:** http-protocol-check is a **JSON Block**. Please see below for :ref:`3076_template_http-list_http-protocol-check` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/http/{name}/http-protocol-check ` **http2-client-no-snat** **Description** Set max-concurrent-stream = 1 when the client side is HTTP2 and no source-nat configuration is under vport **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **insert-client-ip** **Description** Insert Client IP address into HTTP header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **insert-client-ip-header-name** **Description** HTTP Header Name for inserting Client IP **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **insert-client-port** **Description** Insert Client Port address into HTTP header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **insert-client-port-header-name** **Description** HTTP Header Name for inserting Client Port **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **keep-client-alive** **Description** Keep client alive **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-retry** **Description** log when HTTP request retry **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-concurrent-streams** **Description** (http2 only) Max concurrent streams, default 50 **Type:** number **Range:** 1-1000 **Default:** 50 **name** **Description** HTTP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **non-http-bypass** **Description** Bypass non-http traffic instead of dropping **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **persist-on-401** **Description** Persist to the same server if the response code is 401 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **prefix** **Description** 'host': the cookie will have been set with a Secure attribute, a Path attribute with a value of /, and no Domain attribute; 'secure': the cookie will have been set with a Secure attribute; 'check': check server prefix and enforce prefix format; **Type:** string **Supported Values:** host, secure, check **rd-port** **Description** Port (Port Number) **Type:** number **Range:** 1-65535 **Mutual Exclusion:** rd-port and rd-simple-loc are mutually exclusive **rd-resp-code** **Description** '301': Moved Permanently; '302': Found; '303': See Other; '307': Temporary Redirect; **Type:** string **Supported Values:** 301, 302, 303, 307 **rd-secure** **Description** Use HTTPS **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** rd-secure and rd-simple-loc are mutually exclusive **rd-simple-loc** **Description** Redirect location tag absolute URI string **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **Mutual Exclusion:** rd-simple-loc, rd-secure, and rd-port are mutually exclusive **redirect** **Description** Automatically send a redirect response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **redirect-rewrite** **Description:** redirect-rewrite is a **JSON Block**. Please see below for :ref:`3076_template_http-list_redirect-rewrite` **Type:** Object **req-hdr-wait-time** **Description** HTTP request header wait time before abort connection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **req-hdr-wait-time-val** **Description** Number of seconds wait for client request header (default is 7) **Type:** number **Range:** 1-31 **Default:** 7 **request-header-erase-list** **Type:** List **request-header-insert-list** **Type:** List **request-line-case-insensitive** **Description** Parse http request line as case insensitive **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **request-timeout** **Description** Request timeout if response not received (timeout in seconds) **Type:** number **Range:** 1-120 **response-content-replace-list** **Type:** List **response-header-erase-list** **Type:** List **response-header-insert-list** **Type:** List **retry-on-5xx** **Description** Retry http request on HTTP 5xx code and request timeout **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** retry-on-5xx and retry-on-5xx-per-req are mutually exclusive **retry-on-5xx-per-req** **Description** Retry http request on HTTP 5xx code for each request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** retry-on-5xx-per-req and retry-on-5xx are mutually exclusive **retry-on-5xx-per-req-val** **Description** Number of times to retry (default is 3) **Type:** number **Range:** 1-3 **Default:** 3 **retry-on-5xx-val** **Description** Number of times to retry (default is 3) **Type:** number **Range:** 1-3 **Default:** 3 **server-support-http2-only** **Description** Notify the vport regarding whether server supports http2 only **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-support-http2-only-value** **Description** 'auto-detect': Commuincate with the server via HTTP/2 when an support-http2-only rport is detected; 'force': Communicate with the server via HTTP/2 when possible; **Type:** string **Supported Values:** auto-detect, force **Default:** auto-detect **stream-cancellation-limit** **Description** cancellation limit, default 0 (accumulated cancellation limit value, default is 0) **Type:** number **Range:** 0-1000 **Default:** 0 **stream-cancellation-rate** **Description** cancellation rate, default 10 (cancellation rate value, default is 10) **Type:** number **Range:** 0-1000 **Default:** 10 **strict-transaction-switch** **Description** Force server selection on every HTTP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **template** **Description:** template is a **JSON Block**. Please see below for :ref:`3076_template_http-list_template` **Type:** Object **term-11client-hdr-conn-close** **Description** Terminate HTTP 1.1 client when req has Connection: close **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **url-hash-first** **Description** Use the begining part of URL to calculate hash value (URL string length to calculate hash value) **Type:** number **Range:** 4-128 **Mutual Exclusion:** url-hash-first and url-hash-last are mutually exclusive **url-hash-last** **Description** Use the end part of URL to calculate hash value (URL string length to calculate hash value) **Type:** number **Range:** 4-128 **Mutual Exclusion:** url-hash-last and url-hash-first are mutually exclusive **url-hash-offset** **Description** Skip part of URL to calculate hash value (Offset of the URL string) **Type:** number **Range:** 0-255 **url-hash-persist** **Description** Use URL's hash value to select server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **url-switching** **Type:** List **use-server-status** **Description** Use Server-Status header to do URL hashing **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 .. _3076_template_http-list_request-header-erase-list: template_http-list_request-header-erase-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **request-header-erase** **Description** Erase a header from HTTP request (Header Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_http-list_redirect-rewrite: template_http-list_redirect-rewrite ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **match-list** **Type:** List **redirect-secure** **Description** Use HTTPS **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **redirect-secure-port** **Description** Port (Port Number) **Type:** number **Range:** 1-65535 **Default:** 443 .. _3076_template_http-list_redirect-rewrite_match-list: template_http-list_redirect-rewrite_match-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **redirect-match** **Description** URL Matching (Pattern URL String) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **rewrite-to** **Description** Rewrite to Destination URL String **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_http-list_response-header-insert-list: template_http-list_response-header-insert-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **response-header-insert** **Description** Insert a header into HTTP response (Header Content (Format: "[name]:[value]")) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **response-header-insert-type** **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; **Type:** string **Supported Values:** insert-if-not-exist, insert-always .. _3076_template_http-list_response-header-erase-list: template_http-list_response-header-erase-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **response-header-erase** **Description** Erase a header from HTTP response (Header Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_template_http-list_template: template_http-list_template ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **logging** **Description** Logging template (Logging Config name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/logging ` .. _3076_template_http-list_url-switching: template_http-list_url-switching ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **url-match-string** **Description** URL String **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **url-service-group** **Description** Create a Service Group comprising Servers (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **url-switching-type** **Description** 'contains': Select service group if URL string contains another string; 'ends-with': Select service group if URL string ends with another string; 'equals': Select service group if URL string equals another string; 'starts-with': Select service group if URL string starts with another string; 'regex-match': Select service group if URL string matches with regular expression; 'url-case-insensitive': Case insensitive URL switching; 'url-hits-enable': Enables URL Hits; **Type:** string **Supported Values:** contains, ends-with, equals, starts-with, regex-match, url-case-insensitive, url-hits-enable .. _3076_template_http-list_response-content-replace-list: template_http-list_response-content-replace-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **response-content-replace** **Description** replace the data from HTTP response content (String in the http content need to be replaced) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **response-new-string** **Description** String will be in the http content **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _3076_template_http-list_http-protocol-check: template_http-list_http-protocol-check ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **get-and-payload** **Description** 'drop': Drop the request and send 400 to the client side; **Type:** string **Supported Values:** drop **h2up-content-length-alias** **Description** 'drop': Drop the request and send 400 to the client side; **Type:** string **Supported Values:** drop **h2up-with-host-and-auth** **Description** 'drop': Drop the request and send 400 to the client side; **Type:** string **Supported Values:** drop **h2up-with-transfer-encoding** **Description** 'drop': Drop the request and send 400 to the client side; **Type:** string **Supported Values:** drop **header-filter-rule-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/http/{name}/http-protocol-check/header-filter-rule/{seq-num} ` **malformed-h2up-header-value** **Description** 'drop': Drop the request and send 400 to the client side; **Type:** string **Supported Values:** drop **malformed-h2up-scheme-value** **Description** 'drop': Drop the request and send 400 to the client side; **Type:** string **Supported Values:** drop **multiple-content-length** **Description** 'drop': Drop the request and send 400 to the client side; **Type:** string **Supported Values:** drop **multiple-transfer-encoding** **Description** 'drop': Drop the request and send 400 to the client side; **Type:** string **Supported Values:** drop **transfer-encoding-and-content-length** **Description** 'drop': Drop the request and Send 400 to the client side; **Type:** string **Supported Values:** drop **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_http-list_http-protocol-check_header-filter-rule-list: template_http-list_http-protocol-check_header-filter-rule-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action-value** **Description** 'drop': Drop the request; **Type:** string **Supported Values:** drop **header-name-value** **Description** Header name value **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **header-value-value** **Description** Header value **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **match-type-value** **Description** 'full-text': Full text match; 'pcre': PCRE match; **Type:** string **Supported Values:** full-text, pcre **seq-num** **Description** Specify a sequence number **Type:** number **Range:** 0-4 **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 .. _3076_template_http-list_request-header-insert-list: template_http-list_request-header-insert-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **request-header-insert** **Description** Insert a header into HTTP request (Header Content (Format: "[name]:[value]")) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **request-header-insert-type** **Description** 'insert-if-not-exist': Only insert the header when it does not exist; 'insert-always': Always insert the header even when there is a header with the same name; **Type:** string **Supported Values:** insert-if-not-exist, insert-always .. _3076_template_http-list_host-switching: template_http-list_host-switching ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **host-match-string** **Description** Hostname String **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **host-service-group** **Description** Create a Service Group comprising Servers (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **host-switching-type** **Description** 'contains': Select service group if hostname contains another string; 'ends-with': Select service group if hostname ends with another string; 'equals': Select service group if hostname equals another string; 'starts-with': Select service group if hostname starts with another string; 'regex-match': Select service group if URL string matches with regular expression; 'host-hits-enable': Enables Host Hits counters; **Type:** string **Supported Values:** contains, ends-with, equals, starts-with, regex-match, host-hits-enable .. _3076_template_http-list_compression-content-type: template_http-list_compression-content-type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **content-type** **Description** Compression content-type **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters .. _3076_template_http-list_compression-exclude-uri: template_http-list_compression-exclude-uri ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exclude-uri** **Description** Compression exclude uri **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters .. _3076_template_http-list_compression-exclude-content-type: template_http-list_compression-exclude-content-type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exclude-content-type** **Description** Compression exclude content-type (Compression exclude content type) **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters .. _3076_template_dns-logging-list: template_dns-logging-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **disable** **Description** Disable DNS Logging template **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-logging-protocol** **Description** 'both': Log DNS over tcp and udp; 'tcp': Log DNS over tcp; 'udp': Log DNS over udp; **Type:** string **Supported Values:** both, tcp, udp **dns-logging-request-section** **Description** 'all': Log DNS header and question section; 'header': Log DNS header information; 'question': Log DNS question section; **Type:** string **Supported Values:** all, header, question **dns-logging-response-section** **Description** 'all': Log DNS header information, answer, authority, additional section content; 'header': Log DNS header information; 'answer': Log DNS header information and answer section content; **Type:** string **Supported Values:** all, header, answer **dns-logging-type** **Description** 'query': DNS Query Logging; 'response': DNS Response Logging; 'both': DNS Query and Response Logging; **Type:** string **Supported Values:** query, response, both **name** **Description** DNS Logging Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **response-type** **Description:** response-type is a **JSON Block**. Please see below for :ref:`3076_template_dns-logging-list_response-type` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns-logging/{name}/response-type ` **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 .. _3076_template_dns-logging-list_response-type: template_dns-logging-list_response-type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **config** **Description** start config the response type detail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **type-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns-logging/{name}/response-type/type/{response-type-name} ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_dns-logging-list_response-type_type-list: template_dns-logging-list_response-type_type-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **caa-type-limit-num** **Description** Limit the field length **Type:** number **Range:** 0-256 **Default:** 0 **Mutual Exclusion:** caa-type-limit-num and caa-type-no-limit are mutually exclusive **caa-type-no-limit** **Description** Print the field as much as possible **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** caa-type-no-limit and caa-type-limit-num are mutually exclusive **digest** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dnskey-type-limit-num** **Description** Limit the field length **Type:** number **Range:** 0-256 **Default:** 0 **Mutual Exclusion:** dnskey-type-limit-num and dnskey-type-no-limit are mutually exclusive **dnskey-type-no-limit** **Description** Print the field as much as possible **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** dnskey-type-no-limit and dnskey-type-limit-num are mutually exclusive **ds-type-limit-num** **Description** Limit the field length **Type:** number **Range:** 0-256 **Default:** 0 **Mutual Exclusion:** ds-type-limit-num and ds-type-no-limit are mutually exclusive **ds-type-no-limit** **Description** Print the field as much as possible **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** ds-type-no-limit and ds-type-limit-num are mutually exclusive **length-limit-flag** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **naptr-type-limit-num** **Description** Limit the field length **Type:** number **Range:** 0-256 **Default:** 0 **Mutual Exclusion:** naptr-type-limit-num and naptr-type-no-limit are mutually exclusive **naptr-type-no-limit** **Description** Print the field as much as possible **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** naptr-type-no-limit and naptr-type-limit-num are mutually exclusive **opt-type-limit-num** **Description** Limit the field length **Type:** number **Range:** 0-256 **Default:** 0 **Mutual Exclusion:** opt-type-limit-num and opt-type-no-limit are mutually exclusive **opt-type-no-limit** **Description** Print the field as much as possible **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** opt-type-no-limit and opt-type-limit-num are mutually exclusive **other-data** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **public-key** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rdata-field** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **response-type-name** **Description** 'TXT': TXT; 'RRSIG': RRSIG; 'TSIG': TSIG; 'DNSKEY': DNSKEY; 'DS': DS; 'CAA': CAA; 'NAPTR': NAPTR; 'OPT': OPT; **Type:** string **Supported Values:** TXT, RRSIG, TSIG, DNSKEY, DS, CAA, NAPTR, OPT **rrsig-type-limit-num** **Description** Limit the field length **Type:** number **Range:** 0-256 **Default:** 0 **Mutual Exclusion:** rrsig-type-limit-num and rrsig-type-no-limit are mutually exclusive **rrsig-type-no-limit** **Description** Print the field as much as possible **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** rrsig-type-no-limit and rrsig-type-limit-num are mutually exclusive **service-field** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **signature** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tsig-type-limit-num** **Description** Limit the field length **Type:** number **Range:** 0-256 **Default:** 0 **Mutual Exclusion:** tsig-type-limit-num and tsig-type-no-limit are mutually exclusive **tsig-type-no-limit** **Description** Print the field as much as possible **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** tsig-type-no-limit and tsig-type-limit-num are mutually exclusive **txt-data** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **txt-type-limit-num** **Description** Limit the field length **Type:** number **Range:** 0-256 **Default:** 0 **Mutual Exclusion:** txt-type-limit-num and txt-type-no-limit are mutually exclusive **txt-type-no-limit** **Description** Print the field as much as possible **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** txt-type-no-limit and txt-type-limit-num are mutually exclusive **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 **value-field** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_virtual-port-list: template_virtual-port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **aflow** **Description** Use aFlow to eliminate the traffic surge **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allow-syn-otherflags** **Description** Allow initial SYN packet with other flags **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allow-vip-to-rport-mapping** **Description** Allow mapping of VIP to real port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-limit** **Description** Connection limit **Type:** number **Range:** 1-64000000 **Default:** 64000000 **conn-limit-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-limit-reset** **Description** Send client reset when connection over limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-rate-limit** **Description** Connection rate limit **Type:** number **Range:** 1-1048575 **conn-rate-limit-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-rate-limit-reset** **Description** Send client reset when connection rate over limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **drop-unknown-conn** **Description** Drop conection if receives TCP packet without SYN or RST flag and it does not belong to any existing connections **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dscp** **Description** Differentiated Services Code Point (DSCP to Real Server IP Mapping Value) **Type:** number **Range:** 1-63 **ignore-tcp-msl** **Description** reclaim TCP resource immediately without MSL **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-options** **Description** 'no-logging': Do not log over limit event; 'no-repeat-logging': log once for over limit event. Default is log once per minute; **Type:** string **Supported Values:** no-logging, no-repeat-logging **name** **Description** Virtual port template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **non-syn-initiation** **Description** Allow initial TCP packet to be non-SYN **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pkt-rate-interval** **Description** '100ms': Source IP and port rate limit per 100ms; 'second': Source IP and port rate limit per second (default); **Type:** string **Supported Values:** 100ms, second **Default:** second **pkt-rate-limit-reset** **Description** send client-side reset (reset after packet limit) **Type:** number **Range:** 0-1048575 **Default:** 0 **pkt-rate-type** **Description** 'src-ip-port': Source IP and port rate limit; 'src-port': Source port rate limit; **Type:** string **Supported Values:** src-ip-port, src-port **rate** **Description** Source IP and port rate limit (Packet rate limit) **Type:** number **Range:** 1-1048575 **rate-interval** **Description** '100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; **Type:** string **Supported Values:** 100ms, second **Default:** second **reset-l7-on-failover** **Description** Send reset to L7 client and server connection upon a failover **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset-unknown-conn** **Description** Send reset back if receives TCP packet without SYN or RST flag and it does not belong to any existing connections **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **snat-msl** **Description** Source NAT MSL (Source NAT MSL value (seconds)) **Type:** number **Range:** 1-1800 **snat-port-preserve** **Description** Source NAT Port Preservation **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 **when-rr-enable** **Description** Only do rate limit if CPU RR triggered **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_mqtt-list: template_mqtt-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **clientid-hash-first** **Description** Use the begining part of client ID to calculate hash value (client ID string length to calculate hash value) **Type:** number **Range:** 4-128 **clientid-hash-last** **Description** Use the end part of Client ID to calculate hash value (Client ID length to calculate hash value) **Type:** number **Range:** 4-128 **clientid-hash-offset** **Description** Skip part of Client ID to calculate hash value (Offset of the Client ID) **Type:** number **Range:** 0-255 **clientid-hash-persist** **Description** Use Client ID's hash value to select server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** MQTT Template Name **Type:** string **Format:** string-rlx **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 .. _3076_template_cipher-list: template_cipher-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cipher-cfg** **Type:** List **cipher13-cfg** **Type:** List **name** **Description** Cipher Template Name **Type:** string **Format:** string-rlx **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 .. _3076_template_cipher-list_cipher13-cfg: template_cipher-list_cipher13-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cipher13-suite** **Description** 'TLS_AES_256_GCM_SHA384': TLS_AES_256_GCM_SHA384 (0x1302); 'TLS_CHACHA20_POLY1305_SHA256': TLS_CHACHA20_POLY1305_SHA256 (0x1303); 'TLS_AES_128_GCM_SHA256': TLS_AES_128_GCM_SHA256 (0x1301); **Type:** string **Supported Values:** TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_GCM_SHA256 **priority** **Description** Cipher priority (Cipher priority (default 1)) **Type:** number **Range:** 1-100 **Default:** 1 .. _3076_template_cipher-list_cipher-cfg: template_cipher-list_cipher-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cipher-suite** **Description** 'SSL3_RSA_DES_192_CBC3_SHA': TLS_RSA_WITH_3DES_EDE_CBC_SHA (0x000A); 'SSL3_RSA_RC4_128_MD5': TLS_RSA_WITH_RC4_128_MD5 (0x0004); 'SSL3_RSA_RC4_128_SHA': TLS_RSA_WITH_RC4_128_SHA (0x0005); 'TLS1_RSA_AES_128_SHA': TLS_RSA_WITH_AES_128_CBC_SHA (0x002F); 'TLS1_RSA_AES_256_SHA': TLS_RSA_WITH_AES_256_CBC_SHA (0x0035); 'TLS1_RSA_AES_128_SHA256': TLS_RSA_WITH_AES_128_CBC_SHA256 (0x003C); 'TLS1_RSA_AES_256_SHA256': TLS_RSA_WITH_AES_256_CBC_SHA256 (0x003D); 'TLS1_DHE_RSA_AES_128_GCM_SHA256': TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (0x009E); 'TLS1_DHE_RSA_AES_128_SHA': TLS_DHE_RSA_WITH_AES_128_CBC_SHA (0x0033); 'TLS1_DHE_RSA_AES_128_SHA256': TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 (0x0067); 'TLS1_DHE_RSA_AES_256_GCM_SHA384': TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (0x009F); 'TLS1_DHE_RSA_AES_256_SHA': TLS_DHE_RSA_WITH_AES_256_CBC_SHA (0x0039); 'TLS1_DHE_RSA_AES_256_SHA256': TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 (0x006B); 'TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 (0xC02B); 'TLS1_ECDHE_ECDSA_AES_128_SHA': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA (0xC009); 'TLS1_ECDHE_ECDSA_AES_128_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 (0xC023); 'TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 (0xC02C); 'TLS1_ECDHE_ECDSA_AES_256_SHA': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA (0xC00A); 'TLS1_ECDHE_RSA_AES_128_GCM_SHA256': TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xC02F); 'TLS1_ECDHE_RSA_AES_128_SHA': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (0xC013); 'TLS1_ECDHE_RSA_AES_128_SHA256': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (0xC027); 'TLS1_ECDHE_RSA_AES_256_GCM_SHA384': TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xC030); 'TLS1_ECDHE_RSA_AES_256_SHA': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (0xC014); 'TLS1_RSA_AES_128_GCM_SHA256': TLS_RSA_WITH_AES_128_GCM_SHA256 (0x009C); 'TLS1_RSA_AES_256_GCM_SHA384': TLS_RSA_WITH_AES_256_GCM_SHA384 (0x009D); 'TLS1_ECDHE_RSA_AES_256_SHA384': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (0xC028); 'TLS1_ECDHE_ECDSA_AES_256_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 (0xC024); 'TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA8); 'TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA9); 'TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256': TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCAA); 'TLS1_ECDHE_SM2_WITH_SMS4_SM3': TLS_ECDHE_SM2_WITH_SMS4_SM3 (0xE102); 'TLS1_ECDHE_SM2_WITH_SMS4_SHA256': TLS_ECDHE_SM2_WITH_SMS4_SHA256 (0xE105); 'TLS1_ECDHE_SM2_WITH_SMS4_GCM_SM3': TLS_ECDHE_SM2_WITH_SMS4_GCM_SM3 (0xE107); **Type:** string **Supported Values:** SSL3_RSA_DES_192_CBC3_SHA, SSL3_RSA_RC4_128_MD5, SSL3_RSA_RC4_128_SHA, TLS1_RSA_AES_128_SHA, TLS1_RSA_AES_256_SHA, TLS1_RSA_AES_128_SHA256, TLS1_RSA_AES_256_SHA256, TLS1_DHE_RSA_AES_128_GCM_SHA256, TLS1_DHE_RSA_AES_128_SHA, TLS1_DHE_RSA_AES_128_SHA256, TLS1_DHE_RSA_AES_256_GCM_SHA384, TLS1_DHE_RSA_AES_256_SHA, TLS1_DHE_RSA_AES_256_SHA256, TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256, TLS1_ECDHE_ECDSA_AES_128_SHA, TLS1_ECDHE_ECDSA_AES_128_SHA256, TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384, TLS1_ECDHE_ECDSA_AES_256_SHA, TLS1_ECDHE_RSA_AES_128_GCM_SHA256, TLS1_ECDHE_RSA_AES_128_SHA, TLS1_ECDHE_RSA_AES_128_SHA256, TLS1_ECDHE_RSA_AES_256_GCM_SHA384, TLS1_ECDHE_RSA_AES_256_SHA, TLS1_RSA_AES_128_GCM_SHA256, TLS1_RSA_AES_256_GCM_SHA384, TLS1_ECDHE_RSA_AES_256_SHA384, TLS1_ECDHE_ECDSA_AES_256_SHA384, TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256, TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256, TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256, TLS1_ECDHE_SM2_WITH_SMS4_SM3, TLS1_ECDHE_SM2_WITH_SMS4_SHA256, TLS1_ECDHE_SM2_WITH_SMS4_GCM_SM3 **priority** **Description** Cipher priority (Cipher priority (default 1)) **Type:** number **Range:** 1-100 **Default:** 1 .. _3076_template_policy-list: template_policy-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bw-list-id** **Type:** List **bw-list-name** **Description** Specify a blacklist/whitelist name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **class-list** **Description:** class-list is a **JSON Block**. Please see below for :ref:`3076_template_policy-list_class-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/class-list ` **forward-policy** **Description:** forward-policy is a **JSON Block**. Please see below for :ref:`3076_template_policy-list_forward-policy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy ` **full-domain-tree** **Description** Share counters between geo-location and sub regions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **interval** **Description** Log interval (minute) **Type:** number **Range:** 1-255 **name** **Description** Policy template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **over-limit** **Description** Specify operation in case over limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **over-limit-lockup** **Description** Don't accept any new connection for certain time (Lockup duration (minute)) **Type:** number **Range:** 1-127 **over-limit-logging** **Description** Log a message **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **over-limit-reset** **Description** Reset the connection when it exceeds limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **overlap** **Description** Use overlap mode for geo-location to do longest match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sampling-enable** **Type:** List **share** **Description** Share counters between virtual ports and virtual servers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timeout** **Description** Define timeout value of PBSLB dynamic entry (Timeout value (minute, default is 5)) **Type:** number **Range:** 1-127 **Default:** 5 **use-destination-ip** **Description** Use destination IP to match the policy **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 .. _3076_template_policy-list_forward-policy: template_policy-list_forward-policy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **acos-event-log** **Description** Enable acos event logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **action-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/action/{name} ` **dual-stack-action-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/dual-stack-action/{name} ` **enable-adv-match** **Description** Enable adv-match rules and deactive all the other kinds of destination rules **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **filtering** **Type:** List **forward-http-connect-to-icap** **Description** Forward HTTP CONNECT request to ICAP server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **local-logging** **Description** Enable local logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no-client-conn-reuse** **Description** Inspects only first request of a connection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reqmod-icap** **Description** ICAP reqmod template (Reqmod ICAP Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/reqmod-icap ` **require-web-category** **Description** Wait for web category to be resolved before taking proxy decision **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **san-filtering** **Type:** List **source-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name} ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_policy-list_forward-policy_filtering: template_policy-list_forward-policy_filtering ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ssli-url-filtering** **Description** 'bypassed-sni-disable': Disable SNI filtering for bypassed URL's(enabled by default); 'intercepted-sni-enable': Enable SNI filtering for intercepted URL's(disabled by default); 'intercepted-http-disable': Disable HTTP(host/URL) filtering for intercepted URL's(enabled by default); 'no-sni-allow': Allow connection if SNI filtering is enabled and SNI header is not present(Drop by default); **Type:** string **Supported Values:** bypassed-sni-disable, intercepted-sni-enable, intercepted-http-disable, no-sni-allow .. _3076_template_policy-list_forward-policy_san-filtering: template_policy-list_forward-policy_san-filtering ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ssli-url-filtering-san** **Description** 'enable-san': Enable SAN filtering(disabled by default); 'bypassed-san-disable': Disable SAN filtering for bypassed URL's(enabled by default); 'intercepted-san-enable': Enable SAN filtering for intercepted URL's(disabled by default); 'no-san-allow': Allow connection if SAN filtering is enabled and SAN field is not present(Drop by default); **Type:** string **Supported Values:** enable-san, bypassed-san-disable, intercepted-san-enable, no-san-allow .. _3076_template_policy-list_forward-policy_action-list: template_policy-list_forward-policy_action-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action1** **Description** 'forward-to-internet': Forward request to Internet; 'forward-to-service-group': Forward request to service group; 'forward-to-proxy': Forward request to HTTP proxy server; 'drop': Drop request; **Type:** string **Supported Values:** forward-to-internet, forward-to-service-group, forward-to-proxy, drop **drop-message** **Description** drop-message sent to the client as webpage(html tags are included and quotation marks are required for white spaces) **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **Mutual Exclusion:** drop-message and drop-redirect-url are mutually exclusive **drop-redirect-url** **Description** Specify URL to which client request is redirected upon being dropped **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **Mutual Exclusion:** drop-redirect-url, drop-response-code, and drop-message are mutually exclusive **drop-response-code** **Description** Specify response code for drop action **Type:** number **Range:** 100-599 **Mutual Exclusion:** drop-response-code and drop-redirect-url are mutually exclusive **fake-sg** **Description** service group to forward the packets to Internet **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **fall-back** **Description** Fallback service group for Internet **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **fall-back-snat** **Description** Source NAT pool or pool group for fallback server **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fall-back-snat and fall-back-snat-pt-only are mutually exclusive **fall-back-snat-pt-only** **Description** Source port translation only for fallback server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** fall-back-snat-pt-only and fall-back-snat are mutually exclusive **forward-snat** **Description** Source NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** forward-snat and forward-snat-pt-only are mutually exclusive **forward-snat-pt-only** **Description** Source port translation only **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** forward-snat-pt-only and forward-snat are mutually exclusive **http-status-code** **Description** '301': Moved permanently; '302': Found; **Type:** string **Supported Values:** 301, 302 **Default:** 302 **log** **Description** enable logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** Action policy name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **proxy-chaining** **Description** Enable proxy chaining feature **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **proxy-chaining-bypass** **Description** Forward all https packets to upstream proxy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **real-sg** **Description** service group to forward the packets **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **support-cert-fetch** **Description** Fetch server certificate by upstream proxy **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 .. _3076_template_policy-list_forward-policy_action-list_sampling-enable: template_policy-list_forward-policy_action-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of requests matching this destination rule; **Type:** string **Supported Values:** all, hits .. _3076_template_policy-list_forward-policy_dual-stack-action-list: template_policy-list_forward-policy_dual-stack-action-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **fall-back** **Description** Fallback service group **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **fall-back-snat** **Description** Source NAT pool or pool group for fallback **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ipv4** **Description** IPv4 service group to forward **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **ipv4-snat** **Description** IPv4 source NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ipv6** **Description** IPv6 service group to forward **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **ipv6-snat** **Description** IPv6 source NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **log** **Description** enable logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** Action name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **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 .. _3076_template_policy-list_forward-policy_dual-stack-action-list_sampling-enable: template_policy-list_forward-policy_dual-stack-action-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of requests forward by this action; **Type:** string **Supported Values:** all, hits .. _3076_template_policy-list_forward-policy_source-list: template_policy-list_forward-policy_source-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **destination** **Description:** destination is a **JSON Block**. Please see below for :ref:`3076_template_policy-list_forward-policy_source-list_destination` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination ` **match-any** **Description** Match any source **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** match-any and match-class-list are mutually exclusive **match-authorize-policy** **Description** Authorize-policy for user and group based policy **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/aam/authorization/policy ` **match-class-list** **Description** Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** match-class-list and match-any are mutually exclusive **name** **Description** source destination match rule name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **priority** **Description** Priority of the source(higher the number higher the priority, default 0) **Type:** number **Range:** 1-2000 **sampling-enable** **Type:** List **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 .. _3076_template_policy-list_forward-policy_source-list_destination: template_policy-list_forward-policy_source-list_destination ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **adv-match-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/adv-match/{priority} ` **any** **Description:** any is a **JSON Block**. Please see below for :ref:`3076_template_policy-list_forward-policy_source-list_destination_any` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/any ` **class-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/class-list/{dest-class-list} ` **web-category-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/web-category-list/{web-category-list} ` **web-reputation-scope-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/forward-policy/source/{name}/destination/web-reputation-scope/{web-reputation-scope} ` .. _3076_template_policy-list_forward-policy_source-list_destination_class-list-list: template_policy-list_forward-policy_source-list_destination_class-list-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** Action to be performed **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dest-class-list** **Description** Destination Class List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dual-stack-action** **Description** Dual-stack action to be performed **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **priority** **Description** Priority value of the action(higher the number higher the priority) **Type:** number **Range:** 1-1024 **type** **Description** 'host': Match hostname; 'url': Match URL; 'ip': Match destination IP address; **Type:** string **Supported Values:** host, url, ip **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_policy-list_forward-policy_source-list_destination_web-category-list-list: template_policy-list_forward-policy_source-list_destination_web-category-list-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** Action to be performed **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dual-stack-action** **Description** Dual-stack action to be performed **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **priority** **Description** Priority value of the action(higher the number higher the priority) **Type:** number **Range:** 1-1024 **type** **Description** 'host': Match hostname; 'url': match URL; **Type:** string **Supported Values:** host, url **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **web-category-list** **Description** Destination Web Category List Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/web-category/category-list ` .. _3076_template_policy-list_forward-policy_source-list_destination_any: template_policy-list_forward-policy_source-list_destination_any ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** Action to be performed **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** action and dual-stack-action are mutually exclusive **dual-stack-action** **Description** Dual-stack action to be performed **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** dual-stack-action and action are mutually exclusive **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_policy-list_forward-policy_source-list_destination_any_sampling-enable: template_policy-list_forward-policy_source-list_destination_any_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of requests matching this destination rule; **Type:** string **Supported Values:** all, hits .. _3076_template_policy-list_forward-policy_source-list_destination_adv-match-list: template_policy-list_forward-policy_source-list_destination_adv-match-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** Forwading action of this rule **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** action and dual-stack-action are mutually exclusive **disable-reqmod-icap** **Description** Disable REQMOD ICAP template **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-respmod-icap** **Description** Disable RESPMOD ICAP template **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dual-stack-action** **Description** Forwarding action of this rule **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** dual-stack-action and action are mutually exclusive **match-host** **Description** Match request host (HTTP stage) or SNI/SAN (SSL stage) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **match-http-content-encoding** **Description** Match the value of HTTP header "Content-Encoding" **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **match-http-content-length-range-begin** **Description** Match the value of HTTP header "Content-Length" with an inclusive range **Type:** number **Range:** 0-2147483647 **match-http-content-length-range-end** **Description** End of the "Content-Length" range **Type:** number **Range:** 0-2147483647 **match-http-content-type** **Description** Match the value of HTTP header "Content-Type" **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **match-http-header** **Description** Matching the name of all request headers **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **match-http-method-connect** **Description** Match HTTP request method CONNECT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-method-delete** **Description** Match HTTP request method DELETE **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-method-get** **Description** Match HTTP request method GET **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-method-head** **Description** Match HTTP request method HEAD **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-method-options** **Description** Match HTTP request method OPTIONS **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-method-patch** **Description** Match HTTP request method PATCH **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-method-post** **Description** Match HTTP request method POST **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-method-put** **Description** Match HTTP request method PUT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-method-trace** **Description** Match HTTP request method TRACE **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **match-http-request-file-extension** **Description** Match file extension of URL in HTTP request line **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **match-http-url** **Description** Match URL in HTTP request line **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **match-http-url-regex** **Description** Match URI in HTTP request line by given regular expression **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **match-http-user-agent** **Description** Matching the value of HTTP header "User-Agent" **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **match-server-address** **Description** Match target server IP address **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **match-server-port** **Description** Match target server port number **Type:** number **Range:** 1-65535 **Mutual Exclusion:** match-server-port and match-server-port-range-begin are mutually exclusive **match-server-port-range-begin** **Description** Math targer server port range inclusively **Type:** number **Range:** 1-65535 **Mutual Exclusion:** match-server-port-range-begin and match-server-port are mutually exclusive **match-server-port-range-end** **Description** End of port range **Type:** number **Range:** 1-65535 **match-time-range** **Description** Enable rule in this time-range **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/forward-proxy/time-range ` **match-web-category-list** **Description** Match web-category list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/web-category/category-list ` **match-web-reputation-scope** **Description** Match web-reputation scope **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/web-category/reputation-scope ` **notify-page** **Description** Send notify-page to client **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/forward-proxy/notify-page ` **priority** **Description** Rule priority (1000 is highest) **Type:** number **Range:** 1-1000 **sampling-enable** **Type:** List **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 .. _3076_template_policy-list_forward-policy_source-list_destination_adv-match-list_sampling-enable: template_policy-list_forward-policy_source-list_destination_adv-match-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of requests hit this rule; **Type:** string **Supported Values:** all, hits .. _3076_template_policy-list_forward-policy_source-list_destination_web-reputation-scope-list: template_policy-list_forward-policy_source-list_destination_web-reputation-scope-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** Action to be performed **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dual-stack-action** **Description** Dual-stack action to be performed **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **priority** **Description** Priority value of the action(higher the number higher the priority) **Type:** number **Range:** 1-1024 **type** **Description** 'host': Match hostname; 'url': match URL; **Type:** string **Supported Values:** host, url **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **web-reputation-scope** **Description** Destination Web Reputation Scope Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/web-category/reputation-scope ` .. _3076_template_policy-list_forward-policy_source-list_sampling-enable: template_policy-list_forward-policy_source-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of requests matching this source rule; 'destination-match-not-found': Number of requests without matching destination rule; 'no-host-info': Failed to parse ip or host information from request; **Type:** string **Supported Values:** all, hits, destination-match-not-found, no-host-info .. _3076_template_policy-list_class-list: template_policy-list_class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **client-ip-l3-dest** **Description** Use destination IP as client IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** client-ip-l3-dest and client-ip-l7-header are mutually exclusive **client-ip-l7-header** **Description** Use extract client IP address from L7 header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** client-ip-l7-header and client-ip-l3-dest are mutually exclusive **header-name** **Description** Specify L7 header name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **lid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/policy/{name}/class-list/lid/{lidnum} ` **name** **Description** Class list name or geo-location-class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_template_policy-list_class-list_lid-list: template_policy-list_class-list_lid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action-value** **Description** 'forward': Forward the traffic even it exceeds limit; 'reset': Reset the connection when it exceeds limit; **Type:** string **Supported Values:** forward, reset **bw-per** **Description** Per (Specify interval in number of 100ms) **Type:** number **Range:** 1-65535 **bw-rate-limit** **Description** Specify bandwidth rate limit (Bandwidth rate limit in bytes) **Type:** number **Range:** 1-2147483647 **conn-limit** **Description** Connection limit **Type:** number **Range:** 0-1048575 **conn-per** **Description** Per (Specify interval in number of 100ms) **Type:** number **Range:** 1-65535 **conn-rate-limit** **Description** Specify connection rate limit **Type:** number **Range:** 1-2147483647 **direct-action** **Description** Set action when match the lid **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **direct-action-interval** **Description** Specify logging interval in minute (default is 3) **Type:** number **Range:** 0-60 **Default:** 3 **direct-action-value** **Description** 'drop': drop the packet; 'reset': Send reset back; **Type:** string **Supported Values:** drop, reset **Mutual Exclusion:** direct-action-value and direct-service-group are mutually exclusive **direct-fail** **Description** Only log unsuccessful connections **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **direct-logging-drp-rst** **Description** Configure PBSLB logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **direct-pbslb-interval** **Description** Specify logging interval in minutes(default is 3) **Type:** number **Range:** 0-60 **Default:** 3 **direct-pbslb-logging** **Description** Configure PBSLB logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **direct-service-group** **Description** Specify a service group (Specify the service group name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** direct-service-group and direct-action-value are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **dns64** **Description:** dns64 is a **JSON Block**. Please see below for :ref:`3076_template_policy-list_class-list_lid-list_dns64` **Type:** Object **interval** **Description** Specify log interval in minutes, by default system will log every over limit instance **Type:** number **Range:** 1-255 **lidnum** **Description** Specify a limit ID **Type:** number **Range:** 1-1023 **lockout** **Description** Don't accept any new connection for certain time (Lockout duration in minutes) **Type:** number **Range:** 1-1023 **log** **Description** Log a message **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **over-limit-action** **Description** Set action when exceeds limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **request-limit** **Description** Request limit (Specify request limit) **Type:** number **Range:** 1-1048575 **request-per** **Description** Per (Specify interval in number of 100ms) **Type:** number **Range:** 1-65535 **request-rate-limit** **Description** Request rate limit (Specify request rate limit) **Type:** number **Range:** 1-4294967295 **response-code-rate-limit** **Type:** List **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 .. _3076_template_policy-list_class-list_lid-list_dns64: template_policy-list_class-list_lid-list_dns64 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exclusive-answer** **Description** Exclusive Answer in DNS Response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **prefix** **Description** IPv6 prefix **Type:** string **Format:** ipv6-address-plen .. _3076_template_policy-list_class-list_lid-list_response-code-rate-limit: template_policy-list_class-list_lid-list_response-code-rate-limit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **code-range-end** **Description** server response code range end **Type:** number **Range:** 100-600 **code-range-start** **Description** server response code range start **Type:** number **Range:** 100-600 **period** **Description** seconds **Type:** number **Range:** 1-127 **threshold** **Description** the times of getting the response code **Type:** number **Range:** 1-15 .. _3076_template_policy-list_bw-list-id: template_policy-list_bw-list-id ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action-interval** **Description** Specify logging interval in minute (default is 3) **Type:** number **Range:** 0-60 **Default:** 3 **bw-list-action** **Description** 'drop': drop the packet; 'reset': Send reset back; **Type:** string **Supported Values:** drop, reset **Mutual Exclusion:** bw-list-action and service-group are mutually exclusive **fail** **Description** Only log unsuccessful connections **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **id** **Description** Specify id that maps to service group (The id number) **Type:** number **Range:** 0-1023 **logging-drp-rst** **Description** Configure PBSLB logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pbslb-interval** **Description** Specify logging interval in minutes **Type:** number **Range:** 0-60 **Default:** 3 **pbslb-logging** **Description** Configure PBSLB logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group** **Description** Specify a service group (Specify the service group name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** service-group and bw-list-action are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/service-group ` .. _3076_template_policy-list_sampling-enable: template_policy-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'fwd-policy-dns-unresolved': Forward-policy unresolved DNS queries; 'fwd-policy-dns-outstanding': Forward-policy current DNS outstanding requests; 'fwd-policy-snat-fail': Forward-policy source-nat translation failure; 'fwd-policy-hits': Number of forward-policy requests for this policy template; 'fwd-policy-forward-to-internet': Number of forward-policy requests forwarded to internet; 'fwd-policy-forward-to-service-group': Number of forward-policy requests forwarded to service group; 'fwd-policy-forward-to-proxy': Number of forward-policy requests forwarded to proxy; 'fwd-policy-policy-drop': Number of forward-policy requests dropped; 'fwd-policy-source-match-not-found': Forward-policy requests without matching source rule; 'exp-client-hello-not-found': Expected Client HELLO requests not found; **Type:** string **Supported Values:** all, fwd-policy-dns-unresolved, fwd-policy-dns-outstanding, fwd-policy-snat-fail, fwd-policy-hits, fwd-policy-forward-to-internet, fwd-policy-forward-to-service-group, fwd-policy-forward-to-proxy, fwd-policy-policy-drop, fwd-policy-source-match-not-found, exp-client-hello-not-found .. _3076_template_server-list: template_server-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **add** **Description** Slow start connection limit add by a number every interval (Add by this number every interval) **Type:** number **Range:** 1-4095 **Mutual Exclusion:** add and times are mutually exclusive **bw-rate-limit** **Description** Configure bandwidth rate limit on real server (Bandwidth rate limit in Kbps) **Type:** number **Range:** 1-16777216 **bw-rate-limit-acct** **Description** 'to-server-only': Only account for traffic sent to server; 'from-server-only': Only account for traffic received from server; 'all': Account for all traffic sent to and received from server; **Type:** string **Supported Values:** to-server-only, from-server-only, all **Default:** all **bw-rate-limit-duration** **Description** Duration in seconds the observed rate needs to honor **Type:** number **Range:** 1-250 **bw-rate-limit-no-logging** **Description** Do not log bandwidth rate limit related state transitions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bw-rate-limit-resume** **Description** Resume server selection after bandwidth drops below this threshold (in Kbps) (Bandwidth rate limit resume threshold (in Kbps)) **Type:** number **Range:** 1-16777216 **conn-limit** **Description** Connection limit **Type:** number **Range:** 1-64000000 **Default:** 64000000 **conn-limit-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-rate-limit** **Description** Connection rate limit **Type:** number **Range:** 1-1048575 **conn-rate-limit-no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-fail-interval** **Description** The interval to retry when DNS failed to query (DNS failure interval (in second, default is 30)) **Type:** number **Range:** 0-1800 **Default:** 30 **dns-query-interval** **Description** The interval to query DNS server for the hostname (DNS query interval (in minute, default is 10)) **Type:** number **Range:** 1-1440 **Default:** 10 **dynamic-server-prefix** **Description** Prefix of dynamic server (Prefix of dynamic server (default is "DRS")) **Type:** string **Maximum Length:** 3 characters **Maximum Length:** 1 characters **Default:** DRS **every** **Description** Slow start connection limit increment interval (default 10) **Type:** number **Range:** 1-60 **Default:** 10 **extended-stats** **Description** Enable extended statistics on real server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **health-check** **Description** Health Check Monitor (Health monitor name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable configured health check configuration **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive **initial-slow-start** **Description** Initial slow start connection limit (default 128) **Type:** number **Range:** 1-4095 **Default:** 128 **log-selection-failure** **Description** Enable real-time logging for server selection failure event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-dynamic-server** **Description** Maximum dynamic server number (Maximum dynamic server number (default is 255)) **Type:** number **Range:** 1-1023 **Default:** 255 **min-ttl-ratio** **Description** Minimum TTL to DNS query interval ratio (Minimum TTL ratio (default is 2)) **Type:** number **Range:** 1-15 **Default:** 2 **name** **Description** Server template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **rate-interval** **Description** '100ms': Use 100 ms as sampling interval; 'second': Use 1 second as sampling interval; **Type:** string **Supported Values:** 100ms, second **Default:** second **resume** **Description** Resume accepting new connection after connection number drops below threshold (Connection resume threshold) **Type:** number **Range:** 1-1048575 **slow-start** **Description** Slowly ramp up the connection number after server is up **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **spoofing-cache** **Description** Servers under the template are spoofing cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stats-data-action** **Description** 'stats-data-enable': Enable statistical data collection for real server; 'stats-data-disable': Disable statistical data collection for real server; **Type:** string **Supported Values:** stats-data-enable, stats-data-disable **Default:** stats-data-enable **till** **Description** Slow start ends when slow start connection limit reaches a number (default 4096) (Slow start ends when connection limit reaches this number) **Type:** number **Range:** 1-65535 **Default:** 4096 **times** **Description** Slow start connection limit multiply by a number every interval (default 2) (Multiply by this number every interval) **Type:** number **Range:** 2-10 **Default:** 2 **Mutual Exclusion:** times and add are mutually exclusive **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 **weight** **Description** Weight for the Real Servers (Connection Weight (default is 1)) **Type:** number **Range:** 1-1000 **Default:** 1 .. _3076_template_monitor-list: template_monitor-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **clear-cfg** **Type:** List **id** **Description** Monitor template ID Number **Type:** number **Range:** 1-16 **link-disable-cfg** **Type:** List **link-down-cfg** **Type:** List **link-enable-cfg** **Type:** List **link-up-cfg** **Type:** List **monitor-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 .. _3076_template_monitor-list_clear-cfg: 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 .. _3076_template_monitor-list_link-enable-cfg: template_monitor-list_link-enable-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ena-sequence** **Description** Sequence number (Specify the physical port number) **Type:** number **Range:** 1-16 **enaeth** **Description** Specify the physical port number (Ethernet interface number) **Type:** number **Format:** interface .. _3076_template_monitor-list_link-up-cfg: template_monitor-list_link-up-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **link-up-sequence1** **Description** Sequence number (Specify the port physical port number) **Type:** number **Range:** 1-16 **link-up-sequence2** **Description** Sequence number (Specify the port physical port number) **Type:** number **Range:** 1-16 **link-up-sequence3** **Description** Sequence number (Specify the port physical port number) **Type:** number **Range:** 1-16 **linkup-ethernet1** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **linkup-ethernet2** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **linkup-ethernet3** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface .. _3076_template_monitor-list_link-down-cfg: template_monitor-list_link-down-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **link-down-sequence1** **Description** Sequence number (Specify the port physical port number) **Type:** number **Range:** 1-16 **link-down-sequence2** **Description** Sequence number (Specify the port physical port number) **Type:** number **Range:** 1-16 **link-down-sequence3** **Description** Sequence number (Specify the port physical port number) **Type:** number **Range:** 1-16 **linkdown-ethernet1** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **linkdown-ethernet2** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **linkdown-ethernet3** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface .. _3076_template_monitor-list_link-disable-cfg: template_monitor-list_link-disable-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dis-sequence** **Description** Sequence number (Specify the physical port number) **Type:** number **Range:** 1-16 **diseth** **Description** Specify the physical port number (Ethernet interface number) **Type:** number **Format:** interface .. _3076_template_tcp-proxy-list: template_tcp-proxy-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ack-aggressiveness** **Description** 'low': Delayed ACK; 'medium': Delayed ACK, with ACK on each packet with PUSH flag; 'high': ACK on each packet; **Type:** string **Supported Values:** low, medium, high **Default:** low **alive-if-active** **Description** keep connection alive if active traffic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **backend-wscale** **Description** The TCP window scale used for the server side, default is off (number) **Type:** number **Range:** 1-14 **del-session-on-server-down** **Description** Delete session if the server/port goes down (either disabled/hm down) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** send reset to client when server is disabled **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disable and down are mutually exclusive **disable-abc** **Description** Appropriate Byte Counting RFC 3465 Disabled, default is enabled (Appropriate Byte Counting (ABC) is enabled by default) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-sack** **Description** disable Selective Ack Option **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-tcp-timestamps** **Description** disable TCP Timestamps Option **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-window-scale** **Description** disable TCP Window-Scale Option **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **down** **Description** send reset to client when server is down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** down and disable are mutually exclusive **dynamic-buffer-allocation** **Description** Optimally adjust the transmit and receive buffer sizes of TCP proxy while keeping their sum constant **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **early-retransmit** **Description** Configure the Early-Retransmit Algorithm (RFC 5827) (Early-Retransmit is disabled by default) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fin-timeout** **Description** FIN timeout (sec), default is disabled (number) **Type:** number **Range:** 1-60 **force-delete-timeout** **Description** The maximum time that a session can stay in the system before being deleted, default is off (number (second)) **Type:** number **Range:** 1-31 **Mutual Exclusion:** force-delete-timeout and force-delete-timeout-100ms are mutually exclusive **force-delete-timeout-100ms** **Description** The maximum time that a session can stay in the system before being deleted, default is off (number in 100ms) **Type:** number **Range:** 1-31 **Mutual Exclusion:** force-delete-timeout-100ms and force-delete-timeout are mutually exclusive **half-close-idle-timeout** **Description** TCP Half Close Idle Timeout (sec), default is off (cmd is deprecated, use fin-timeout instead) (number) **Type:** number **Range:** 60-120 **half-open-idle-timeout** **Description** TCP Half Open Idle Timeout (sec), default is off (number) **Type:** number **Range:** 1-60 **idle-timeout** **Description** Idle Timeout (Interval of 60 seconds), default is 600 (idle timeout in second, default 600) **Type:** number **Range:** 1-2097151 **Default:** 600 **init-cwnd** **Description** The initial congestion control window size (packets), default is 10 (init-cwnd in packets, default 10) **Type:** number **Range:** 1-15 **Default:** 10 **initial-window-size** **Description** Set the initial window size, default is off (number) **Type:** number **Range:** 1-65535 **insert-client-ip** **Description** Insert client ip into TCP option **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **invalid-rate-limit** **Description** Invalid Packet Response Rate Limit (ms), default is 500 (number default 500 challenges) **Type:** number **Range:** 0-60000000 **Default:** 500 **keepalive-interval** **Description** Interval between keepalive probes (sec), default is off (number (seconds)) **Type:** number **Range:** 60-12000 **keepalive-probes** **Description** Number of keepalive probes sent, default is off **Type:** number **Range:** 2-10 **limited-slowstart** **Description** RFC 3742 Limited Slow-Start for TCP with Large Congestion Windows (number) **Type:** number **Range:** 0-2147483647 **Default:** 0 **maxburst** **Description** The max packet count sent per transmission event (number) **Type:** number **Range:** 1-100 **Default:** 25 **min-rto** **Description** The minmum retransmission timeout, default is 200ms (number) **Type:** number **Range:** 100-1000 **Default:** 200 **mss** **Description** Responding MSS to use if client MSS is large, default is off (number) **Type:** number **Range:** 128-9000 **Default:** 1460 **nagle** **Description** Enable Nagle Algorithm **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **naked-ack-on-handshake** **Description** Send naked ack before data during 3-way handshake **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** TCP Proxy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **proxy-header** **Description:** proxy-header is a **JSON Block**. Please see below for :ref:`3076_template_tcp-proxy-list_proxy-header` **Type:** Object **psh-flag-optimization** **Description** Enable Optimized PSH Flag Use **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **qos** **Description** QOS level (number) **Type:** number **Range:** 1-63 **reassembly-limit** **Description** The reassembly queuing limit, default is 25 segments (number) **Type:** number **Range:** 1-500 **Default:** 25 **reassembly-timeout** **Description** The reassembly timeout, default is 30sec (number) **Type:** number **Range:** 1-300 **Default:** 30 **receive-buffer** **Description** TCP Receive Buffer (default 200k) (number default 200000 bytes) **Type:** number **Range:** 1-2147483647 **Default:** 200000 **reno** **Description** Enable Reno Congestion Control Algorithm **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset-fwd** **Description** send reset to server if error happens **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset-rev** **Description** send reset to client if error happens **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **retransmit-retries** **Description** Number of Retries for Retransmit, default is 5 **Type:** number **Range:** 1-20 **Default:** 5 **server-down-action** **Description** 'FIN': FIN Connection; 'RST': Reset Connection; **Type:** string **Supported Values:** FIN, RST **syn-retries** **Description** SYN Retry Numbers, default is 5 **Type:** number **Range:** 1-20 **Default:** 5 **timewait** **Description** Timewait Threshold (sec), default 5 (number) **Type:** number **Range:** 1-60 **Default:** 5 **transmit-buffer** **Description** TCP Transmit Buffer (default 200k) (number default 200000 bytes) **Type:** number **Range:** 1-2147483647 **Default:** 200000 **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 .. _3076_template_tcp-proxy-list_proxy-header: template_tcp-proxy-list_proxy-header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **proxy-header-action** **Description** 'insert': Insert proxy header; **Type:** string **Supported Values:** insert **version** **Description** 'v1': version 1; 'v2': version 2; **Type:** string **Supported Values:** v1, v2 .. _3076_template_ftp-list: template_ftp-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **active-mode-port** **Description** Non-Standard FTP Active mode port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **active-mode-port-val** **Description** Non-Standard FTP Active mode port **Type:** number **Range:** 1-65534 **Mutual Exclusion:** active-mode-port-val and any are mutually exclusive **any** **Description** Allow any FTP Active mode port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** any and active-mode-port-val are mutually exclusive **name** **Description** FTP template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **to** **Description** End range of FTP Active mode port **Type:** number **Range:** 1-65534 **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 .. _3076_template_imap-pop3-list: template_imap-pop3-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **logindisabled** **Description** Disable Login before STARTTLS.Works only for imap **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** IMAP-POP3 Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **starttls** **Description** 'disabled': Disable STARTTLS; 'optional': STARTTLS is optional requirement; 'enforced': Must issue STARTTLS command before imap transaction; **Type:** string **Supported Values:** disabled, optional, enforced **Default:** disabled **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 .. _3076_template_server-ssl-list: template_server-ssl-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **alert-type** **Description** 'fatal': Log fatal alerts; **Type:** string **Supported Values:** fatal **ca-certs** **Type:** List **certificate** **Description:** certificate is a **JSON Block**. Please see below for :ref:`3076_template_server-ssl-list_certificate` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssl/{name}/certificate ` **cipher-template** **Description** Cipher Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** cipher-template, cipher-wo-prio, and shared-partition-cipher-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/cipher ` **cipher-without-prio-list** **Type:** List **close-notify** **Description** Send close notification when terminate connection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **crl-certs** **Type:** List **dgversion** **Description** Lower TLS/SSL version can be downgraded **Type:** number **Range:** 30-34 **Default:** 31 **dh-type** **Description** '1024': 1024; '1024-dsa': 1024-dsa; '2048': 2048; **Type:** string **Supported Values:** 1024, 1024-dsa, 2048 **early-data** **Description** Enable TLS 1.3 early data (0-RTT) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ec-list** **Type:** List **enable-ssli-ftp-alg** **Description** Enable SSLi FTP over TLS support at which port **Type:** number **Range:** 1-65535 **enable-tls-alert-logging** **Description** Enable TLS alert logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward-proxy-enable** **Description** Enable SSL forward proxy **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **handshake-logging-enable** **Description** Enable SSL handshake logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** Server SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **ocsp-stapling** **Description** Enable ocsp-stapling support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **renegotiation-disable** **Description** Disable SSL renegotiation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-certificate-error** **Type:** List **server-name** **Description** Specify Server Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **session-cache-size** **Description** Session Cache Size (Maximum cache size. Default value 0 (Session ID reuse disabled)) **Type:** number **Range:** 0-128 **Default:** 0 **session-cache-timeout** **Description** Session Cache Timeout (Timeout value, in seconds. Default no timeout.) **Type:** number **Range:** 1-7200 **session-ticket-enable** **Description** Enable server side session ticket support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **shared-partition-cipher-template** **Description** Reference a cipher template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-cipher-template, cipher-wo-prio, and cipher-template are mutually exclusive **ssli-logging** **Description** SSLi logging level, default is error logging only **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sslilogging** **Description** 'disable': Disable all logging; 'all': enable all logging(error, info); **Type:** string **Supported Values:** disable, all **template-cipher-shared** **Description** Cipher Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/cipher ` **use-client-sni** **Description** use client SNI **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 **version** **Description** TLS/SSL version, default is the highest number supported (TLS/SSL version: 30-SSLv3.0, 31-TLSv1.0, 32-TLSv1.1, 33-TLSv1.2 and 34-TLSv1.3) **Type:** number **Range:** 30-34 **Default:** 33 .. _3076_template_server-ssl-list_crl-certs: template_server-ssl-list_crl-certs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **crl** **Description** Certificate Revocation Lists (Certificate Revocation Lists file name) **Type:** string **Maximum Length:** 255 characters **Maximum Length:** 1 characters **crl-partition-shared** **Description** Certificate Revocation Lists Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_template_server-ssl-list_certificate: template_server-ssl-list_certificate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cert** **Description** Certificate Name **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **key** **Description** Client private-key (Key Name) **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **passphrase** **Description** Password Phrase **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** Client Certificate and Key Partition Shared **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 .. _3076_template_server-ssl-list_ec-list: template_server-ssl-list_ec-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ec** **Description** 'secp256r1': X9_62_prime256v1; 'secp384r1': secp384r1; **Type:** string **Supported Values:** secp256r1, secp384r1 .. _3076_template_server-ssl-list_server-certificate-error: template_server-ssl-list_server-certificate-error ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **error-type** **Description** 'email': Notify the error via email; 'ignore': Ignore the error, which mean the connection can continue; 'logging': Log the error; 'trap': Notify the error by SNMP trap; **Type:** string **Supported Values:** email, ignore, logging, trap .. _3076_template_server-ssl-list_ca-certs: template_server-ssl-list_ca-certs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ca-cert** **Description** Specify CA certificate **Type:** string **Format:** string-rlx **Maximum Length:** 245 characters **Maximum Length:** 1 characters **ca-cert-partition-shared** **Description** CA Certificate Partition Shared **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-ocsp-sg** **Description** Specify service-group (Service group name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/aam/authentication/service-group ` **server-ocsp-srvr** **Description** Specify authentication server **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/ocsp ` .. _3076_template_server-ssl-list_cipher-without-prio-list: template_server-ssl-list_cipher-without-prio-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cipher-wo-prio** **Description** 'SSL3_RSA_DES_192_CBC3_SHA': TLS_RSA_WITH_3DES_EDE_CBC_SHA (0x000A); 'SSL3_RSA_RC4_128_MD5': TLS_RSA_WITH_RC4_128_MD5 (0x0004); 'SSL3_RSA_RC4_128_SHA': TLS_RSA_WITH_RC4_128_SHA (0x0005); 'TLS1_RSA_AES_128_SHA': TLS_RSA_WITH_AES_128_CBC_SHA (0x002F); 'TLS1_RSA_AES_256_SHA': TLS_RSA_WITH_AES_256_CBC_SHA (0x0035); 'TLS1_RSA_AES_128_SHA256': TLS_RSA_WITH_AES_128_CBC_SHA256 (0x003C); 'TLS1_RSA_AES_256_SHA256': TLS_RSA_WITH_AES_256_CBC_SHA256 (0x003D); 'TLS1_DHE_RSA_AES_128_GCM_SHA256': TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (0x009E); 'TLS1_DHE_RSA_AES_128_SHA': TLS_DHE_RSA_WITH_AES_128_CBC_SHA (0x0033); 'TLS1_DHE_RSA_AES_128_SHA256': TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 (0x0067); 'TLS1_DHE_RSA_AES_256_GCM_SHA384': TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (0x009F); 'TLS1_DHE_RSA_AES_256_SHA': TLS_DHE_RSA_WITH_AES_256_CBC_SHA (0x0039); 'TLS1_DHE_RSA_AES_256_SHA256': TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 (0x006B); 'TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 (0xC02B); 'TLS1_ECDHE_ECDSA_AES_128_SHA': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA (0xC009); 'TLS1_ECDHE_ECDSA_AES_128_SHA256': TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 (0xC023); 'TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 (0xC02C); 'TLS1_ECDHE_ECDSA_AES_256_SHA': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA (0xC00A); 'TLS1_ECDHE_RSA_AES_128_GCM_SHA256': TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xC02F); 'TLS1_ECDHE_RSA_AES_128_SHA': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (0xC013); 'TLS1_ECDHE_RSA_AES_128_SHA256': TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (0xC027); 'TLS1_ECDHE_RSA_AES_256_GCM_SHA384': TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xC030); 'TLS1_ECDHE_RSA_AES_256_SHA': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (0xC014); 'TLS1_RSA_AES_128_GCM_SHA256': TLS_RSA_WITH_AES_128_GCM_SHA256 (0x009C); 'TLS1_RSA_AES_256_GCM_SHA384': TLS_RSA_WITH_AES_256_GCM_SHA384 (0x009D); 'TLS1_ECDHE_RSA_AES_256_SHA384': TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (0xC028); 'TLS1_ECDHE_ECDSA_AES_256_SHA384': TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 (0xC024); 'TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA8); 'TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256': TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCA9); 'TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256': TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xCCAA); **Type:** string **Supported Values:** SSL3_RSA_DES_192_CBC3_SHA, SSL3_RSA_RC4_128_MD5, SSL3_RSA_RC4_128_SHA, TLS1_RSA_AES_128_SHA, TLS1_RSA_AES_256_SHA, TLS1_RSA_AES_128_SHA256, TLS1_RSA_AES_256_SHA256, TLS1_DHE_RSA_AES_128_GCM_SHA256, TLS1_DHE_RSA_AES_128_SHA, TLS1_DHE_RSA_AES_128_SHA256, TLS1_DHE_RSA_AES_256_GCM_SHA384, TLS1_DHE_RSA_AES_256_SHA, TLS1_DHE_RSA_AES_256_SHA256, TLS1_ECDHE_ECDSA_AES_128_GCM_SHA256, TLS1_ECDHE_ECDSA_AES_128_SHA, TLS1_ECDHE_ECDSA_AES_128_SHA256, TLS1_ECDHE_ECDSA_AES_256_GCM_SHA384, TLS1_ECDHE_ECDSA_AES_256_SHA, TLS1_ECDHE_RSA_AES_128_GCM_SHA256, TLS1_ECDHE_RSA_AES_128_SHA, TLS1_ECDHE_RSA_AES_128_SHA256, TLS1_ECDHE_RSA_AES_256_GCM_SHA384, TLS1_ECDHE_RSA_AES_256_SHA, TLS1_RSA_AES_128_GCM_SHA256, TLS1_RSA_AES_256_GCM_SHA384, TLS1_ECDHE_RSA_AES_256_SHA384, TLS1_ECDHE_ECDSA_AES_256_SHA384, TLS1_ECDHE_RSA_CHACHA20_POLY1305_SHA256, TLS1_ECDHE_ECDSA_CHACHA20_POLY1305_SHA256, TLS1_DHE_RSA_CHACHA20_POLY1305_SHA256 **Mutual Exclusion:** cipher-wo-prio, cipher-template, and shared-partition-cipher-template are mutually exclusive .. _3076_dns-persistent-cache: dns-persistent-cache ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_dns-persistent-cache_sampling-enable: dns-persistent-cache_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_entry': Total persistent cache entry; 'entry_saved': Total saved cache entry; 'entry_deleted': Total deleted cache entry; 'database_busy': Database busy; 'database_error': Database error; **Type:** string **Supported Values:** all, total_entry, entry_saved, entry_deleted, database_busy, database_error .. _3076_link-probe: link-probe ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **entry** **Description:** entry is a **JSON Block**. Please see below for :ref:`3076_link-probe_entry` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/link-probe/entry ` .. _3076_link-probe_entry: link-probe_entry ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_link-probe_entry_sampling-enable: link-probe_entry_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_entries': Current Entry Count; 'total_created': Total Entry Created; 'total_inserted': Total Entry Inserted; 'total_ready_to_free': Total Entry Ready To Free; 'total_freed': Total Entry Freed; 'err_entry_create_failed': Entry Creation Failure; 'err_entry_create_oom': Entry Creation Out of Memory; 'err_entry_insert_failed': Entry Insert Failed; 'err_tmpl_probe_create_failed': Probe Template Creation Failure; 'err_tmpl_probe_create_oom': Probe Template Creation Out of Memory; 'total_http_probes_sent': Total HTTP Probes Sent out; 'total_http_response_received': Total HTTP responses received; 'total_http_response_good': Total HTTP responses matching probe template config; 'total_http_response_bad': Total HTTP responses not matching probe template config; 'total_tcp_err': Total TCP errors in probes sent out; 'err_smart_nat_alloc': Error creating Smart NAT Instance; 'err_smart_nat_port_alloc': Error obtaining Smart NAT source port; 'err_l4_sess_alloc': Error allocating L4 session for probe; 'err_probe_tcp_conn_send': Error in initiating TCP connection for probe; 'probe_tcp_conn_sent': TCP connection sent for probe; **Type:** string **Supported Values:** all, curr_entries, total_created, total_inserted, total_ready_to_free, total_freed, err_entry_create_failed, err_entry_create_oom, err_entry_insert_failed, err_tmpl_probe_create_failed, err_tmpl_probe_create_oom, total_http_probes_sent, total_http_response_received, total_http_response_good, total_http_response_bad, total_tcp_err, err_smart_nat_alloc, err_smart_nat_port_alloc, err_l4_sess_alloc, err_probe_tcp_conn_send, probe_tcp_conn_sent .. _3076_ssl-cert-expire-check: ssl-cert-expire-check ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_dns64: dns64 ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_dns64_sampling-enable: dns64_sampling-enable ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'query': Query; 'query-bad-pkt': Query Bad Packet; 'query-chg': Query Changed; 'query-parallel': Query Parallel; 'query-passive': Query Passive; 'resp': Response; 'resp-bad-pkt': Response Bad Packet; 'resp-bad-qr': Response Bad Query; 'resp-chg': Response Changed; 'resp-err': Response Error; 'resp-empty': Response Empty; 'resp-local': Response Local; 'adjust': Translated; 'cache': Cache; 'drop': Dropped; **Type:** string **Supported Values:** all, query, query-bad-pkt, query-chg, query-parallel, query-passive, resp, resp-bad-pkt, resp-bad-qr, resp-chg, resp-err, resp-empty, resp-local, adjust, cache, drop .. _3076_fast-http-proxy: fast-http-proxy ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_fast-http-proxy_sampling-enable: fast-http-proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num': Num; 'curr_proxy': Curr Proxy Conns; 'total_proxy': Total Proxy Conns; 'req': HTTP requests; 'req_succ': HTTP requests(succ); 'noproxy': No proxy error; 'client_rst': Client RST; 'server_rst': Server RST; 'notuple': No tuple error; 'parsereq_fail': Parse req fail; 'svrsel_fail': Server selection fail; 'fwdreq_fail': Fwd req fail; 'fwdreq_fail_buff': Fwd req fail - buff; 'fwdreq_fail_rport': Fwd req fail - rport; 'fwdreq_fail_route': Fwd req fail - route; 'fwdreq_fail_persist': Fwd req fail - persist; 'fwdreq_fail_server': Fwd req fail - server; 'fwdreq_fail_tuple': Fwd req fail - tuple; 'fwdreqdata_fail': Fwd req data fail; 'req_retran': Packets retrans; 'req_ofo': Packets ofo; 'server_resel': Server reselection; 'svr_prem_close': Server premature close; 'new_svrconn': Server conn made; 'snat_fail': Source NAT failure; 'tcpoutrst': Out RSTs; 'full_proxy': Full proxy tot; 'full_proxy_post': Full proxy POST; 'full_proxy_pipeline': Full proxy pipeline; 'full_proxy_fpga_err': Full proxy fpga err; 'req_over_limit': Request over limit; 'req_rate_over_limit': Request rate over limit; 'l4_switching': L4 switching; 'cookie_switching': Cookie switching; 'aflex_switching': aFleX switching; 'http_policy_switching': HTTP Policy switching; 'url_switching': URL switching; 'host_switching': Host switching; 'lb_switching': Normal LB switching; 'l4_switching_ok': L4 switching (succ); 'cookie_switching_ok': Cookie switching (succ); 'aflex_switching_ok': aFleX switching (succ); 'http_policy_switching_ok': HTTP Policy switching (succ); 'url_switching_ok': URL switching (succ); 'host_switching_ok': Host switching (succ); 'lb_switching_ok': Normal LB switch. (succ); 'l4_switching_enqueue': L4 switching (enQ); 'cookie_switching_enqueue': Cookie switching (enQ); 'aflex_switching_enqueue': aFleX switching (enQ); 'http_policy_switching_enqueue': HTTP Policy switching (enQ); 'url_switching_enqueue': URL switching (enQ); 'host_switching_enqueue': Host switching (enQ); 'lb_switching_enqueue': Normal LB switch. (enQ); 'retry_503': Retry on 503; 'aflex_retry': aFleX http retry; 'aflex_lb_reselect': aFleX lb reselect; 'aflex_lb_reselect_ok': aFleX lb reselect (succ); 'client_rst_request': Client RST - request; 'client_rst_connecting': Client RST - connecting; 'client_rst_connected': Client RST - connected; 'client_rst_response': Client RST - response; 'server_rst_request': Server RST - request; 'server_rst_connecting': Server RST - connecting; 'server_rst_connected': Server RST - connected; 'server_rst_response': Server RST - response; 'invalid_header': Invalid header; 'too_many_headers': Too many headers; 'line_too_long': Line too long; 'header_name_too_long': Header name too long; 'wrong_resp_header': Wrong response header; 'header_insert': Header insert; 'header_delete': Header delete; 'insert_client_ip': Insert client IP; 'negative_req_remain': Negative request remain; 'negative_resp_remain': Negative response remain; 'large_cookie': Large cookies; 'large_cookie_header': Large cookie headers; 'huge_cookie': Huge cookies; 'huge_cookie_header': Huge cookie headers; 'parse_cookie_fail': Parse cookie fail; 'parse_setcookie_fail': Parse set-cookie fail; 'asm_cookie_fail': Assemble cookie fail; 'asm_cookie_header_fail': Asm cookie header fail; 'asm_setcookie_fail': Assemble set-cookie fail; 'asm_setcookie_header_fail': Asm set-cookie hdr fail; 'client_req_unexp_flag': Client req unexp flags; 'connecting_fin': Connecting FIN; 'connecting_fin_retrans': Connecting FIN retran; 'connecting_fin_ofo': Connecting FIN ofo; 'connecting_rst': Connecting RST; 'connecting_rst_retrans': Connecting RST retran; 'connecting_rst_ofo': Connecting RST ofo; 'connecting_ack': Connecting ACK; 'pkts_ofo': Packets ofo; 'pkts_retrans': Packets retrans; 'pkts_retrans_ack_finwait': retrans ACK FWAIT; 'pkts_retrans_fin': retrans FIN; 'pkts_retrans_rst': retrans RST; 'pkts_retrans_push': retrans PSH; 'stale_sess': Stale sess; 'server_resel_failed': Server re-select failed; 'compression_before': Tot data before compress; 'compression_after': Tot data after compress; 'response_1xx': Status code 1XX; 'response_100': Status code 100; 'response_101': Status code 101; 'response_102': Status code 102; 'response_2xx': Status code 2XX; 'response_200': Status code 200; 'response_201': Status code 201; 'response_202': Status code 202; 'response_203': Status code 203; 'response_204': Status code 204; 'response_205': Status code 205; 'response_206': Status code 206; 'response_207': Status code 207; 'response_3xx': Status code 3XX; 'response_300': Status code 300; 'response_301': Status code 301; 'response_302': Status code 302; 'response_303': Status code 303; 'response_304': Status code 304; 'response_305': Status code 305; 'response_306': Status code 306; 'response_307': Status code 307; 'response_4xx': Status code 4XX; 'response_400': Status code 400; 'response_401': Status code 401; 'response_402': Status code 402; 'response_403': Status code 403; 'response_404': Status code 404; 'response_405': Status code 405; 'response_406': Status code 406; 'response_407': Status code 407; 'response_408': Status code 408; 'response_409': Status code 409; 'response_410': Status code 410; 'response_411': Status code 411; 'response_412': Status code 412; 'response_413': Status code 413; 'response_414': Status code 414; 'response_415': Status code 415; 'response_416': Status code 416; 'response_417': Status code 417; 'response_418': Status code 418; 'response_422': Status code 422; 'response_423': Status code 423; 'response_424': Status code 424; 'response_425': Status code 425; 'response_426': Status code 426; 'response_449': Status code 449; 'response_450': Status code 450; 'response_5xx': Status code 5XX; 'response_500': Status code 500; 'response_501': Status code 501; 'response_502': Status code 502; 'response_503': Status code 503; 'response_504': Status code 504; 'response_505': Status code 505; 'response_506': Status code 506; 'response_507': Status code 507; 'response_508': Status code 508; 'response_509': Status code 509; 'response_510': Status code 510; 'response_6xx': Status code 6XX; 'response_unknown': Status code unknown; 'req_http10': Request 1.0; 'req_http11': Request 1.1; 'response_http10': Resp 1.0; 'response_http11': Resp 1.1; 'req_get': Method GET; 'req_head': Method HEAD; 'req_put': Method PUT; 'req_post': Method POST; 'req_trace': Method TRACE; 'req_options': Method OPTIONS; 'req_connect': Method CONNECT; 'req_delete': Method DELETE; 'req_unknown': Method UNKNOWN; 'req_content_len': Req content len; 'rsp_content_len': Resp content len; 'rsp_chunk': Resp chunk encoding; 'req_chunk': Req chunk encoding; 'compress_rsp': Compress req; 'compress_del_accept_enc': Compress del accept enc; 'compress_resp_already_compressed': Resp already compressed; 'compress_content_type_excluded': Compress cont type excl; 'compress_no_content_type': Compress no cont type; 'compress_resp_lt_min': Compress resp less than min; 'compress_resp_no_cl_or_ce': Compress resp no CL/CE; 'compress_ratio_too_high': Compress ratio too high; 'cache_rsp': HTTP req (cache succ); 'close_on_ddos': Close on DDoS; 'req_http10_keepalive': 1.0 Keepalive; 'req_sz_1k': Req less than equal to 1K; 'req_sz_2k': Req less than equal to 2K; **Type:** string **Supported Values:** all, num, curr_proxy, total_proxy, req, req_succ, noproxy, client_rst, server_rst, notuple, parsereq_fail, svrsel_fail, fwdreq_fail, fwdreq_fail_buff, fwdreq_fail_rport, fwdreq_fail_route, fwdreq_fail_persist, fwdreq_fail_server, fwdreq_fail_tuple, fwdreqdata_fail, req_retran, req_ofo, server_resel, svr_prem_close, new_svrconn, snat_fail, tcpoutrst, full_proxy, full_proxy_post, full_proxy_pipeline, full_proxy_fpga_err, req_over_limit, req_rate_over_limit, l4_switching, cookie_switching, aflex_switching, http_policy_switching, url_switching, host_switching, lb_switching, l4_switching_ok, cookie_switching_ok, aflex_switching_ok, http_policy_switching_ok, url_switching_ok, host_switching_ok, lb_switching_ok, l4_switching_enqueue, cookie_switching_enqueue, aflex_switching_enqueue, http_policy_switching_enqueue, url_switching_enqueue, host_switching_enqueue, lb_switching_enqueue, retry_503, aflex_retry, aflex_lb_reselect, aflex_lb_reselect_ok, client_rst_request, client_rst_connecting, client_rst_connected, client_rst_response, server_rst_request, server_rst_connecting, server_rst_connected, server_rst_response, invalid_header, too_many_headers, line_too_long, header_name_too_long, wrong_resp_header, header_insert, header_delete, insert_client_ip, negative_req_remain, negative_resp_remain, large_cookie, large_cookie_header, huge_cookie, huge_cookie_header, parse_cookie_fail, parse_setcookie_fail, asm_cookie_fail, asm_cookie_header_fail, asm_setcookie_fail, asm_setcookie_header_fail, client_req_unexp_flag, connecting_fin, connecting_fin_retrans, connecting_fin_ofo, connecting_rst, connecting_rst_retrans, connecting_rst_ofo, connecting_ack, pkts_ofo, pkts_retrans, pkts_retrans_ack_finwait, pkts_retrans_fin, pkts_retrans_rst, pkts_retrans_push, stale_sess, server_resel_failed, compression_before, compression_after, response_1xx, response_100, response_101, response_102, response_2xx, response_200, response_201, response_202, response_203, response_204, response_205, response_206, response_207, response_3xx, response_300, response_301, response_302, response_303, response_304, response_305, response_306, response_307, response_4xx, response_400, response_401, response_402, response_403, response_404, response_405, response_406, response_407, response_408, response_409, response_410, response_411, response_412, response_413, response_414, response_415, response_416, response_417, response_418, response_422, response_423, response_424, response_425, response_426, response_449, response_450, response_5xx, response_500, response_501, response_502, response_503, response_504, response_505, response_506, response_507, response_508, response_509, response_510, response_6xx, response_unknown, req_http10, req_http11, response_http10, response_http11, req_get, req_head, req_put, req_post, req_trace, req_options, req_connect, req_delete, req_unknown, req_content_len, rsp_content_len, rsp_chunk, req_chunk, compress_rsp, compress_del_accept_enc, compress_resp_already_compressed, compress_content_type_excluded, compress_no_content_type, compress_resp_lt_min, compress_resp_no_cl_or_ce, compress_ratio_too_high, cache_rsp, close_on_ddos, req_http10_keepalive, req_sz_1k, req_sz_2k **counters2** **Description** 'req_sz_4k': Req less than equal to 4K; 'req_sz_8k': Req less than equal to 8K; 'req_sz_16k': Req less than equal to 16K; 'req_sz_32k': Req less than equal to 32K; 'req_sz_64k': Req less than equal to 64K; 'req_sz_256k': Req less than equal to 256K; 'req_sz_gt_256k': Req greater than 256K; 'rsp_sz_1k': Resp less than equal to 1K; 'rsp_sz_2k': Resp less than equal to 2K; 'rsp_sz_4k': Resp less than equal to 4K; 'rsp_sz_8k': Resp less than equal to 8K; 'rsp_sz_16k': Resp less than equal to 16K; 'rsp_sz_32k': Resp less than equal to 32K; 'rsp_sz_64k': Resp less than equal to 64K; 'rsp_sz_256k': Resp less than equal to 256K; 'rsp_sz_gt_256k': Resp greater than 256K; 'chunk_sz_512': Chunk less than equal to 512; 'chunk_sz_1k': Chunk less than equal to 1K; 'chunk_sz_2k': Chunk less than equal to 2K; 'chunk_sz_4k': Chunk less than equal to 4K; 'chunk_sz_gt_4k': Chunk greater than 4K; 'pconn_connecting': pconn connecting; 'pconn_connected': pconn connected; 'pconn_connecting_failed': pconn conn failed; 'chunk_bad': Bad Chunk; 'req_10u': Rsp time less than 10u; 'req_20u': Rsp time less than 20u; 'req_50u': Rsp time less than 50u; 'req_100u': Rsp time less than 100u; 'req_200u': Rsp time less than 200u; 'req_500u': Rsp time less than 500u; 'req_1m': Rsp time less than 1m; 'req_2m': Rsp time less than 2m; 'req_5m': Rsp time less than 5m; 'req_10m': Rsp time less than 10m; 'req_20m': Rsp time less than 20m; 'req_50m': Rsp time less than 50m; 'req_100m': Rsp time less than 100m; 'req_200m': Rsp time less than 200m; 'req_500m': Rsp time less than 500m; 'req_1s': Rsp time less than 1s; 'req_2s': Rsp time less than 2s; 'req_5s': Rsp time less than 5s; 'req_over_5s': Rsp time greater than equal to 5s; 'insert_client_port': Insert client Port; 'req_track': Method TRACK; 'full_proxy_put': Full proxy PUT; 'non_http_bypass': Non-HTTP bypass; 'skip_insert_client_ip': Skip Insert Client IP; 'skip_insert_client_port': Skip Insert Client Port; 'decompression_before': Tot data before decompress; 'decompression_after': Tot data after decompress; 'http_pkts_in_seq': Tot In-seq fHTTP packets; 'http_pkts_retx': Tot Re-Tx fHTTP packets; 'http_client_retx': Client Re-Tx fHTTP packets; 'http_server_retx': Server Re-Tx fHTTP packets; 'http_pkts_ofo': fHTTP Out of Order packets; **Type:** string **Supported Values:** req_sz_4k, req_sz_8k, req_sz_16k, req_sz_32k, req_sz_64k, req_sz_256k, req_sz_gt_256k, rsp_sz_1k, rsp_sz_2k, rsp_sz_4k, rsp_sz_8k, rsp_sz_16k, rsp_sz_32k, rsp_sz_64k, rsp_sz_256k, rsp_sz_gt_256k, chunk_sz_512, chunk_sz_1k, chunk_sz_2k, chunk_sz_4k, chunk_sz_gt_4k, pconn_connecting, pconn_connected, pconn_connecting_failed, chunk_bad, req_10u, req_20u, req_50u, req_100u, req_200u, req_500u, req_1m, req_2m, req_5m, req_10m, req_20m, req_50m, req_100m, req_200m, req_500m, req_1s, req_2s, req_5s, req_over_5s, insert_client_port, req_track, full_proxy_put, non_http_bypass, skip_insert_client_ip, skip_insert_client_port, decompression_before, decompression_after, http_pkts_in_seq, http_pkts_retx, http_client_retx, http_server_retx, http_pkts_ofo .. _3076_hm-dplane: hm-dplane ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_hm-dplane_sampling-enable: hm-dplane_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_entries': Current HM Entries; 'total_created': Total HM Entries Created; 'total_inserted': Total HM entries inserted; 'total_ready_to_free': Total HM entries ready to free; 'total_freed': Total HM entries freed; 'err_entry_create_failed': Entry Creation Failure; 'err_entry_create_oom': Entry creation out of memory; 'err_entry_insert_failed': Entry insert failed; 'total_tcp_err': Total TCP errors in health-checks sent; 'err_smart_nat_alloc': Error creating smart-nat instance; 'err_smart_nat_port_alloc': Error obtaining smart-nat source port; 'err_l4_sess_alloc': Error allocating L4 session for HM; 'err_hm_tcp_conn_sent': Error in initiating TCP connection for HM; 'hm_tcp_conn_sent': Total TCP connections sent for HM; 'entry_deleted': Entry deleted; 'err_entry_create_vip_failed': Error in creating HM internal VIP; 'total_match_resp_code': Total HTTP received response with match response code; 'total_match_default_resp_code': Total HTTP received response with match 200 response code; 'total_maintenance_received': Total maintenace response received; 'total_wrong_status_received': Total HTTP received response with wrong response code; 'err_no_hm_entry': Error no HM entry found; 'err_ssl_cert_name_mismatch': Error SSL cert name mismatch; 'err_server_syn_timeout': Error SSL server SYN timeout; 'err_http2_callback': Error HTTP2 callback; 'err_l7_sess_process_tcp_estab_failed': L7 session process TCP established failed; 'err_l7_sess_process_tcp_data_failed': L7 session process TCP data failed; 'err_http2_ver_mismatch': Error HTTP2 version mismatch; 'smart_nat_alloc': Total smart-nat allocation successful; 'smart_nat_release': Total smart-nat release successful; 'smart_nat_alloc_failed': Total smart-nat allocation failed; 'smart_nat_release_failed': Total smart-nat release failed; 'total_server_quic_conn': Total start server QUIC connections; 'total_server_quic_conn_err': Total start server QUIC connections error; **Type:** string **Supported Values:** all, curr_entries, total_created, total_inserted, total_ready_to_free, total_freed, err_entry_create_failed, err_entry_create_oom, err_entry_insert_failed, total_tcp_err, err_smart_nat_alloc, err_smart_nat_port_alloc, err_l4_sess_alloc, err_hm_tcp_conn_sent, hm_tcp_conn_sent, entry_deleted, err_entry_create_vip_failed, total_match_resp_code, total_match_default_resp_code, total_maintenance_received, total_wrong_status_received, err_no_hm_entry, err_ssl_cert_name_mismatch, err_server_syn_timeout, err_http2_callback, err_l7_sess_process_tcp_estab_failed, err_l7_sess_process_tcp_data_failed, err_http2_ver_mismatch, smart_nat_alloc, smart_nat_release, smart_nat_alloc_failed, smart_nat_release_failed, total_server_quic_conn, total_server_quic_conn_err .. _3076_ssl-ca-cert: ssl-ca-cert ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_connection-reuse: connection-reuse ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_connection-reuse_sampling-enable: connection-reuse_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'current_open': Open persist; 'current_active': Active persist; 'nbind': Total bind; 'nunbind': Total unbind; 'nestab': Total established; 'ntermi': Total terminated; 'ntermi_err': Total terminated by err; 'delay_unbind': Delayed unbind; 'long_resp': Long resp; 'miss_resp': Missed resp; 'unbound_data_rcv': Unbound data rcvd; 'pause_conn': Pause request; 'pause_conn_fail': Pause request fail; 'resume_conn': Resume request; 'not_remove_from_rport': Not remove from list; **Type:** string **Supported Values:** all, current_open, current_active, nbind, nunbind, nestab, ntermi, ntermi_err, delay_unbind, long_resp, miss_resp, unbound_data_rcv, pause_conn, pause_conn_fail, resume_conn, not_remove_from_rport .. _3076_mssql: mssql ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_mssql_sampling-enable: mssql_sampling-enable ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_proxy': Curr Proxy Conns; 'total_proxy': Total Proxy Conns; 'curr_be_enc': Curr BE Encryption Conns; 'total_be_enc': Total BE Encryption Conns; 'curr_fe_enc': Curr FE Encryption Conns; 'total_fe_enc': Total FE Encryption Conns; 'client_fin': Client FIN; 'server_fin': Server FIN; 'session_err': Session err; 'queries': DB Queries; 'commands': DB commands reply; 'auth_success': Authentication Success; 'auth_failure': Authentication Failure; **Type:** string **Supported Values:** all, curr_proxy, total_proxy, curr_be_enc, total_be_enc, curr_fe_enc, total_fe_enc, client_fin, server_fin, session_err, queries, commands, auth_success, auth_failure .. _3076_resource-usage: resource-usage ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cache-template-count** **Description** Total configurable HTTP Cache Templates in the System **Type:** number **client-ssl-template-count** **Description** Total configurable Client SSL Templates in the System **Type:** number **conn-reuse-template-count** **Description** Total configurable Connection reuse Templates in the System **Type:** number **fast-tcp-template-count** **Description** Total configurable Fast TCP Templates in the System **Type:** number **fast-udp-template-count** **Description** Total configurable Fast UDP Templates in the System **Type:** number **fix-template-count** **Description** Total configurable FIX Templates in the System **Type:** number **gslb-device-count** **Description** Total GSLB devices in the System **Type:** number **gslb-geo-location-count** **Description** Total GSLB geo-location in the System **Type:** number **gslb-ip-list-count** **Description** Total GSLB ip-list in the System **Type:** number **gslb-policy-count** **Description** Total GSLB policies in the System **Type:** number **gslb-service-count** **Description** Total GSLB services in the System **Type:** number **gslb-service-ip-count** **Description** Total GSLB service-ip in the System **Type:** number **gslb-service-port-count** **Description** Total GSLB service-port in the System **Type:** number **gslb-site-count** **Description** Total GSLB sites in the System **Type:** number **gslb-svc-group-count** **Description** Total GSLB services in the System **Type:** number **gslb-template-count** **Description** Total GSLB templates in the System **Type:** number **gslb-zone-count** **Description** Total GSLB zones in the System **Type:** number **health-monitor-count** **Description** Total Health Monitors in the System **Type:** number **http-template-count** **Description** Total configurable HTTP Templates in the System **Type:** number **link-cost-template-count** **Description** Total configurable Link-cost Templates in the System **Type:** number **nat-pool-addr-count** **Description** Total configurable NAT Pool addresses in the System (deprecated) **Type:** number **pbslb-entry-count** **Description** Total configurable pbslb entry in the System **Type:** number **pbslb-subnet-count** **Description** Total PBSLB Subnets in the System **Type:** number **persist-cookie-template-count** **Description** Total configurable Persistent cookie Templates in the System **Type:** number **persist-srcip-template-count** **Description** Total configurable Source IP Persistent Templates in the System **Type:** number **proxy-template-count** **Description** Total configurable Proxy Templates in the System **Type:** number **real-port-count** **Description** Total Real Server Ports in the System **Type:** number **real-server-count** **Description** Total Real Servers in the System **Type:** number **server-ssl-template-count** **Description** Total configurable Server SSL Templates in the System **Type:** number **service-group-count** **Description** Total Service Groups in the System **Type:** number **slb-threshold-res-usage-percent** **Description** Enter the threshold as a percentage (Threshold in percentage(default is 0%)) **Type:** number **Range:** 0-99 **Default:** 0 **stream-template-count** **Description** Total configurable Streaming media in the System **Type:** number **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **virtual-port-count** **Description** Total Virtual Server Ports in the System **Type:** number **virtual-server-count** **Description** Total Virtual Servers in the System **Type:** number .. _3076_ssl-cmp-cert-log: ssl-cmp-cert-log ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ecmp: ecmp ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_health-gateway: health-gateway ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_health-gateway_sampling-enable: health-gateway_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_sent': Number of Total health-check sent; 'total_retry_sent': Number of Total health-check retry sent; 'total_timeout': Number of Total health-check timeout; **Type:** string **Supported Values:** all, total_sent, total_retry_sent, total_timeout .. _3076_health-up-reason: health-up-reason ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_transparent-tcp-template: transparent-tcp-template ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **name** **Description** Specify template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Reference Object:** :doc:`/axapi/v3/slb/template/tcp ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_health-monitor: health-monitor ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-cert: ssl-cert ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_crl-srcip: crl-srcip ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_crl-srcip_sampling-enable: crl-srcip_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'sessions_alloc': Sessions allocated; 'sessions_freed': Sessions freed; 'out_of_sessions': Out of sessions; 'too_many_sessions': Too many sessions consumed; 'called': Threshold check count; 'permitted': Honor threshold count; 'threshold_exceed': Threshold exceeded count; 'lockout_drop': Lockout drops; 'log_msg_sent': Log messages sent; **Type:** string **Supported Values:** all, sessions_alloc, sessions_freed, out_of_sessions, too_many_sessions, called, permitted, threshold_exceed, lockout_drop, log_msg_sent .. _3076_proxy: proxy ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_proxy_sampling-enable: proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num': Num; 'tcp_event': TCP stack event; 'est_event': Connection established; 'data_event': Data received; 'client_fin': Client FIN; 'server_fin': Server FIN; 'wbuf_event': Ready to send data; 'err_event': Error occured; 'no_mem': No memory; 'client_rst': Client RST; 'server_rst': Server RST; 'queue_depth_over_limit': Queue depth over limit; 'event_failed': Event failed; 'conn_not_exist': Conn not exist; 'service_alloc_cb': Service alloc callback; 'service_alloc_cb_failed': Service alloc callback failed; 'service_free_cb': Service free callback; 'service_free_cb_failed': Service free callback failed; 'est_cb_failed': App EST callback failed; 'data_cb_failed': App DATA callback failed; 'wbuf_cb_failed': App WBUF callback failed; 'err_cb_failed': App ERR callback failed; 'start_server_conn': Start server conn; 'start_server_conn_succ': Success; 'start_server_conn_no_route': No route to server; 'start_server_conn_fail_mem': No memory; 'start_server_conn_fail_snat': Failed Source NAT; 'start_server_conn_fail_persist': Fail Persistence; 'start_server_conn_fail_server': Fail Server issue; 'start_server_conn_fail_tuple': Fail Tuple Issue; 'line_too_long': Line too long; **Type:** string **Supported Values:** all, num, tcp_event, est_event, data_event, client_fin, server_fin, wbuf_event, err_event, no_mem, client_rst, server_rst, queue_depth_over_limit, event_failed, conn_not_exist, service_alloc_cb, service_alloc_cb_failed, service_free_cb, service_free_cb_failed, est_cb_failed, data_cb_failed, wbuf_cb_failed, err_cb_failed, start_server_conn, start_server_conn_succ, start_server_conn_no_route, start_server_conn_fail_mem, start_server_conn_fail_snat, start_server_conn_fail_persist, start_server_conn_fail_server, start_server_conn_fail_tuple, line_too_long .. _3076_passthrough: passthrough ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_passthrough_sampling-enable: passthrough_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_conn': Current connections; 'total_conn': Total connections; 'total_fwd_bytes': Forward bytes; 'total_fwd_packets': Forward packets; 'total_rev_bytes': Reverse bytes; 'total_rev_packets': Reverse packets; 'curr_pconn': Persistent connections; **Type:** string **Supported Values:** all, curr_conn, total_conn, total_fwd_bytes, total_fwd_packets, total_rev_bytes, total_rev_packets, curr_pconn .. _3076_rpz: rpz ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **check** **Description** Check Response Policy Zone file **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_rpz_sampling-enable: rpz_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'set_bw_error': Total RPZ Set Class-list Error; 'parse_error': Total RPZ Parse Error; **Type:** string **Supported Values:** all, set_bw_error, parse_error .. _3076_forward-proxy: forward-proxy ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **notify-page-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/forward-proxy/notify-page/{name} ` **time-range-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/forward-proxy/time-range/{name} ` .. _3076_forward-proxy_time-range-list: forward-proxy_time-range-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **daily-begin** **Description** Daily enables after this time (HH:MM, 24-hour notation) **Type:** string **Maximum Length:** 5 characters **Maximum Length:** 4 characters **daily-end** **Description** Daily enables until thie time (HH:MM, 24-hour notation, inclusive) **Type:** string **Maximum Length:** 5 characters **Maximum Length:** 4 characters **days-of-month-begin** **Description** Recurring enables after this day per month **Type:** number **Range:** 1-31 **days-of-month-end** **Description** Recurring enables until this day per month (inclusive) **Type:** number **Range:** 1-31 **months-of-year-begin** **Description** Recurring enables after this month per year **Type:** number **Range:** 1-12 **months-of-year-end** **Description** Recurring enables until this month per year (inclusive) **Type:** number **Range:** 1-12 **name** **Description** Name of this object **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **use-utc-time** **Description** Use UTC+0 time **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 **weekday-fr** **Description** Recurring enables on Friday **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weekday-mo** **Description** Recurring enables on Monday **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weekday-sa** **Description** Recurring enables on Saturday **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weekday-su** **Description** Recurring enables on Sunday **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weekday-th** **Description** Recurring enables on Thursday **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weekday-tu** **Description** Recurring enables on Tuesday **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weekday-we** **Description** Recurring enables on Wednesday **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_forward-proxy_notify-page-list: forward-proxy_notify-page-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **message** **Description** Message in notify page **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **name** **Description** Name of this object **Type:** string **Format:** string-rlx **Maximum Length:** 63 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 .. _3076_tsig: tsig ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **check** **Description** Check TSIG file **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-acme-cert-status: ssl-acme-cert-status ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_perf: perf ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_perf_sampling-enable: perf_sampling-enable ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total-throughput-bits-per-sec': Total Throughput in bits/sec; 'l4-conns-per-sec': L4 Connections/sec; 'l7-conns-per-sec': L7 Connections/sec; 'l7-trans-per-sec': L7 Transactions/sec; 'ssl-conns-per-sec': SSL Connections/sec; 'ip-nat-conns-per-sec': IP NAT Connections/sec; 'total-new-conns-per-sec': Total New Connections Established/sec; 'total-curr-conns': Total Current Established Connections; 'l4-bandwidth': L4 Bandwidth in bits/sec; 'l7-bandwidth': L7 Bandwidth in bits/sec; 'serv-ssl-conns-per-sec': Server SSL Connections/sec; 'fw-conns-per-sec': FW Connections/sec; 'gifw-conns-per-sec': GiFW Connections/sec; 'l7-proxy-conns-per-sec': L7 Proxy Connections/sec; 'l7-proxy-trans-per-sec': L7 Proxy Transactions/sec; **Type:** string **Supported Values:** all, total-throughput-bits-per-sec, l4-conns-per-sec, l7-conns-per-sec, l7-trans-per-sec, ssl-conns-per-sec, ip-nat-conns-per-sec, total-new-conns-per-sec, total-curr-conns, l4-bandwidth, l7-bandwidth, serv-ssl-conns-per-sec, fw-conns-per-sec, gifw-conns-per-sec, l7-proxy-conns-per-sec, l7-proxy-trans-per-sec .. _3076_dns: dns ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_dns_sampling-enable: dns_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'slb_req': No. of requests; 'slb_resp': No. of responses; 'slb_no_resp': No. of requests with no response; 'slb_req_rexmit': No. of requests retransmit; 'slb_resp_no_match': No. of requests and responses with no match; 'slb_no_resource': No. of resource failures; 'nat_req': (NAT) No. of requests; 'nat_resp': (NAT) No. of responses; 'nat_no_resp': (NAT) No. of resource failures; 'nat_req_rexmit': (NAT) No. of request retransmits; 'nat_resp_no_match': (NAT) No. of requests with no response; 'nat_no_resource': (NAT) No. of resource failures; 'nat_xid_reused': (NAT) No. of requests reusing a transaction id; 'filter_type_drop': Total Query Type Drop; 'filter_class_drop': Total Query Class Drop; 'filter_type_any_drop': Total Query ANY Type Drop; 'slb_dns_client_ssl_succ': No. of client ssl success; 'slb_dns_server_ssl_succ': No. of server ssl success; 'slb_dns_udp_conn': No. of backend udp connections; 'slb_dns_udp_conn_succ': No. of backend udp conn established; 'slb_dns_padding_to_server_removed': some help string; 'slb_dns_padding_to_client_added': some help string; 'slb_dns_edns_subnet_to_server_removed': some help string; 'slb_dns_udp_retransmit': some help string; 'slb_dns_udp_retransmit_fail': some help string; 'rpz_action_drop': RPZ Action Drop; 'rpz_action_pass_thru': RPZ Action Pass Through; 'rpz_action_tcp_only': RPZ Action TCP Only; 'rpz_action_nxdomain': RPZ Action NXDOMAIN; 'rpz_action_nodata': RPZ Action NODATA; 'rpz_action_local_data': RPZ Action Local Data; 'slb_drop': DNS requests drop; 'nat_slb_drop': (NAT)DNS requests drop; 'invalid_q_len_to_udp': invalid query length to conver to UDP; 'slb_dns_edns_ecs_received': Number of ecs from client received; 'slb_dns_edns_ecs_inserted': Number of ecs inserted; **Type:** string **Supported Values:** all, slb_req, slb_resp, slb_no_resp, slb_req_rexmit, slb_resp_no_match, slb_no_resource, nat_req, nat_resp, nat_no_resp, nat_req_rexmit, nat_resp_no_match, nat_no_resource, nat_xid_reused, filter_type_drop, filter_class_drop, filter_type_any_drop, slb_dns_client_ssl_succ, slb_dns_server_ssl_succ, slb_dns_udp_conn, slb_dns_udp_conn_succ, slb_dns_padding_to_server_removed, slb_dns_padding_to_client_added, slb_dns_edns_subnet_to_server_removed, slb_dns_udp_retransmit, slb_dns_udp_retransmit_fail, rpz_action_drop, rpz_action_pass_thru, rpz_action_tcp_only, rpz_action_nxdomain, rpz_action_nodata, rpz_action_local_data, slb_drop, nat_slb_drop, invalid_q_len_to_udp, slb_dns_edns_ecs_received, slb_dns_edns_ecs_inserted .. _3076_virtual-server-list: virtual-server-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-id** **Description** acl id **Type:** number **Range:** 1-199 **Mutual Exclusion:** acl-id,acl-name, p-acl, and shared-partition-acl are mutually exclusive **acl-id-shared** **Description** acl id **Type:** number **Range:** 1-199 **Mutual Exclusion:** acl-id-shared and acl-name-shared are mutually exclusive **acl-name** **Description** Access List name (IPv4 Access List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Mutual Exclusion:** acl-name,acl-id, p-acl, and shared-partition-acl are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ip/access-list ` **acl-name-shared** **Description** Access List name (IPv4 Access List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Mutual Exclusion:** acl-name-shared and acl-id-shared are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ip/access-list ` **arp-disable** **Description** Disable Respond to Virtual Server ARP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **description** **Description** Create a description for VIP **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **disable-vip-adv** **Description** Disable virtual server GARP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable-disable-action** **Description** 'enable': Enable Virtual Server (default); 'disable': Disable Virtual Server; 'disable-when-all-ports-down': Disable Virtual Server when all member ports are down; 'disable-when-any-port-down': Disable Virtual Server when any member port is down; **Type:** string **Supported Values:** enable, disable, disable-when-all-ports-down, disable-when-any-port-down **Default:** enable **ethernet** **Description** Ethernet interface **Type:** number **Format:** interface **extended-stats** **Description** Enable extended statistics on virtual server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gaming-protocol-compliance** **Description** Enable Gaming Protocol Compliance Check **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ha-dynamic** **Description** Dynamic failover based on vip status **Type:** number **Range:** 1-255 **ip-address** **Description** IP Address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ip-address, ipv6-address, and use-if-ip are mutually exclusive **ipv6-acl** **Description** ipv6 acl name **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Mutual Exclusion:** ipv6-acl, p-ipv6-acl, and shared-partition-ipv6-acl are mutually exclusive **Reference Object:** :doc:`/axapi/v3/ipv6/access-list ` **ipv6-acl-shared** **Description** ipv6 acl name **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/ipv6/access-list ` **ipv6-address** **Description** IPV6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ipv6-address, ip-address, and use-if-ip are mutually exclusive **migrate-vip** **Description:** migrate-vip is a **JSON Block**. Please see below for :ref:`3076_virtual-server-list_migrate-vip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/virtual-server/{name}/migrate-vip ` **name** **Description** SLB Virtual Server Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **netmask** **Description** IP subnet mask **Type:** string **Format:** ipv4-netmask-brief **port-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/virtual-server/{name}/port/{port-number}+{protocol} ` **redistribute-route-map** **Description** Route map reference (Name of route-map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **redistribution-flagged** **Description** Flag VIP for special redistribution handling **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **shared-partition-policy-template** **Description** Reference a policy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-policy-template and template-policy are mutually exclusive **shared-partition-vs-template** **Description** Reference a virtual-server template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-vs-template and template-virtual-server are mutually exclusive **stats-data-action** **Description** 'stats-data-enable': Enable statistical data collection for virtual server; 'stats-data-disable': Disable statistical data collection for virtual server; **Type:** string **Supported Values:** stats-data-enable, stats-data-disable **Default:** stats-data-enable **suppress-internal-loopback** **Description** Suppress VIP internal loopback programming **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **template-logging** **Description** NAT Logging template (NAT Logging template name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/ip/nat/template/logging ` **template-policy** **Description** Policy template (Policy template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-policy and shared-partition-policy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/policy ` **template-policy-shared** **Description** Policy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/policy ` **template-scaleout** **Description** Scaleout template (Scaleout template name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **template-virtual-server** **Description** Virtual server template (Virtual server template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-virtual-server and shared-partition-vs-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/virtual-server ` **template-virtual-server-shared** **Description** Virtual-Server Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/virtual-server ` **use-if-ip** **Description** Use Interface IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-if-ip, ipv6-address, and ip-address are mutually exclusive **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 **vport-disable-action** **Description** 'drop-packet': Drop packet for disabled virtual-port; **Type:** string **Supported Values:** drop-packet **vrid** **Description** Join a vrrp group (Specify ha VRRP-A vrid) **Type:** number **Range:** 1-31 .. _3076_virtual-server-list_port-list: virtual-server-list_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-list** **Type:** List **action** **Description** 'enable': Enable; 'disable': Disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **aflex-scripts** **Type:** List **aflex-table-entry-syn-disable** **Description** Disable aFlex entry sync for this port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** aflex-table-entry-syn-disable and aflex-table-entry-syn-enable are mutually exclusive **aflex-table-entry-syn-enable** **Description** Enable aFlex entry sync for this port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** aflex-table-entry-syn-enable and aflex-table-entry-syn-disable are mutually exclusive **alt-protocol1** **Description** 'http': HTTP Port; **Type:** string **Supported Values:** http **alt-protocol2** **Description** 'tcp': TCP LB service; **Type:** string **Supported Values:** tcp **alternate-port** **Description** Alternate Virtual Port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** alternate-port and range are mutually exclusive **alternate-port-number** **Description** Virtual Port **Type:** number **Range:** 0-65534 **attack-detection** **Description** Enable analytics **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **auth-cfg** **Description:** auth-cfg is a **JSON Block**. Please see below for :ref:`3076_virtual-server-list_port-list_auth-cfg` **Type:** Object **auto** **Description** Configure auto NAT for the vport **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **clientip-sticky-nat** **Description** Prefer to use same source NAT address for a client **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-limit** **Description** Connection Limit **Type:** number **Range:** 1-64000000 **Default:** 64000000 **cpu-compute** **Description** enable cpu compute on virtual port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **def-selection-if-pref-failed** **Description** 'def-selection-if-pref-failed': Use default server selection method if prefer method failed; 'def-selection-if-pref-failed-disable': Stop using default server selection method if prefer method failed; **Type:** string **Supported Values:** def-selection-if-pref-failed, def-selection-if-pref-failed-disable **Default:** def-selection-if-pref-failed **enable-playerid-check** **Description** Enable playerid checks on UDP packets once the AX is in active mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable-scaleout** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **eth-fwd** **Description** Ethernet interface number **Type:** number **Format:** interface **Mutual Exclusion:** eth-fwd and trunk-fwd are mutually exclusive **eth-rev** **Description** Ethernet interface number **Type:** number **Format:** interface **Mutual Exclusion:** eth-rev and trunk-rev are mutually exclusive **expand** **Description** expand syn-cookie with timestamp and wscale **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **extended-stats** **Description** Enable extended statistics on virtual port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fast-path** **Description** 'force': Force fast path in SLB processing; 'disable': Disable fast path in SLB processing; **Type:** string **Supported Values:** force, disable **force-routing-mode** **Description** Force routing mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gslb-enable** **Description** Enable Global Server Load Balancing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gtp-session-lb** **Description** Enable GTP Session Load Balancing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ha-conn-mirror** **Description** Enable for HA Conn sync **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ignore-global** **Description** Ignore global substitute-source-mac **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-map-list** **Description** Enter name of IP Map List to be bound (IP Map List Name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **ip-only-lb** **Description** Enable IP-Only LB mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-smart-rr** **Description** Use IP address round-robin behavior **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipinip** **Description** Enable IP in IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **l7-hardware-assist** **Description** FPGA assist L7 packet parsing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **l7-service-chain** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **memory-compute** **Description** enable dynamic memory compute on virtual port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **message-switching** **Description** Message switching **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **name** **Description** SLB Virtual Service Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **ng-waf** **Description** Next-gen WAF **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no-auto-up-on-aflex** **Description** Don't automatically mark vport up when aFleX is bound **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no-dest-nat** **Description** Disable destination NAT, this option only supports in wildcard VIP or when a connection is operated in SSLi + EP mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **on-syn** **Description** Enable for HA Conn sync for l4 tcp sessions on SYN **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **one-server-conn** **Description** Support server that allow only one connection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **optimization-level** **Description** '0': No optimization; '1': Optimization level 1 (Experimental); **Type:** string **Supported Values:** 0, 1 **Default:** 0 **p-template-sip-shared** **Description** SIP Template Name **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** p-template-sip-shared and template-sip are mutually exclusive **packet-capture-template** **Description** Name of the packet capture template to be bind with this object **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/slb-vport-tmpl ` **persist-type** **Description** 'src-dst-ip-swap-persist': Create persist session after source IP and destination IP swap; 'use-src-ip-for-dst-persist': Use the source IP to create a destination persist session; 'use-dst-ip-for-src-persist': Use the destination IP to create source IP persist session; **Type:** string **Supported Values:** src-dst-ip-swap-persist, use-src-ip-for-dst-persist, use-dst-ip-for-src-persist **pool** **Description** Specify NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** pool and shared-partition-pool are mutually exclusive **pool-shared** **Description** Specify NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-number** **Description** Port **Type:** number **Range:** 0-65534 **port-translation** **Description** Enable port translation under no-dest-nat **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **precedence** **Description** Set auto NAT pool as higher precedence for source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **protocol** **Description** 'tcp': TCP LB service; 'udp': UDP Port; 'others': for no tcp/udp protocol, do IP load balancing; 'diameter': diameter port; 'dns-tcp': DNS service over TCP; 'dns-udp': DNS service over UDP; 'fast-http': Fast HTTP Port; 'fix': FIX Port; 'ftp': File Transfer Protocol Port; 'ftp-proxy': ftp proxy port; 'http': HTTP Port; 'https': HTTPS port; 'imap': imap proxy port; 'mlb': Message based load balancing; 'mms': Microsoft Multimedia Service Port; 'mysql': mssql port; 'mssql': mssql; 'pop3': pop3 proxy port; 'radius': RADIUS Port; 'rtsp': Real Time Streaming Protocol Port; 'sip': Session initiation protocol over UDP; 'sip-tcp': Session initiation protocol over TCP; 'sips': Session initiation protocol over TLS; 'smpp-tcp': SMPP service over TCP; 'spdy': spdy port; 'spdys': spdys port; 'smtp': SMTP Port; 'mqtt': MQTT Port; 'mqtts': MQTTS Port; 'ssl-proxy': Generic SSL proxy; 'ssli': SSL insight; 'ssh': SSH Port; 'tcp-proxy': Generic TCP proxy; 'tftp': TFTP Port; 'fast-fix': Fast FIX port; 'http-over-quic': HTTP3-over-quic port; **Type:** string **Supported Values:** tcp, udp, others, diameter, dns-tcp, dns-udp, fast-http, fix, ftp, ftp-proxy, http, https, imap, mlb, mms, mysql, mssql, pop3, radius, rtsp, sip, sip-tcp, sips, smpp-tcp, spdy, spdys, smtp, mqtt, mqtts, ssl-proxy, ssli, ssh, tcp-proxy, tftp, fast-fix, http-over-quic **proxy-layer** **Description** 'v1': Force using old proxy; 'v2': Force using new proxy; **Type:** string **Supported Values:** v1, v2 **range** **Description** Virtual Port range (Virtual Port range value) **Type:** number **Range:** 0-254 **Default:** 0 **Mutual Exclusion:** range and alternate-port are mutually exclusive **rate** **Description** Specify the log message rate **Type:** number **Range:** 0-2147483647 **redirect-to-https** **Description** Redirect HTTP to HTTPS **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reply-acme-challenge** **Description** Reply ACME http-01 challenge. This option only takes effect in HTTP port 80 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **req-fail** **Description** Use alternate virtual port when L7 request fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reselection** **Description** 'disable': disable; **Type:** string **Supported Values:** disable **reset** **Description** Send client reset when connection number over limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset-on-server-selection-fail** **Description** Send client reset when server selection fails **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **resolve-web-cat-list** **Description** Web Category List name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/web-category/category-list ` **rtp-sip-call-id-match** **Description** rtp traffic try to match the real server of sip smp call-id session **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sampling-enable** **Type:** List **secs** **Description** Specify the interval in seconds **Type:** number **Range:** 1-100 **serv-sel-fail** **Description** Use alternate virtual port when server selection failure **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-group** **Description** Bind a use-rcv-hop-for-resp Server Group to this Virtual Server (Server Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/server-group ` **service-group** **Description** Bind a Service Group to this Virtual Server (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **shared-partition-cache-template** **Description** Reference a Cache template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-cache-template and template-cache are mutually exclusive **shared-partition-client-ssl-template** **Description** Reference a Client SSL template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-client-ssl-template and template-client-ssl are mutually exclusive **shared-partition-connection-reuse-template** **Description** Reference a connection reuse template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-connection-reuse-template and template-connection-reuse are mutually exclusive **shared-partition-dblb-template** **Description** Reference a dblb template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-dblb-template and template-dblb are mutually exclusive **shared-partition-diameter-template** **Description** Reference a Diameter template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-diameter-template and template-diameter are mutually exclusive **shared-partition-dns-template** **Description** Reference a dns template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-dns-template and template-dns are mutually exclusive **shared-partition-doh-template** **Description** Reference a DNS over HTTP(s) template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-doh-template and template-doh are mutually exclusive **shared-partition-dynamic-service-template** **Description** Reference a dynamic service template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-dynamic-service-template and template-dynamic-service are mutually exclusive **shared-partition-external-service-template** **Description** Reference a external service template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-external-service-template and template-external-service are mutually exclusive **shared-partition-fix-template** **Description** Reference a FIX template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-fix-template and template-fix are mutually exclusive **shared-partition-http-policy-template** **Description** Reference a http policy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-http-policy-template and template-http-policy are mutually exclusive **shared-partition-http-template** **Description** Reference a HTTP template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-http-template and template-http are mutually exclusive **shared-partition-imap-pop3-template** **Description** Reference a IMAP/POP3 template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-imap-pop3-template and template-imap-pop3 are mutually exclusive **shared-partition-persist-cookie-template** **Description** Reference a persist cookie template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-persist-cookie-template and template-persist-cookie are mutually exclusive **shared-partition-persist-destination-ip-template** **Description** Reference a persist destination ip template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-persist-destination-ip-template and template-persist-destination-ip are mutually exclusive **shared-partition-persist-source-ip-template** **Description** Reference a persist source ip template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-persist-source-ip-template and template-persist-source-ip are mutually exclusive **shared-partition-persist-ssl-sid-template** **Description** Reference a persist SSL SID template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-persist-ssl-sid-template and template-persist-ssl-sid are mutually exclusive **shared-partition-policy-template** **Description** Reference a policy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-policy-template and template-policy are mutually exclusive **shared-partition-pool** **Description** Specify NAT pool or pool group from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-pool and pool are mutually exclusive **shared-partition-quic-template** **Description** Reference a QUIC template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-quic-template and template-quic are mutually exclusive **shared-partition-server-ssl-template** **Description** Reference a SSL Server template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-server-ssl-template and template-server-ssl are mutually exclusive **shared-partition-smpp-template** **Description** Reference a smpp template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-smpp-template and template-smpp are mutually exclusive **shared-partition-smtp-template** **Description** Reference a SMTP template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-smtp-template and template-smtp are mutually exclusive **shared-partition-tcp** **Description** Reference a tcp template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-tcp and template-tcp are mutually exclusive **shared-partition-tcp-proxy-template** **Description** Reference a TCP Proxy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-tcp-proxy-template and template-tcp-proxy are mutually exclusive **shared-partition-udp** **Description** Reference a UDP template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-udp and template-udp are mutually exclusive **shared-partition-virtual-port-template** **Description** Reference a Virtual Port template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-virtual-port-template and template-virtual-port are mutually exclusive **showtech-print-extended-stats** **Description** Enable print extended stats in showtech for dns vports **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **skip-rev-hash** **Description** Skip rev tuple hash insertion **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **snat-on-vip** **Description** Enable source NAT traffic against VIP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stats-data-action** **Description** 'stats-data-enable': Enable statistical data collection for virtual port; 'stats-data-disable': Disable statistical data collection for virtual port; **Type:** string **Supported Values:** stats-data-enable, stats-data-disable **Default:** stats-data-enable **substitute-source-mac** **Description** Substitute Source MAC Address to that of the outgoing interface **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **support-http2** **Description** Support HTTP2 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **syn-cookie** **Description** Enable syn-cookie **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **template-cache** **Description** RAM caching template (Cache Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-cache and shared-partition-cache-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/cache ` **template-cache-shared** **Description** Cache Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/cache ` **template-client-ssh** **Description** Client SSH Template (Client SSH Config Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssh ` **template-client-ssl** **Description** Client SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-client-ssl and shared-partition-client-ssl-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssl ` **template-client-ssl-shared** **Description** Client SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/client-ssl ` **template-connection-reuse** **Description** Connection Reuse Template (Connection Reuse Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-connection-reuse and shared-partition-connection-reuse-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/connection-reuse ` **template-connection-reuse-shared** **Description** Connection Reuse Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/connection-reuse ` **template-dblb** **Description** DBLB Template (DBLB template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-dblb and shared-partition-dblb-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/dblb ` **template-dblb-shared** **Description** DBLB Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/dblb ` **template-diameter** **Description** Diameter Template (diameter template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-diameter and shared-partition-diameter-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/diameter ` **template-diameter-shared** **Description** Diameter Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/diameter ` **template-dns** **Description** DNS template (DNS template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-dns and shared-partition-dns-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/dns ` **template-dns-shared** **Description** DNS Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/dns ` **template-doh** **Description** DNS over HTTP(s) Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-doh and shared-partition-doh-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/doh ` **template-doh-shared** **Description** DNS over HTTP(s) Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/doh ` **template-dynamic-service** **Description** Dynamic Service Template (dynamic-service template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-dynamic-service and shared-partition-dynamic-service-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/dynamic-service ` **template-dynamic-service-shared** **Description** Dynamic Service Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/dynamic-service ` **template-external-service** **Description** External service template (external-service template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-external-service and shared-partition-external-service-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/external-service ` **template-external-service-shared** **Description** External Service Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/external-service ` **template-fix** **Description** FIX template (FIX Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-fix and shared-partition-fix-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/fix ` **template-fix-shared** **Description** FIX Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/fix ` **template-ftp** **Description** FTP port template (Ftp template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/ftp ` **template-http** **Description** HTTP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-http and shared-partition-http-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/http ` **template-http-policy** **Description** http-policy template (http-policy template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-http-policy and shared-partition-http-policy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/http-policy ` **template-http-policy-shared** **Description** Http Policy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/http-policy ` **template-http-shared** **Description** HTTP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/http ` **template-imap-pop3** **Description** IMAP/POP3 Template (IMAP/POP3 Config Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-imap-pop3 and shared-partition-imap-pop3-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/imap-pop3 ` **template-imap-pop3-shared** **Description** IMAP/POP3 Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/imap-pop3 ` **template-mqtt** **Description** MQTT Template (MQTT Config Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/mqtt ` **template-persist-cookie** **Description** Cookie persistence (Cookie persistence template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-persist-cookie and shared-partition-persist-cookie-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/persist/cookie ` **template-persist-cookie-shared** **Description** Cookie Persistence Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/persist/cookie ` **template-persist-destination-ip** **Description** Destination IP persistence (Destination IP persistence template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-persist-destination-ip and shared-partition-persist-destination-ip-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/persist/destination-ip ` **template-persist-destination-ip-shared** **Description** Destination IP Persistence Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/persist/destination-ip ` **template-persist-source-ip** **Description** Source IP persistence (Source IP persistence template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-persist-source-ip and shared-partition-persist-source-ip-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip ` **template-persist-source-ip-shared** **Description** Source IP Persistence Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/persist/source-ip ` **template-persist-ssl-sid** **Description** SSL SID persistence (SSL SID persistence template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-persist-ssl-sid and shared-partition-persist-ssl-sid-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/persist/ssl-sid ` **template-persist-ssl-sid-shared** **Description** SSL SID Persistence Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/persist/ssl-sid ` **template-policy** **Description** Policy Template (Policy template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-policy and shared-partition-policy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/policy ` **template-policy-shared** **Description** Policy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/policy ` **template-quic** **Description** QUIC Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-quic and shared-partition-quic-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/quic ` **template-quic-client** **Description** QUIC Config Client (QUIC Config name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/quic ` **template-quic-server** **Description** QUIC Config Server (QUIC Config name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/quic ` **template-quic-shared** **Description** QUIC Template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/quic ` **template-ram-cache** **Description** RAM caching template (Cache Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/cache ` **template-reqmod-icap** **Description** ICAP reqmod template (reqmod-icap template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/reqmod-icap ` **template-respmod-icap** **Description** ICAP respmod service template (respmod-icap template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/respmod-icap ` **template-scaleout** **Description** Scaleout template (Scaleout template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **template-server-ssh** **Description** Server SSH Template (Server SSH Config Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssh ` **template-server-ssl** **Description** Server Side SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-server-ssl and shared-partition-server-ssl-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssl ` **template-server-ssl-shared** **Description** Server SSL Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssl ` **template-sip** **Description** SIP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-sip and p-template-sip-shared are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/sip ` **template-sip-shared** **Description** SIP template **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/sip ` **template-smpp** **Description** SMPP template **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-smpp and shared-partition-smpp-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/smpp ` **template-smpp-shared** **Description** SMPP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/smpp ` **template-smtp** **Description** SMTP Template (SMTP Config Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-smtp and shared-partition-smtp-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/smtp ` **template-smtp-shared** **Description** SMTP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/smtp ` **template-ssli** **Description** SSLi template (SSLi Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/ssli ` **template-tcp** **Description** TCP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Mutual Exclusion:** template-tcp and shared-partition-tcp are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/tcp ` **template-tcp-proxy** **Description** TCP Proxy Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **template-tcp-proxy-client** **Description** TCP Proxy Config Client (TCP Proxy Config name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **template-tcp-proxy-server** **Description** TCP Proxy Config Server (TCP Proxy Config name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **template-tcp-proxy-shared** **Description** TCP Proxy Template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/tcp-proxy ` **template-tcp-shared** **Description** TCP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Reference Object:** :doc:`/axapi/v3/slb/template/tcp ` **template-udp** **Description** L4 UDP Template **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Mutual Exclusion:** template-udp and shared-partition-udp are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/udp ` **template-udp-shared** **Description** UDP Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Reference Object:** :doc:`/axapi/v3/slb/template/udp ` **template-virtual-port** **Description** Virtual port template (Virtual port template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Mutual Exclusion:** template-virtual-port and shared-partition-virtual-port-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/virtual-port ` **template-virtual-port-shared** **Description** Virtual Port Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/virtual-port ` **trunk-fwd** **Description** Trunk interface number **Type:** number **Format:** interface **Mutual Exclusion:** trunk-fwd and eth-fwd are mutually exclusive **trunk-rev** **Description** Trunk interface number **Type:** number **Format:** interface **Mutual Exclusion:** trunk-rev and eth-rev are mutually exclusive **use-alternate-port** **Description** Use alternate virtual port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-cgnv6** **Description** Follow CGNv6 source NAT configuration **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-default-if-no-server** **Description** Use default forwarding if server selection failed **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-rcv-hop-for-resp** **Description** Use receive hop for response to client(For packets on default-vlan, also config "vlan-global enable-def-vlan-l2-forwarding".) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-rcv-hop-group** **Description** Set use-rcv-hop group **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 **view** **Description** Specify a GSLB View (ID) **Type:** number **Range:** 1-31 **when-down** **Description** Use alternate virtual port when down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **when-down-protocol2** **Description** Use alternate virtual port when down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_virtual-server-list_port-list_sampling-enable: virtual-server-list_port-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_conn': Current established connections; 'total_l4_conn': Total L4 connections established; 'total_l7_conn': Total L7 connections established; 'total_tcp_conn': Total TCP connections established; 'total_conn': Total connections established; 'total_fwd_bytes': Bytes processed in forward direction; 'total_fwd_pkts': Packets processed in forward direction; 'total_rev_bytes': Bytes processed in reverse direction; 'total_rev_pkts': Packets processed in reverse direction; 'total_dns_pkts': Total DNS packets processed; 'total_mf_dns_pkts': Total MF DNS packets; 'es_total_failure_actions': Total failure actions; 'compression_bytes_before': Data into gzip compression engine; 'compression_bytes_after': Data out of gzip compression engine; 'compression_hit': Number of requests compressed; 'compression_miss': Number of requests NOT compressed; 'compression_miss_no_client': Compression miss no client; 'compression_miss_template_exclusion': Compression miss template exclusion; 'curr_req': Current requests; 'total_req': Total requests; 'total_req_succ': Total successful requests; 'peak_conn': Peak connections; 'curr_conn_rate': Current connection rate; 'last_rsp_time': Last response time; 'fastest_rsp_time': Fastest response time; 'slowest_rsp_time': Slowest response time; 'loc_permit': Geo-location Permit count; 'loc_deny': Geo-location Deny count; 'loc_conn': Geo-location Connection count; 'curr_ssl_conn': Current SSL connections; 'total_ssl_conn': Total SSL connections; 'backend-time-to-first-byte': Backend Time from Request to Response First Byte; 'backend-time-to-last-byte': Backend Time from Request to Response Last Byte; 'in-latency': Request Latency at Thunder; 'out-latency': Response Latency at Thunder; 'total_fwd_bytes_out': Bytes processed in forward direction (outbound); 'total_fwd_pkts_out': Packets processed in forward direction (outbound); 'total_rev_bytes_out': Bytes processed in reverse direction (outbound); 'total_rev_pkts_out': Packets processed in reverse direction (outbound); 'curr_req_rate': Current request rate; 'curr_resp': Current response; 'total_resp': Total response; 'total_resp_succ': Total successful responses; 'curr_resp_rate': Current response rate; 'dnsrrl_total_allowed': DNS Response-Rate-Limiting Total Responses Allowed; 'dnsrrl_total_dropped': DNS Response-Rate-Limiting Total Responses Dropped; 'dnsrrl_total_slipped': DNS Response-Rate-Limiting Total Responses Slipped; 'dnsrrl_bad_fqdn': DNS Response-Rate-Limiting Bad FQDN; 'throughput-bits-per-sec': Throughput in bits/sec; 'dynamic-memory-alloc': dynamic memory (bytes) allocated by the vport; 'dynamic-memory-free': dynamic memory (bytes) allocated by the vport; 'dynamic-memory': dynamic memory (bytes) used by the vport(alloc-free); 'ip_only_lb_fwd_bytes': IP-Only-LB Bytes processed in forward direction; 'ip_only_lb_rev_bytes': IP-Only-LB Bytes processed in reverse direction; 'ip_only_lb_fwd_pkts': IP-Only-LB Packets processed in forward direction; 'ip_only_lb_rev_pkts': IP-Only-LB Packets processed in reverse direction; 'total_dns_filter_type_drop': Total DNS Filter Type Drop; 'total_dns_filter_class_drop': Total DNS Filter Class Drop; 'dns_filter_type_a_drop': DNS Filter Type A Drop; 'dns_filter_type_aaaa_drop': DNS Filter Type AAAA Drop; 'dns_filter_type_cname_drop': DNS Filter Type CNAME Drop; 'dns_filter_type_mx_drop': DNS Filter Type MX Drop; 'dns_filter_type_ns_drop': DNS Filter Type NS Drop; 'dns_filter_type_srv_drop': DNS Filter Type SRV Drop; 'dns_filter_type_ptr_drop': DNS Filter Type PTR Drop; 'dns_filter_type_soa_drop': DNS Filter Type SOA Drop; 'dns_filter_type_txt_drop': DNS Filter Type TXT Drop; 'dns_filter_type_any_drop': DNS Filter Type Any Drop; 'dns_filter_type_others_drop': DNS Filter Type OTHERS Drop; 'dns_filter_class_internet_drop': DNS Filter Class INTERNET Drop; 'dns_filter_class_chaos_drop': DNS Filter Class CHAOS Drop; 'dns_filter_class_hesiod_drop': DNS Filter Class HESIOD Drop; 'dns_filter_class_none_drop': DNS Filter Class NONE Drop; 'dns_filter_class_any_drop': DNS Filter Class ANY Drop; 'dns_filter_class_others_drop': DNS Filter Class OTHERS Drop; 'dns_rpz_action_drop': DNS RPZ Action Drop; 'dns_rpz_action_pass_thru': DNS RPZ Action Pass Through; 'dns_rpz_action_tcp_only': DNS RPZ Action TCP Only; 'dns_rpz_action_nxdomain': DNS RPZ Action NXDOMAIN; 'dns_rpz_action_nodata': DNS RPZ Action NODATA; 'dns_rpz_action_local_data': DNS RPZ Action Local Data; 'dns_rpz_trigger_client_ip': DNS RPZ Trigger Client IP; 'dns_rpz_trigger_resp_ip': DNS RPZ Trigger Response IP; 'dns_rpz_trigger_ns_ip': DNS RPZ Trigger NS IP; 'dns_rpz_trigger_qname': DNS RPZ Trigger Qname IP; 'dns_rpz_trigger_ns_name': DNS RPZ Trigger NS Name; 'compression_bytes_before_br': Data into brotli compression engine; 'compression_bytes_after_br': Data out of brotli compression engine; 'compression_bytes_before_total': Data into compression engine; 'compression_bytes_after_total': Data out of compression engine; 'compression_hit_br': Number of requests compressed with brotli; 'compression_miss_br': Number of requests NOT compressed with brotli; 'compression_hit_total': Number of requests compressed; 'compression_miss_total': Number of requests NOT compressed; 'dnsrrl_total_tc': DNS Response-Rate-Limiting Total Responses Replied With Truncated; 'http1_client_idle_timeout': HTTP1 Client Idle Timeout; 'http2_client_idle_timeout': HTTP2 Client Idle Timeout; **Type:** string **Supported Values:** all, curr_conn, total_l4_conn, total_l7_conn, total_tcp_conn, total_conn, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_dns_pkts, total_mf_dns_pkts, es_total_failure_actions, compression_bytes_before, compression_bytes_after, compression_hit, compression_miss, compression_miss_no_client, compression_miss_template_exclusion, curr_req, total_req, total_req_succ, peak_conn, curr_conn_rate, last_rsp_time, fastest_rsp_time, slowest_rsp_time, loc_permit, loc_deny, loc_conn, curr_ssl_conn, total_ssl_conn, backend-time-to-first-byte, backend-time-to-last-byte, in-latency, out-latency, total_fwd_bytes_out, total_fwd_pkts_out, total_rev_bytes_out, total_rev_pkts_out, curr_req_rate, curr_resp, total_resp, total_resp_succ, curr_resp_rate, dnsrrl_total_allowed, dnsrrl_total_dropped, dnsrrl_total_slipped, dnsrrl_bad_fqdn, throughput-bits-per-sec, dynamic-memory-alloc, dynamic-memory-free, dynamic-memory, ip_only_lb_fwd_bytes, ip_only_lb_rev_bytes, ip_only_lb_fwd_pkts, ip_only_lb_rev_pkts, total_dns_filter_type_drop, total_dns_filter_class_drop, dns_filter_type_a_drop, dns_filter_type_aaaa_drop, dns_filter_type_cname_drop, dns_filter_type_mx_drop, dns_filter_type_ns_drop, dns_filter_type_srv_drop, dns_filter_type_ptr_drop, dns_filter_type_soa_drop, dns_filter_type_txt_drop, dns_filter_type_any_drop, dns_filter_type_others_drop, dns_filter_class_internet_drop, dns_filter_class_chaos_drop, dns_filter_class_hesiod_drop, dns_filter_class_none_drop, dns_filter_class_any_drop, dns_filter_class_others_drop, dns_rpz_action_drop, dns_rpz_action_pass_thru, dns_rpz_action_tcp_only, dns_rpz_action_nxdomain, dns_rpz_action_nodata, dns_rpz_action_local_data, dns_rpz_trigger_client_ip, dns_rpz_trigger_resp_ip, dns_rpz_trigger_ns_ip, dns_rpz_trigger_qname, dns_rpz_trigger_ns_name, compression_bytes_before_br, compression_bytes_after_br, compression_bytes_before_total, compression_bytes_after_total, compression_hit_br, compression_miss_br, compression_hit_total, compression_miss_total, dnsrrl_total_tc, http1_client_idle_timeout, http2_client_idle_timeout .. _3076_virtual-server-list_port-list_acl-list: virtual-server-list_port-list_acl-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-id** **Description** ACL id VPORT **Type:** number **Range:** 1-199 **Mutual Exclusion:** acl-id, p-acl, and shared-partition-acl are mutually exclusive **acl-id-seq-num** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **acl-id-seq-num-shared** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **acl-id-shared** **Description** acl id **Type:** number **Range:** 1-199 **acl-id-src-nat-pool** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** acl-id-src-nat-pool and shared-partition-pool-id are mutually exclusive **acl-id-src-nat-pool-shared** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **acl-name** **Description** Apply an access list name (Named Access List) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **acl-name-seq-num** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **acl-name-seq-num-shared** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **acl-name-shared** **Description** Apply an access list name (Named Access List) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **acl-name-src-nat-pool** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** acl-name-src-nat-pool, shared-partition-pool-name, and v-shared-partition-pool-name are mutually exclusive **acl-name-src-nat-pool-shared** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared-partition-pool-id** **Description** Policy based Source NAT from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-pool-id and acl-id-src-nat-pool are mutually exclusive **shared-partition-pool-name** **Description** Policy based Source NAT from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-pool-name and acl-name-src-nat-pool are mutually exclusive **v-acl-id-seq-num** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **v-acl-id-seq-num-shared** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **v-acl-id-src-nat-pool** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** v-acl-id-src-nat-pool and v-shared-partition-pool-id are mutually exclusive **v-acl-id-src-nat-pool-shared** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **v-acl-name-seq-num** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **v-acl-name-seq-num-shared** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **v-acl-name-src-nat-pool** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **v-acl-name-src-nat-pool-shared** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **v-shared-partition-pool-id** **Description** Policy based Source NAT from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** v-shared-partition-pool-id and v-acl-id-src-nat-pool are mutually exclusive **v-shared-partition-pool-name** **Description** Policy based Source NAT from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** v-shared-partition-pool-name and acl-name-src-nat-pool are mutually exclusive .. _3076_virtual-server-list_port-list_aflex-scripts: virtual-server-list_port-list_aflex-scripts ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **aflex** **Description** aFleX Script Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **aflex-shared** **Description** aFleX Script Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _3076_virtual-server-list_port-list_auth-cfg: virtual-server-list_port-list_auth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **aaa-policy** **Description** Specify AAA policy name to bind to the virtual port **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/aam/aaa-policy ` .. _3076_virtual-server-list_migrate-vip: virtual-server-list_migrate-vip ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cancel-migration** **Description** Cancel migration **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** cancel-migration and finish-migration are mutually exclusive **finish-migration** **Description** Complete the migration **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** finish-migration and cancel-migration are mutually exclusive **target-data-cpu** **Description** Number of CPUs on the target platform **Type:** number **Range:** 1-75 **target-floating-ipv4** **Description** Specify IP address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** target-floating-ipv4 and target-floating-ipv6 are mutually exclusive **target-floating-ipv6** **Description** Specify IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** target-floating-ipv6 and target-floating-ipv4 are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ftp-proxy: ftp-proxy ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ftp-proxy_sampling-enable: ftp-proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num': Num; 'curr': Current proxy conns; 'total': Total proxy conns; 'svrsel_fail': Server selection failure; 'no_route': no route failure; 'snat_fail': source nat failure; 'feat': feat packet; 'cc': clear ctrl port packet; 'data_ssl': data ssl force; 'line_too_long': line too long; 'line_mem_freed': request line freed; 'invalid_start_line': invalid start line; 'auth_tls': auth tls cmd; 'prot': prot cmd; 'pbsz': pbsz cmd; 'pasv': pasv cmd; 'port': port cmd; 'request_dont_care': other cmd; 'client_auth_tls': client auth tls; 'cant_find_pasv': cant find pasv; 'pasv_addr_ne_server': psv addr not equal to svr; 'smp_create_fail': smp create fail; 'data_server_conn_fail': data svr conn fail; 'data_send_fail': data send fail; 'epsv': epsv command; 'cant_find_epsv': cant find epsv; 'data_curr': Current Data Proxy; 'data_total': Total Data Proxy; 'auth_unsupported': Unsupported auth; 'adat': adat cmd; 'unsupported_pbsz_value': Unsupported PBSZ; 'unsupported_prot_value': Unsupported PROT; 'unsupported_command': Unsupported cmd; 'control_to_clear': Control chn clear txt; 'control_to_ssl': Control chn ssl; 'bad_sequence': Bad Sequence; 'rsv_persist_conn_fail': Serv Sel Persist fail; 'smp_v6_fail': Serv Sel SMPv6 fail; 'smp_v4_fail': Serv Sel SMPv4 fail; 'insert_tuple_fail': Serv Sel insert tuple fail; 'cl_est_err': Client EST state erro; 'ser_connecting_err': Serv CTNG state error; 'server_response_err': Serv RESP state error; 'cl_request_err': Client RQ state error; 'data_conn_start_err': Data Start state error; 'data_serv_connecting_err': Data Serv CTNG error; 'data_serv_connected_err': Data Serv CTED error; 'request': Total FTP Request; 'auth_req': Auth Request; 'auth_succ': Auth Success; 'auth_fail': Auth Failure; 'fwd_to_internet': Forward to Internet; 'fwd_to_sg': Total Forward to Service-group; 'drop': Total FTP Drop; 'ds_succ': Host Domain Name is resolved; 'ds_fail': Host Domain Name isn't resolved; 'open': open cmd; 'site': site cmd; 'user': user cmd; 'pass': pass cmd; 'quit': quit cmd; 'eprt': eprt cmd; 'cant_find_port': cant find port; 'cant_find_eprt': cant find eprt; **Type:** string **Supported Values:** all, num, curr, total, svrsel_fail, no_route, snat_fail, feat, cc, data_ssl, line_too_long, line_mem_freed, invalid_start_line, auth_tls, prot, pbsz, pasv, port, request_dont_care, client_auth_tls, cant_find_pasv, pasv_addr_ne_server, smp_create_fail, data_server_conn_fail, data_send_fail, epsv, cant_find_epsv, data_curr, data_total, auth_unsupported, adat, unsupported_pbsz_value, unsupported_prot_value, unsupported_command, control_to_clear, control_to_ssl, bad_sequence, rsv_persist_conn_fail, smp_v6_fail, smp_v4_fail, insert_tuple_fail, cl_est_err, ser_connecting_err, server_response_err, cl_request_err, data_conn_start_err, data_serv_connecting_err, data_serv_connected_err, request, auth_req, auth_succ, auth_fail, fwd_to_internet, fwd_to_sg, drop, ds_succ, ds_fail, open, site, user, pass, quit, eprt, cant_find_port, cant_find_eprt .. _3076_quic: quic ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_quic_sampling-enable: quic_sampling-enable ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'client_conn_attempted': Client connection attempted; 'client_conn_handshake': Client connection handshake; 'client_conn_created': Client connection created; 'client_conn_local_closed': Client connection local closed; 'client_conn_remote_closed': Client connection remote closed; 'client_conn_failed': Client connection failed; 'server_conn_attempted': Server connection attempted; 'server_conn_handshake': Server connection handshake; 'server_conn_created': Server connection created; 'server_conn_local_closed': Server connection local closed; 'server_conn_remote_closed': Server connection remote closed; 'server_conn_failed': Server connection failed; 'q_conn_created': Q connection created; 'q_conn_freed': Q connection freed; 'local_bi_stream_created': Local bi-stream created; 'remote_bi_stream_created': Remote bi-stream created; 'local_bi_stream_closed': Local bi-stream closed; 'remote_bi_stream_closed': Remote bi-stream closed; 'local_uni_stream_created': Local uni-stream created; 'remote_uni_stream_created': Remote uni-stream created; 'local_uni_stream_closed': Local uni-stream closed; 'remote_uni_stream_closed': Remote uni-stream closed; 'stream_error': Stream error; 'padding_frame_rx': padding frame receive; 'padding_frame_tx': padding frame send; 'ping_frame_rx': ping frame receive; 'ping_frame_tx': ping frame send; 'ack_frame_rx': ack frame receive; 'ack_frame_tx': ack frame send; 'ack_ecn_frame_rx': ack enc frame receive; 'ack_ecn_frame_tx': ack enc frame send; 'stream_rst_frame_rx': stream reset frame receive; 'stream_rst_frame_tx': stream reset frame send; 'stream_stop_frame_rx': stream stop frame receive; 'stream_stop_frame_tx': stream stop frame send; 'crypto_frame_rx': crypto frame receive; 'crypto_frame_tx': crypto frame send; 'new_token_frame_rx': new token frame receive; 'new_token_frame_tx': new token frame send; 'stream_frame_rx': stream frame receive; 'stream_frame_tx': stream frame send; 'stream_09_frame_rx': stream 09 frame receive; 'stream_09_frame_tx': stream 09 frame send; 'stream_0a_frame_rx': stream 0a frame receive; 'stream_0a_frame_tx': stream 0a frame send; 'stream_0b_frame_rx': stream 0b frame receive; 'stream_0b_frame_tx': stream 0b frame send; 'stream_0c_frame_rx': stream 0c frame receive; 'stream_0c_frame_tx': stream 0c frame send; 'stream_0d_frame_rx': stream 0d frame receive; 'stream_0d_frame_tx': stream 0d frame send; 'stream_0e_frame_rx': stream 0e frame receive; 'stream_0e_frame_tx': stream 0e frame send; 'stream_0f_frame_rx': stream 0f frame receive; 'stream_0f_frame_tx': stream 0f frame send; 'max_data_frame_rx': max data frame receive; 'max_data_frame_tx': max data frame send; 'max_stream_data_frame_rx': max stream data frame receive; 'max_stream_data_frame_tx': max stream data frame send; 'max_bi_stream_frame_rx': max bi stream frame receive; 'max_bi_stream_frame_tx': max bi stream frame send; 'max_uni_stream_frame_rx': max uni stream frame receive; 'max_uni_stream_frame_tx': max uni stream frame send; 'data_blocked_frame_rx': data blocked frame receive; 'data_blocked_frame_tx': data blocked frame send; 'stream_data_blocked_frame_rx': stream data blocked frame receive; 'stream_data_blocked_frame_tx': stream data blocked frame send; 'bi_stream_data_blocked_frame_rx': bi stream data blocked frame receive; 'bi_stream_data_blocked_frame_tx': bi stream data blocked frame send; 'uni_stream_data_blocked_frame_rx': uni stream data blocked frame receive; 'uni_stream_data_blocked_frame_tx': uni stream data blocked frame send; 'new_conn_id_frame_rx': new conn id frame receive; 'new_conn_id_frame_tx': new conn id frame send; 'retire_conn_id_frame_rx': retire conn id frame receive; 'retire_conn_id_frame_tx': retire conn id frame send; 'path_challenge_frame_rx': path challenge frame receive; 'path_challenge_frame_tx': path challenge frame send; 'path_response_frame_rx': path response frame receive; 'path_response_frame_tx': path response frame send; 'conn_close_frame_rx': conn close frame receive; 'conn_close_frame_tx': conn close frame send; 'app_conn_close_frame_rx': app conn close frame receive; 'app_conn_close_frame_tx': app conn close frame send; 'handshake_done_frame_rx': handshake done frame receive; 'handshake_done_frame_tx': handshake done frame send; 'unknown_frame': Unknown frame; 'stream_fin_receive': Stream FIN receive; 'stream_fin_up': Stream FIN up; 'stream_fin_down': Stream FIN down; 'stream_fin_send': Stream FIN send; 'stream_congest': Stream congest; 'stream_open': Stream open; 'stream_pause_data': Stream pause data; 'stream_resume_data': Stream resume data; 'stream_not_send': Stream not send; 'stream_created': Stream created; 'stream_freed': Stream freed; 'INITIAL_rx': INITIAL receive; 'INITIAL_tx': INITIAL send; 'RTT_0_rx': RTT_0 receive; 'RTT_0_tx': RTT_0 send; 'HANDSHAKE_rx': HANDSHAKE receive; 'HANDSHAKE_tx': HANDSHAKE send; 'RETRY_rx': RETRY receive; 'RETRY_tx': RETRY send; 'VER_rx': Version receive; 'VER_tx': Version send; 'RTT_updated': RTT updated; 'Needs_ack': Needs ACK; 'Delayed_ack': Delayed ACK; 'Packet_rx': Packet receive; 'Packet_tx': Packet send; 'Packet_tx_failed': Packet send failed; 'Congest_wnd_inc': Congestion window increase; 'Congest_wnd_dec': Congestion window decrease; 'No_congest_wnd': No congestion window; 'Burst_limited': Burst limited; 'Packet_loop_limited': Packet loop limited; 'Receive_wnd_limited': Receive window limited; 'Parse_error': Parse error; 'Error_close': Conn closed of error; 'Unknown_scid': Unknown scid; 'Dcid_mismatch': Dcid mismatch; 'Packet_too_short': Packet_too_short; 'Invalid_version': Invalid version; 'Invalid_Packet': Invalid packet; 'Invalid_conn_match': Invalid conn match; 'Invalid_session_packet': Invalid session packet; 'Stateless_reset': Stateless resert; 'Packet_lost': Packet lost; 'Packet_drop': Packet drop; 'Packet_retransmit': Packet retransmit; 'Packet_out_of_order': Packet out of order; 'Quic_packet_drop': Quic packet drop; 'Encode_error': Encode error; 'Decode_failed': Decode failed; 'Decode_stream_error': Decode stream error; 'Exceed_flow_control': Exceed flow control; 'Tx_buffer_enq': Tx buffer enqueued; 'Tx_buffer_deq': Tx buffer dequeued; 'App_buffer_enq': App buffer enqueued; 'App_buffer_deq': App buffer dequeued; 'App_buffer_queue_full': App buffer queue full; 'Iov_buffer_bind': Iov buffer bind; 'Iov_buffer_unbind': Iov buffer unbind; 'Iov_buffer_dup': Iov buffer dup; 'Iov_alloc_len': Iov alloc len; 'No_tx_queue': No tx queue; 'wsocket_created': wsocket created; 'wsocket_closed': wsocket closed; 'a10_socket_created': a10 socket created; 'a10_socket_closed': a10 socket closed; 'No_a10_socket': no a10 socket; 'No_other_side_socket': no other side socket; 'No_w_engine': no w engine; 'on_ld_timeout': lost detection timeout; 'idle_alarm': conn idle timeout; 'ack_alarm': ack timeout; 'quic_malloc': QUIC malloc; 'quic_free': QUIC free; 'quic_malloc_failure': QUIC malloc failure; 'quick_malloc_failure': quick malloc failure; 'quic_lb': QUIC LB; 'cid_zero': CID Zero; 'cid_cpu_hash': CID CPU Hash; 'invalid_cid_sig': Invalid CID Signature; 'key_update_rx': QUIC TLS key update received; 'key_update_tx': QUIC TLS key update sent; **Type:** string **Supported Values:** all, client_conn_attempted, client_conn_handshake, client_conn_created, client_conn_local_closed, client_conn_remote_closed, client_conn_failed, server_conn_attempted, server_conn_handshake, server_conn_created, server_conn_local_closed, server_conn_remote_closed, server_conn_failed, q_conn_created, q_conn_freed, local_bi_stream_current, remote_bi_stream_current, local_bi_stream_created, remote_bi_stream_created, local_bi_stream_closed, remote_bi_stream_closed, local_uni_stream_current, remote_uni_stream_current, local_uni_stream_created, remote_uni_stream_created, local_uni_stream_closed, remote_uni_stream_closed, stream_error, stream_fail_to_insert, padding_frame_rx, padding_frame_tx, ping_frame_rx, ping_frame_tx, ack_frame_rx, ack_frame_tx, ack_ecn_frame_rx, ack_ecn_frame_tx, stream_rst_frame_rx, stream_rst_frame_tx, stream_stop_frame_rx, stream_stop_frame_tx, crypto_frame_rx, crypto_frame_tx, new_token_frame_rx, new_token_frame_tx, stream_frame_rx, stream_frame_tx, stream_09_frame_rx, stream_09_frame_tx, stream_0a_frame_rx, stream_0a_frame_tx, stream_0b_frame_rx, stream_0b_frame_tx, stream_0c_frame_rx, stream_0c_frame_tx, stream_0d_frame_rx, stream_0d_frame_tx, stream_0e_frame_rx, stream_0e_frame_tx, stream_0f_frame_rx, stream_0f_frame_tx, max_data_frame_rx, max_data_frame_tx, max_stream_data_frame_rx, max_stream_data_frame_tx, max_bi_stream_frame_rx, max_bi_stream_frame_tx, max_uni_stream_frame_rx, max_uni_stream_frame_tx, data_blocked_frame_rx, data_blocked_frame_tx, stream_data_blocked_frame_rx, stream_data_blocked_frame_tx, bi_stream_data_blocked_frame_rx, bi_stream_data_blocked_frame_tx, uni_stream_data_blocked_frame_rx, uni_stream_data_blocked_frame_tx, new_conn_id_frame_rx, new_conn_id_frame_tx, retire_conn_id_frame_rx, retire_conn_id_frame_tx, path_challenge_frame_rx, path_challenge_frame_tx, path_response_frame_rx, path_response_frame_tx, conn_close_frame_rx, conn_close_frame_tx, app_conn_close_frame_rx, app_conn_close_frame_tx, handshake_done_frame_rx, handshake_done_frame_tx, unknown_frame, stream_fin_receive, stream_fin_up, stream_fin_down, stream_fin_send, stream_congest, stream_open, stream_pause_data, stream_resume_data, stream_not_send, stream_stop_send, stream_created, stream_freed, INITIAL_rx, INITIAL_tx, RTT_0_rx, RTT_0_tx, HANDSHAKE_rx, HANDSHAKE_tx, RETRY_rx, RETRY_tx, VER_rx, VER_tx, RTT_updated, Needs_ack, Delayed_ack, Packet_rx, Packet_tx, Packet_tx_failed, Congest_wnd_inc, Congest_wnd_dec, No_congest_wnd, Burst_limited, Packet_loop_limited, Receive_wnd_limited, Parse_error, Error_close, Unknown_scid, Dcid_mismatch, Packet_too_short, Invalid_version, Invalid_Packet, Invalid_conn_match, Invalid_session_packet, Stateless_reset, Packet_lost, Packet_drop, Packet_retransmit, Packet_out_of_order, Quic_packet_drop, Encode_error, Decode_failed, Decode_stream_error, Exceed_flow_control, Crypto_stream_not_found, Exceed_max_stream_id, Stream_id_mismatch, Ack_delay_huge, Ack_rng_huge_1, Ack_rng_huge_2, Ack_rng_huge_3, Too_noisy_fuzzing, Max_stream_too_big, Stream_blocked, New_conn_id_len_zero, New_conn_id_len_non_zero, Illegal_stream_len, Illegal_reason_len, Illegal_seq, Illegal_rpt, Illegal_len, Illegal_token_len, Cannot_insert_cid, Cannot_insert_srt, Cannot_retire_cid, No_next_scid, Token_len_too_long, Server_receive_new_token, Zero_frame_packet **counters2** **Description** 'Pkt_acked_failed': Pkt_acked_failed; 'Tx_buffer_enq': Tx buffer enqueued; 'Tx_buffer_deq': Tx buffer dequeued; 'App_buffer_enq': App buffer enqueued; 'App_buffer_deq': App buffer dequeued; 'App_buffer_queue_full': App buffer queue full; 'Iov_buffer_bind': Iov buffer bind; 'Iov_buffer_unbind': Iov buffer unbind; 'Iov_buffer_dup': Iov buffer dup; 'Iov_alloc_len': Iov alloc len; 'No_tx_queue': No tx queue; 'wsocket_created': wsocket created; 'wsocket_closed': wsocket closed; 'a10_socket_created': a10 socket created; 'a10_socket_closed': a10 socket closed; 'No_a10_socket': no a10 socket; 'No_other_side_socket': no other side socket; 'No_w_engine': no w engine; 'on_ld_timeout': lost detection timeout; 'idle_alarm': conn idle timeout; 'ack_alarm': ack timeout; 'quic_malloc': QUIC malloc; 'quic_free': QUIC free; 'quic_malloc_failure': QUIC malloc failure; 'quick_malloc_failure': quick malloc failure; 'quic_lb': QUIC LB; 'cid_zero': CID Zero; 'cid_cpu_hash': CID CPU Hash; 'invalid_cid_sig': Invalid CID Signature; 'key_update_rx': QUIC TLS key update received; 'key_update_tx': QUIC TLS key update sent; **Type:** string **Supported Values:** Err_frame_dec1, Err_frame_dec, Err_frame_decb, Err_frame_final_size, Err_flow_control, Err_protocol_violation, Server_rx_handshake_done, Pkt_acked_failed, Pn_insert_failed, Pn_delete_failed, Acked_packet_freed, Tx_buffer_enq, Tx_buffer_deq, App_buffer_enq, App_buffer_deq, App_buffer_queue_full, Iov_buffer_bind, Iov_buffer_unbind, Iov_buffer_dup, Iov_alloc_len, Iov_IO, Iov_System, No_tx_queue, wsocket_created, wsocket_closed, a10_socket_created, a10_socket_closed, No_a10_socket, No_other_side_socket, No_w_engine, No_w_socket, on_ld_timeout, idle_alarm, ack_alarm, close_alarm, delay_alarm, quic_malloc, quic_free, quic_malloc_failure, quick_malloc_failure, quic_lb, cid_zero, cid_cpu_hash, invalid_cid_sig, key_update_rx, key_update_tx .. _3076_ssl-expire-check: ssl-expire-check ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **before** **Description** The number of days in advance notice before expiration, default is 5 **Type:** number **Range:** 1-60 **Default:** 5 **exception** **Description:** exception is a **JSON Block**. Please see below for :ref:`3076_ssl-expire-check_exception` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/ssl-expire-check/exception ` **expire-address1** **Description** Email address for certificate expiration check **Type:** string **Format:** email-addr **Maximum Length:** 63 characters **Maximum Length:** 1 characters **interval-days** **Description** The interval of days notice after expiration, default is 2 **Type:** number **Range:** 1-5 **Default:** 2 **ssl-expire-email-address** **Description** Config Email address for certificate expiration check **Type:** string **Format:** email-addr **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-expire-check_exception: ssl-expire-check_exception ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'add': Add an exception; 'delete': Delete an exception; 'clean': Delete all exception; **Type:** string **Supported Values:** add, delete, clean **certificate-name** **Description** The certificate name **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters .. _3076_rate-limit-log: rate-limit-log ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_rate-limit-log_sampling-enable: rate-limit-log_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_log_times': Total log times; 'total_log_msg': Total log messages; 'local_log_msg': Local log messages; 'remote_log_msg': Remote log messages; 'local_log_rate': Local rate (per sec); 'remote_log_rate': Remote rate (per sec); 'msg_too_big': Log message too big; 'buff_alloc_fail': Buffer alloc fail; 'no_route': No route; 'buff_send_fail': Buffer send fail; 'alloc_conn': Log-session alloc; 'free_conn': Log-session free; 'conn_alloc_fail': Log-session alloc fail; 'no_repeat_msg': No repeat message; 'local_log_dropped': Local log dropped due to rate-limit; **Type:** string **Supported Values:** all, total_log_times, total_log_msg, local_log_msg, remote_log_msg, local_log_rate, remote_log_rate, msg_too_big, buff_alloc_fail, no_route, buff_send_fail, alloc_conn, free_conn, conn_alloc_fail, no_repeat_msg, local_log_dropped .. _3076_ssl-ocsp: ssl-ocsp ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_gaming-protocol-compliance-port-list: gaming-protocol-compliance-port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Port **Type:** number **Range:** 1-65534 **range** **Description** Port range **Type:** number **Range:** 0-512 **Default:** 0 **udp** **Description** UDP **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 .. _3076_ssl-cert-revoke: ssl-cert-revoke ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-cert-revoke_sampling-enable: ssl-cert-revoke_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'ocsp_stapling_response_good': OCSP stapling response good; 'ocsp_chain_status_good': Certificate chain status good; 'ocsp_chain_status_revoked': Certificate chain status revoked; 'ocsp_chain_status_unknown': Certificate chain status unknown; 'ocsp_request': OCSP requests; 'ocsp_response': OCSP responses; 'ocsp_connection_error': OCSP connection error; 'ocsp_uri_not_found': OCSP URI not found; 'ocsp_uri_https': Log OCSP URI https; 'ocsp_uri_unsupported': OCSP URI unsupported; 'ocsp_response_status_good': OCSP response status good; 'ocsp_response_status_revoked': OCSP response status revoked; 'ocsp_response_status_unknown': OCSP response status unknown; 'ocsp_cache_status_good': OCSP cache status good; 'ocsp_cache_status_revoked': OCSP cache status revoked; 'ocsp_cache_miss': OCSP cache miss; 'ocsp_cache_expired': OCSP cache expired; 'ocsp_other_error': Log OCSP other errors; 'ocsp_response_no_nonce': Log OCSP other errors; 'ocsp_response_nonce_error': Log OCSP other errors; 'crl_request': CRL requests; 'crl_response': CRL responses; 'crl_connection_error': CRL connection errors; 'crl_uri_not_found': CRL URI not found; 'crl_uri_https': CRL URI https; 'crl_uri_unsupported': CRL URI unsupported; 'crl_response_status_good': CRL response status good; 'crl_response_status_revoked': CRL response status revoked; 'crl_response_status_unknown': CRL response status unknown; 'crl_cache_status_good': CRL cache status good; 'crl_cache_status_revoked': CRL cache status revoked; 'crl_other_error': CRL other errors; **Type:** string **Supported Values:** all, ocsp_stapling_response_good, ocsp_chain_status_good, ocsp_chain_status_revoked, ocsp_chain_status_unknown, ocsp_request, ocsp_response, ocsp_connection_error, ocsp_uri_not_found, ocsp_uri_https, ocsp_uri_unsupported, ocsp_response_status_good, ocsp_response_status_revoked, ocsp_response_status_unknown, ocsp_cache_status_good, ocsp_cache_status_revoked, ocsp_cache_miss, ocsp_cache_expired, ocsp_other_error, ocsp_response_no_nonce, ocsp_response_nonce_error, crl_request, crl_response, crl_connection_error, crl_uri_not_found, crl_uri_https, crl_uri_unsupported, crl_response_status_good, crl_response_status_revoked, crl_response_status_unknown, crl_cache_status_good, crl_cache_status_revoked, crl_other_error .. _3076_pop3-proxy: pop3-proxy ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_pop3-proxy_sampling-enable: pop3-proxy_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num': Num; 'curr': Current proxy conns; 'total': Total proxy conns; 'svrsel_fail': Server selection failure; 'no_route': no route failure; 'snat_fail': source nat failure; 'line_too_long': line too long; 'line_mem_freed': request line freed; 'invalid_start_line': invalid start line; 'stls': stls cmd; 'request_dont_care': other cmd; 'unsupported_command': Unsupported cmd; 'bad_sequence': Bad Sequence; 'rsv_persist_conn_fail': Serv Sel Persist fail; 'smp_v6_fail': Serv Sel SMPv6 fail; 'smp_v4_fail': Serv Sel SMPv4 fail; 'insert_tuple_fail': Serv Sel insert tuple fail; 'cl_est_err': Client EST state erro; 'ser_connecting_err': Serv CTNG state error; 'server_response_err': Serv RESP state error; 'cl_request_err': Client RQ state error; 'request': Total POP3 Request; 'control_to_ssl': Control chn ssl; **Type:** string **Supported Values:** all, num, curr, total, svrsel_fail, no_route, snat_fail, line_too_long, line_mem_freed, invalid_start_line, stls, request_dont_care, unsupported_command, bad_sequence, rsv_persist_conn_fail, smp_v6_fail, smp_v4_fail, insert_tuple_fail, cl_est_err, ser_connecting_err, server_response_err, cl_request_err, request, control_to_ssl .. _3076_mlb: mlb ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_mlb_sampling-enable: mlb_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'client_msg_sent': Client message sent; 'server_msg_received': Server message received; 'server_conn_created': Server connection created; 'server_conn_rst': Server connection reset; 'server_conn_failed': Server connection failed; 'server_conn_closed': Server connection closed; 'client_conn_created': Client connection created; 'client_conn_closed': Client connection closed; 'client_conn_not_found': Client connection not found; 'msg_dropped': Message dropped; 'msg_rerouted': Message rerouted; 'mlb_dcmsg_sent': Dcmsg sent; 'mlb_dcmsg_received': Dcmsg received; 'mlb_dcmsg_error': Dcmsg error; 'mlb_dcmsg_alloc': Dcmsg alloc; 'mlb_dcmsg_free': Dcmsg free; 'mlb_server_probe': Server probe; 'mlb_server_down': Server down; **Type:** string **Supported Values:** all, client_msg_sent, server_msg_received, server_conn_created, server_conn_rst, server_conn_failed, server_conn_closed, client_conn_created, client_conn_closed, client_conn_not_found, msg_dropped, msg_rerouted, mlb_dcmsg_sent, mlb_dcmsg_received, mlb_dcmsg_error, mlb_dcmsg_alloc, mlb_dcmsg_free, mlb_server_probe, mlb_server_down .. _3076_ssl-scep-cert-log: ssl-scep-cert-log ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_player-id-ep: player-id-ep ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_smpp: smpp ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_smpp_sampling-enable: smpp_sampling-enable ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'msg_proxy_current': Curr SMPP Proxy; 'msg_proxy_total': Total SMPP Proxy; 'msg_proxy_mem_allocd': some help string; 'msg_proxy_mem_cached': some help string; 'msg_proxy_mem_freed': some help string; 'msg_proxy_client_recv': Client message rcvd; 'msg_proxy_client_send_success': Sent to server; 'msg_proxy_client_incomplete': Incomplete; 'msg_proxy_client_drop': AX responds directly; 'msg_proxy_client_connection': Connecting server; 'msg_proxy_client_fail': Number of SMPP messages received from client but failed to forward to server; 'msg_proxy_client_fail_parse': some help string; 'msg_proxy_client_fail_process': some help string; 'msg_proxy_client_fail_snat': some help string; 'msg_proxy_client_exceed_tmp_buff': some help string; 'msg_proxy_client_fail_send_pkt': some help string; 'msg_proxy_client_fail_start_server_Conn': some help string; 'msg_proxy_server_recv': Server message rcvd; 'msg_proxy_server_send_success': Sent to client; 'msg_proxy_server_incomplete': Incomplete; 'msg_proxy_server_drop': Number of the packet AX drop; 'msg_proxy_server_fail': Number of SMPP messages received from server but failed to forward to client; 'msg_proxy_server_fail_parse': some help string; 'msg_proxy_server_fail_process': some help string; 'msg_proxy_server_fail_selec_connt': some help string; 'msg_proxy_server_fail_snat': some help string; 'msg_proxy_server_exceed_tmp_buff': some help string; 'msg_proxy_server_fail_send_pkt': some help string; 'msg_proxy_create_server_conn': Server conn created; 'msg_proxy_start_server_conn': Number of server connection created successfully; 'msg_proxy_fail_start_server_conn': Number of server connection created failed; 'msg_proxy_server_conn_fail_snat': some help string; 'msg_proxy_fail_construct_server_conn': some help string; 'msg_proxy_fail_reserve_pconn': some help string; 'msg_proxy_start_server_conn_failed': some help string; 'msg_proxy_server_conn_already_exists': some help string; 'msg_proxy_fail_insert_server_conn': some help string; 'msg_proxy_parse_msg_fail': some help string; 'msg_proxy_process_msg_fail': some help string; 'msg_proxy_no_vport': some help string; 'msg_proxy_fail_select_server': some help string; 'msg_proxy_fail_alloc_mem': msg_proxy_fail_alloc_mem; 'msg_proxy_unexpected_err': some help string; 'msg_proxy_l7_cpu_failed': some help string; 'msg_proxy_l4_to_l7': some help string; 'msg_proxy_l4_from_l7': some help string; 'msg_proxy_to_l4_send_pkt': some help string; 'msg_proxy_l4_from_l4_send': some help string; 'msg_proxy_l7_to_L4': some help string; 'msg_proxy_mag_back': some help string; 'msg_proxy_fail_dcmsg': some help string; 'msg_proxy_deprecated_conn': some help string; 'msg_proxy_hold_msg': some help string; 'msg_proxy_split_pkt': some help string; 'msg_proxy_pipline_msg': some help string; 'msg_proxy_client_reset': some help string; 'msg_proxy_server_reset': some help string; 'payload_allocd': some help string; 'payload_freed': some help string; 'pkt_too_small': pkt_too_small; 'invalid_seq': some help string; 'AX_response_directly': Number of packet which AX responds directly; 'select_client_conn': Client conn selection; 'select_client_by_req': Select by request; 'select_client_from_list': Select by roundbin; 'select_client_by_conn': Select by conn; 'select_client_fail': Select failed; 'select_server_conn': Server conn selection; 'select_server_by_req': Select by request; 'select_server_from_list': Select by roundbin; 'select_server_by_conn': Select server conn by client conn; 'select_server_fail': Fail to select server conn; 'bind_conn': some help string; 'unbind_conn': some help string; 'enquire_link_recv': some help string; 'enquire_link_resp_recv': some help string; 'enquire_link_send': some help string; 'enquire_link_resp_send': some help string; 'client_conn_put_in_list': some help string; 'client_conn_get_from_list': some help string; 'server_conn_put_in_list': some help string; 'server_conn_get_from_list': some help string; 'server_conn_fail_bind': some help string; 'single_msg': some help string; 'fail_bind_msg': fail_bind_msg; **Type:** string **Supported Values:** all, msg_proxy_current, msg_proxy_total, msg_proxy_mem_allocd, msg_proxy_mem_cached, msg_proxy_mem_freed, msg_proxy_client_recv, msg_proxy_client_send_success, msg_proxy_client_incomplete, msg_proxy_client_drop, msg_proxy_client_connection, msg_proxy_client_fail, msg_proxy_client_fail_parse, msg_proxy_client_fail_process, msg_proxy_client_fail_snat, msg_proxy_client_exceed_tmp_buff, msg_proxy_client_fail_send_pkt, msg_proxy_client_fail_start_server_Conn, msg_proxy_server_recv, msg_proxy_server_send_success, msg_proxy_server_incomplete, msg_proxy_server_drop, msg_proxy_server_fail, msg_proxy_server_fail_parse, msg_proxy_server_fail_process, msg_proxy_server_fail_selec_connt, msg_proxy_server_fail_snat, msg_proxy_server_exceed_tmp_buff, msg_proxy_server_fail_send_pkt, msg_proxy_create_server_conn, msg_proxy_start_server_conn, msg_proxy_fail_start_server_conn, msg_proxy_server_conn_fail_snat, msg_proxy_fail_construct_server_conn, msg_proxy_fail_reserve_pconn, msg_proxy_start_server_conn_failed, msg_proxy_server_conn_already_exists, msg_proxy_fail_insert_server_conn, msg_proxy_parse_msg_fail, msg_proxy_process_msg_fail, msg_proxy_no_vport, msg_proxy_fail_select_server, msg_proxy_fail_alloc_mem, msg_proxy_unexpected_err, msg_proxy_l7_cpu_failed, msg_proxy_l4_to_l7, msg_proxy_l4_from_l7, msg_proxy_to_l4_send_pkt, msg_proxy_l4_from_l4_send, msg_proxy_l7_to_L4, msg_proxy_mag_back, msg_proxy_fail_dcmsg, msg_proxy_deprecated_conn, msg_proxy_hold_msg, msg_proxy_split_pkt, msg_proxy_pipline_msg, msg_proxy_client_reset, msg_proxy_server_reset, payload_allocd, payload_freed, pkt_too_small, invalid_seq, AX_response_directly, select_client_conn, select_client_by_req, select_client_from_list, select_client_by_conn, select_client_fail, select_server_conn, select_server_by_req, select_server_from_list, select_server_by_conn, select_server_fail, bind_conn, unbind_conn, enquire_link_recv, enquire_link_resp_recv, enquire_link_send, enquire_link_resp_send, client_conn_put_in_list, client_conn_get_from_list, server_conn_put_in_list, server_conn_get_from_list, server_conn_fail_bind, single_msg, fail_bind_msg .. _3076_svm-source-nat: svm-source-nat ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **pool** **Description** Specify NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_http3: http3 ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_http3_sampling-enable: http3_sampling-enable ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'client_conn_curr': Current HTTP/3 Client Connections; 'server_conn_curr': Current HTTP/3 Server Connections; 'client_conn_total': Total HTTP/3 Client Connections; 'server_conn_total': Total HTTP/3 Server Connections; 'client_conn_peak': Peak HTTP/3 Client Connections; 'server_conn_peak': Peak HTTP/3 Server Connections; 'client_request_streams_curr': Current Request Streams on client side; 'server_request_streams_curr': Current Request Streams on server side; 'client_request_streams_total': Total Request Streams on client side; 'server_request_streams_total': Total Request Streams on server side; 'client_request_push_curr': Current Push Streams on client side; 'server_request_push_curr': Current Push Streams on server side; 'client_request_push_total': Total Push Streams on client side; 'server_request_push_total': Total Push Streams on server side; 'client_request_other_curr': Current Other Streams on client side (control, decoder, encoder); 'server_request_other_curr': urrent Other Streams on server side (control, decoder, encoder); 'client_request_other_total': Total Other Streams on client side (control, decoder, encoder); 'server_request_other_total': Total Other Streams on server side (control, decoder, encoder); 'client_frame_type_headers_rcvd': HEADERS Frame received on client side; 'client_frame_type_headers_sent': HEADERS Frame sent on client side; 'client_frame_type_data_rcvd': DATA Frame received on client side; 'client_frame_type_data_sent': DATA Frame sent on client side; 'client_frame_type_cancel_push_rcvd': CANCEL PUSH Frame received on client side; 'client_frame_type_cancel_push_sent': CANCEL PUSH Frame sent on client side; 'client_frame_type_settings_rcvd': SETTINGS Frame received on client side; 'client_frame_type_settings_sent': SETTINGS Frame sent on client side; 'client_frame_type_push_promise_rcvd': PUSH PROMISE Frame received on client side; 'client_frame_type_push_promise_sent': PUSH PROMISE Frame sent on client side; 'client_frame_type_goaway_rcvd': GOAWAY Frame received on client side; 'client_frame_type_goaway_sent': GOAWAY Frame sent on client side; 'client_frame_type_max_push_id_rcvd': MAX PUSH ID Frame received on client side; 'client_frame_type_max_push_id_sent': MAX PUSH ID Frame sent on client side; 'client_frame_type_unknown_rcvd': Unknown Frame received on client side; 'client_header_frames_to_app': HEADER Frames passed to HTTP layer on client side; 'client_data_frames_to_app': DATA Frames passed to HTTP layer on client side; 'client_header_bytes_rcvd': Bytes received in HEADER frames on client side; 'client_header_bytes_sent': Bytes sent in HEADER frames on client side; 'client_data_bytes_rcvd': Bytes received in DATA frames on client side; 'client_data_bytes_sent': Bytes sent in DATA frames on client side; 'client_other_frame_bytes_rcvd': Bytes received in other frames (SETTINGS, GOAWAY, PUSH_PROMISE etc) on client side; 'client_other_frame_bytes_sent': Bytes sent in other frames (SETTINGS, GOAWAY, PUSH_PROMISE etc) on client side; 'client_heading_bytes_rcvd': Bytes received in HEADERS/DATA frame/stream heading on client side; 'client_heading_bytes_sent': Bytes sent in HEADERS/DATA frame/stream heading on client side; 'client_total_bytes_rcvd': Total Bytes received on client side; 'client_total_bytes_sent': Total Bytes sent on client side; 'server_frame_type_headers_rcvd': HEADERS Frame received on server side; 'server_frame_type_headers_sent': HEADERS Frame sent on server side; 'server_frame_type_data_rcvd': DATA Frame received on server side; 'server_frame_type_data_sent': DATA Frame sent on server side; 'server_frame_type_cancel_push_rcvd': CANCEL PUSH Frame received on server side; 'server_frame_type_cancel_push_sent': CANCEL PUSH Frame sent on server side; 'server_frame_type_settings_rcvd': SETTINGS Frame received on server side; 'server_frame_type_settings_sent': SETTINGS Frame sent on server side; 'server_frame_type_push_promise_rcvd': PUSH PROMISE Frame received on server side; 'server_frame_type_push_promise_sent': PUSH PROMISE Frame sent on server side; 'server_frame_type_goaway_rcvd': GOAWAY Frame received on server side; 'server_frame_type_goaway_sent': GOAWAY Frame sent on server side; 'server_frame_type_max_push_id_rcvd': MAX PUSH ID Frame received on server side; 'server_frame_type_max_push_id_sent': MAX PUSH ID Frame sent on server side; 'server_frame_type_unknown_rcvd': Unknown Frame received on server side; 'server_header_frames_to_app': HEADER Frames passed to HTTP layer on server side; 'server_data_frames_to_app': DATA Frames passed to HTTP layer on server side; 'server_header_bytes_rcvd': Bytes received in HEADER frames on server side; 'server_header_bytes_sent': Bytes sent in HEADER frames on server side; 'server_data_bytes_rcvd': Bytes received in DATA frames on server side; 'server_data_bytes_sent': Bytes sent in DATA frames on server side; 'server_other_frame_bytes_rcvd': Bytes received in other frames (SETTINGS, GOAWAY, PUSH_PROMISE etc) on server side; 'server_other_frame_bytes_sent': Bytes sent in other frames (SETTINGS, GOAWAY, PUSH_PROMISE etc) on server side; 'server_heading_bytes_rcvd': Bytes received in HEADERS/DATA frame/stream heading on server side; 'server_heading_bytes_sent': Bytes sent in HEADERS/DATA frame/stream heading on server side; 'server_total_bytes_rcvd': Total Bytes received on server side; 'server_total_bytes_sent': Total Bytes sent on server side; 'invalid_argument': Invalid Argument; 'invalid_state': Invalid State; 'wouldblock': Wouldblock; 'stream_in_use': Stream In Use; 'push_id_blocked': Push Id Blocked; 'malformed_http_header': Malformed Http Header; 'remove_http_header': Remove Http Header; 'malformed_http_messaging': Malformed Http Messaging; 'too_late': Too Late; 'qpack_fatal': Qpack Fatal; 'qpack_header_too_large': Qpack Header Too Large; 'ignore_stream': Ignore Stream; 'stream_not_found': Stream Not Found; 'ignore_push_promise': Ignore Push Promise; 'qpack_decompression_failed': Qpack Decompression Failed; 'qpack_encoder_stream_error': Qpack Encoder Stream Error; 'qpack_decoder_stream_error': Qpack Decoder Stream Error; 'h3_frame_unexpected': H3 Frame Unexpected; 'h3_frame_error': H3 Frame Error; 'h3_missing_settings': H3 Missing Settings; 'h3_internal_error': H3 Internal Error; 'h3_closed_critical_stream': H3 Closed Critical Stream; 'h3_general_protocol_error': H3 General Protocol Error; 'h3_id_error': H3 Id Error; 'h3_settings_error': H3 Settings Error; 'h3_stream_creation_error': H3 Stream Creation Error; 'fatal': Fatal Error; 'conn_alloc_error': HTTP/3 Connection Allocation Error; 'alloc_fail_total': Memory Allocation Failures; 'http3_rejected': HTTP3 Rejected; **Type:** string **Supported Values:** all, client_conn_curr, server_conn_curr, client_conn_total, server_conn_total, client_conn_peak, server_conn_peak, client_request_streams_curr, server_request_streams_curr, client_request_streams_total, server_request_streams_total, client_request_push_curr, server_request_push_curr, client_request_push_total, server_request_push_total, client_request_other_curr, server_request_other_curr, client_request_other_total, server_request_other_total, client_frame_type_headers_rcvd, client_frame_type_headers_sent, client_frame_type_data_rcvd, client_frame_type_data_sent, client_frame_type_cancel_push_rcvd, client_frame_type_cancel_push_sent, client_frame_type_settings_rcvd, client_frame_type_settings_sent, client_frame_type_push_promise_rcvd, client_frame_type_push_promise_sent, client_frame_type_goaway_rcvd, client_frame_type_goaway_sent, client_frame_type_max_push_id_rcvd, client_frame_type_max_push_id_sent, client_frame_type_unknown_rcvd, client_header_frames_to_app, client_data_frames_to_app, client_header_bytes_rcvd, client_header_bytes_sent, client_data_bytes_rcvd, client_data_bytes_sent, client_other_frame_bytes_rcvd, client_other_frame_bytes_sent, client_heading_bytes_rcvd, client_heading_bytes_sent, client_total_bytes_rcvd, client_total_bytes_sent, server_frame_type_headers_rcvd, server_frame_type_headers_sent, server_frame_type_data_rcvd, server_frame_type_data_sent, server_frame_type_cancel_push_rcvd, server_frame_type_cancel_push_sent, server_frame_type_settings_rcvd, server_frame_type_settings_sent, server_frame_type_push_promise_rcvd, server_frame_type_push_promise_sent, server_frame_type_goaway_rcvd, server_frame_type_goaway_sent, server_frame_type_max_push_id_rcvd, server_frame_type_max_push_id_sent, server_frame_type_unknown_rcvd, server_header_frames_to_app, server_data_frames_to_app, server_header_bytes_rcvd, server_header_bytes_sent, server_data_bytes_rcvd, server_data_bytes_sent, server_other_frame_bytes_rcvd, server_other_frame_bytes_sent, server_heading_bytes_rcvd, server_heading_bytes_sent, server_total_bytes_rcvd, server_total_bytes_sent, invalid_argument, invalid_state, wouldblock, stream_in_use, push_id_blocked, malformed_http_header, remove_http_header, malformed_http_messaging, too_late, qpack_fatal, qpack_header_too_large, ignore_stream, stream_not_found, ignore_push_promise, qpack_decompression_failed, qpack_encoder_stream_error, qpack_decoder_stream_error, h3_frame_unexpected, h3_frame_error, h3_missing_settings, h3_internal_error, h3_closed_critical_stream, h3_general_protocol_error, h3_id_error, h3_settings_error, h3_stream_creation_error, fatal, conn_alloc_error, alloc_fail_total, http3_rejected .. _3076_http2: http2 ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_http2_sampling-enable: http2_sampling-enable ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_proxy': Curr Proxy Conns; 'total_proxy': Total Proxy Conns; 'connection_preface_rcvd': Connection preface rcvd; 'control_frame': Control Frame Rcvd; 'headers_frame': HEADERS Frame Rcvd; 'continuation_frame': CONTINUATION Frame Rcvd; 'rst_frame_rcvd': RST_STREAM Frame Rcvd; 'settings_frame': SETTINGS Frame Rcvd; 'window_update_frame': WINDOW_UPDATE Frame Rcvd; 'ping_frame': PING Frame Rcvd; 'goaway_frame': GOAWAY Frame Rcvd; 'priority_frame': PRIORITY Frame Rcvd; 'data_frame': DATA Frame Recvd; 'unknown_frame': Unknown Frame Recvd; 'connection_preface_sent': Connection preface sent; 'settings_frame_sent': SETTINGS Frame Sent; 'settings_ack_sent': SETTINGS ACK Frame Sent; 'empty_settings_sent': Empty SETTINGS Frame Sent; 'ping_frame_sent': PING Frame Sent; 'window_update_frame_sent': WINDOW_UPDATE Frame Sent; 'rst_frame_sent': RST_STREAM Frame Sent; 'goaway_frame_sent': GOAWAY Frame Sent; 'header_to_app': HEADER Frame to HTTP; 'data_to_app': DATA Frame to HTTP; 'protocol_error': Protocol Error; 'internal_error': Internal Error; 'proxy_alloc_error': HTTP2 Proxy alloc Error; 'split_buff_fail': Splitting Buffer Failed; 'invalid_frame_size': Invalid Frame Size Rcvd; 'error_max_invalid_stream': Max Invalid Stream Rcvd; 'data_no_stream': DATA Frame Rcvd on non-existent stream; 'flow_control_error': Flow Control Error; 'settings_timeout': Settings Timeout; 'frame_size_error': Frame Size Error; 'refused_stream': Refused Stream; 'cancel': cancel; 'compression_error': compression error; 'connect_error': connect error; 'enhance_your_calm': enhance your calm error; 'inadequate_security': inadequate security; 'http_1_1_required': HTTP1.1 Required; 'deflate_alloc_fail': deflate alloc fail; 'inflate_alloc_fail': inflate alloc fail; 'inflate_header_fail': Inflate Header Fail; 'bad_connection_preface': Bad Connection Preface; 'cant_allocate_control_frame': Cant allocate control frame; 'cant_allocate_settings_frame': Cant allocate SETTINGS frame; 'bad_frame_type_for_stream_state': Bad frame type for stream state; 'wrong_stream_state': Wrong Stream State; 'data_queue_alloc_error': Data Queue Alloc Error; 'buff_alloc_error': Buff alloc error; 'cant_allocate_rst_frame': Cant allocate RST_STREAM frame; 'cant_allocate_goaway_frame': Cant allocate GOAWAY frame; 'cant_allocate_ping_frame': Cant allocate PING frame; 'cant_allocate_stream': Cant allocate stream; 'cant_allocate_window_frame': Cant allocate WINDOW_UPDATE frame; 'header_no_stream': header no stream; 'header_padlen_gt_frame_payload': Header padlen greater than frame payload size; 'streams_gt_max_concur_streams': Streams greater than max allowed concurrent streams; 'idle_state_unexpected_frame': Unxpected frame received in idle state; 'reserved_local_state_unexpected_frame': Unexpected frame received in reserved local state; 'reserved_remote_state_unexpected_frame': Unexpected frame received in reserved remote state; 'half_closed_remote_state_unexpected_frame': Unexpected frame received in half closed remote state; 'closed_state_unexpected_frame': Unexpected frame received in closed state; 'zero_window_size_on_stream': Window Update with zero increment rcvd; 'exceeds_max_window_size_stream': Window Update with increment that results in exceeding max window; 'stream_closed': stream closed; 'continuation_before_headers': CONTINUATION frame with no headers frame; 'invalid_frame_during_headers': frame before headers were complete; 'headers_after_continuation': headers frame before CONTINUATION was complete; 'push_promise_frame_sent': Push Promise Frame Sent; 'invalid_push_promise': unexpected PUSH_PROMISE frame; 'invalid_stream_id': received invalid stream ID; 'headers_interleaved': headers interleaved on streams; 'trailers_no_end_stream': trailers not marked as end-of-stream; 'invalid_setting_value': invalid setting-frame value; 'invalid_window_update': window-update value out of range; 'frame_header_bytes_received': frame header bytes received; 'frame_header_bytes_sent': frame header bytes sent; 'control_bytes_received': HTTP/2 control frame bytes received; 'control_bytes_sent': HTTP/2 control frame bytes sent; 'header_bytes_received': HTTP/2 header bytes received; 'header_bytes_sent': HTTP/2 header bytes sent; 'data_bytes_received': HTTP/2 data bytes received; 'data_bytes_sent': HTTP/2 data bytes sent; 'total_bytes_received': HTTP/2 total bytes received; 'total_bytes_sent': HTTP/2 total bytes sent; 'peak_proxy': Peak Proxy Conns; 'control_frame_sent': Control Frame Sent; 'continuation_frame_sent': CONTINUATION Frame Sent; 'data_frame_sent': DATA Frame Sent; 'headers_frame_sent': HEADERS Frame Sent; 'priority_frame_sent': PRIORITY Frame Sent; 'settings_ack_rcvd': SETTINGS ACK Frame Rcvd; 'empty_settings_rcvd': Empty SETTINGS Frame Rcvd; 'alloc_fail_total': Alloc Fail - Total; 'err_rcvd_total': Error Rcvd - Total; 'err_sent_total': Error Rent - Total; 'err_sent_proto_err': Error Sent - PROTOCOL_ERROR; 'err_sent_internal_err': Error Sent - INTERNAL_ERROR; 'err_sent_flow_control': Error Sent - FLOW_CONTROL_ERROR; 'err_sent_setting_timeout': Error Sent - SETTINGS_TIMEOUT; 'err_sent_stream_closed': Error Sent - STREAM_CLOSED; 'err_sent_frame_size_err': Error Sent - FRAME_SIZE_ERROR; 'err_sent_refused_stream': Error Sent - REFUSED_STREAM; 'err_sent_cancel': Error Sent - CANCEL; 'err_sent_compression_err': Error Sent - COMPRESSION_ERROR; 'err_sent_connect_err': Error Sent - CONNECT_ERROR; 'err_sent_your_calm': Error Sent - ENHANCE_YOUR_CALM; 'err_sent_inadequate_security': Error Sent - INADEQUATE_SECURITY; 'err_sent_http11_required': Error Sent - HTTP_1_1_REQUIRED; 'http2_rejected': HTTP2 Rejected; 'current_stream': Current Streams; 'stream_create': Stream Create; 'stream_free': Stream Free; 'end_stream_rcvd': End Stream Recieved; 'end_stream_sent': End Stream Sent; **Type:** string **Supported Values:** all, curr_proxy, total_proxy, connection_preface_rcvd, control_frame, headers_frame, continuation_frame, rst_frame_rcvd, settings_frame, window_update_frame, ping_frame, goaway_frame, priority_frame, data_frame, unknown_frame, connection_preface_sent, settings_frame_sent, settings_ack_sent, empty_settings_sent, ping_frame_sent, window_update_frame_sent, rst_frame_sent, goaway_frame_sent, header_to_app, data_to_app, protocol_error, internal_error, proxy_alloc_error, split_buff_fail, invalid_frame_size, error_max_invalid_stream, data_no_stream, flow_control_error, settings_timeout, frame_size_error, refused_stream, cancel, compression_error, connect_error, enhance_your_calm, inadequate_security, http_1_1_required, deflate_alloc_fail, inflate_alloc_fail, inflate_header_fail, bad_connection_preface, cant_allocate_control_frame, cant_allocate_settings_frame, bad_frame_type_for_stream_state, wrong_stream_state, data_queue_alloc_error, buff_alloc_error, cant_allocate_rst_frame, cant_allocate_goaway_frame, cant_allocate_ping_frame, cant_allocate_stream, cant_allocate_window_frame, header_no_stream, header_padlen_gt_frame_payload, streams_gt_max_concur_streams, idle_state_unexpected_frame, reserved_local_state_unexpected_frame, reserved_remote_state_unexpected_frame, half_closed_remote_state_unexpected_frame, closed_state_unexpected_frame, zero_window_size_on_stream, exceeds_max_window_size_stream, stream_closed, continuation_before_headers, invalid_frame_during_headers, headers_after_continuation, push_promise_frame_sent, invalid_push_promise, invalid_stream_id, headers_interleaved, trailers_no_end_stream, invalid_setting_value, invalid_window_update, frame_header_bytes_received, frame_header_bytes_sent, control_bytes_received, control_bytes_sent, header_bytes_received, header_bytes_sent, data_bytes_received, data_bytes_sent, total_bytes_received, total_bytes_sent, peak_proxy, control_frame_sent, continuation_frame_sent, data_frame_sent, headers_frame_sent, priority_frame_sent, settings_ack_rcvd, empty_settings_rcvd, alloc_fail_total, err_rcvd_total, err_sent_total, err_sent_proto_err, err_sent_internal_err, err_sent_flow_control, err_sent_setting_timeout, err_sent_stream_closed, err_sent_frame_size_err, err_sent_refused_stream, err_sent_cancel, err_sent_compression_err, err_sent_connect_err, err_sent_your_calm, err_sent_inadequate_security, err_sent_http11_required, http2_rejected, current_stream, stream_create, stream_free, end_stream_rcvd, end_stream_sent .. _3076_gaming-protocol-compliance-salt: gaming-protocol-compliance-salt ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **current-salt** **Description** Current salt value **Type:** number **Range:** 0-4294967295 **previous-salt** **Description** Previous salt value **Type:** number **Range:** 0-4294967295 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_aflex-log: aflex-log ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-ja3: ssl-ja3 ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_reset-unknown-conn: reset-unknown-conn ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_smtp: smtp ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_smtp_sampling-enable: smtp_sampling-enable ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_proxy': Current proxy conns; 'total_proxy': Total proxy conns; 'request': SMTP requests; 'request_success': SMTP requests (success); 'no_proxy': No proxy error; 'client_reset': Client reset; 'server_reset': Server reset; 'no_tuple': No tuple error; 'parse_req_fail': Parse request failure; 'server_select_fail': Server selection failure; 'forward_req_fail': Forward request failure; 'forward_req_data_fail': Forward REQ data failure; 'req_retran': Request retransmit; 'req_ofo': Request pkt out-of-order; 'server_reselect': Server reselection; 'server_prem_close': Server premature close; 'new_server_conn': Server connection made; 'snat_fail': Source NAT failure; 'tcp_out_reset': TCP out reset; 'Aflex_switch': aFleX switching; 'Aflex_switch_ok': aFleX switching (succ); 'recv_client_command_EHLO': Recv client EHLO; 'recv_client_command_HELO': Recv client HELO; 'recv_client_command_MAIL': Recv client MAIL; 'recv_client_command_RCPT': Recv client RCPT; 'recv_client_command_DATA': Recv client DATA; 'recv_client_command_RSET': Recv client RSET; 'recv_client_command_VRFY': Recv client VRFY; 'recv_client_command_EXPN': Recv client EXPN; 'recv_client_command_HELP': Recv client HELP; 'recv_client_command_NOOP': Recv client NOOP; 'recv_client_command_QUIT': Recv client QUIT; 'recv_client_command_STARTTLS': Recv client STARTTLS; 'recv_client_command_others': Recv client other cmds; 'send_client_service_ready': Sent client serv-rdy; 'send_client_service_not_ready': Sent client serv-not-rdy; 'send_client_close_connection': Sent client close-conn; 'send_client_go_ahead': Sent client go-ahead; 'send_client_start_TLS_first': Sent client STARTTLS-1st; 'send_client_TLS_not_available': Sent client TLS-not-aval; 'send_client_no_command': Sent client no-such-cmd; 'send_server_cmd_reset': Sent server RSET; 'TLS_established': SSL session established; 'L4_switch': L4 switching; 'recv_server_service_not_ready': Recv server serv-not-rdy; 'recv_server_unknow_reply_code': Recv server unknown-code; 'client_domain_switch': Client domain switching; 'client_domain_switch_ok': Client domain sw (succ); 'LB_switch': LB switching; 'LB_switch_ok': LB switching (succ); 'read_request_line_fail': Read request line fail; 'get_all_headers_fail': Get all headers fail; 'too_many_headers': Too many headers; 'line_too_long': Line too long; 'line_across_packet': Line across packets; 'line_extend': Line extend; 'line_extend_fail': Line extend fail; 'line_table_extend': Table extend; 'line_table_extend_fail': Table extend fail; 'parse_request_line_fail': Parse request line fail; 'insert_resonse_line_fail': Ins response line fail; 'remove_resonse_line_fail': Del response line fail; 'parse_resonse_line_fail': Parse response line fail; 'Aflex_lb_reselect': aFleX lb reselect; 'Aflex_lb_reselect_ok': aFleX lb reselect (succ); 'server_STARTTLS_init': Init server side STARTTLS; 'server_STARTTLS_fail': Server side STARTTLS fail; 'rserver_STARTTLS_disable': real server not support STARTTLS; 'recv_client_command_TURN': Recv client TURN; 'recv_client_command_ETRN': Recv client ETRN; 'send_server_ehlo': Proxy sends server EHLO; 'fail_to_save_client_ehlo': Failed to save client EHLO; 'aflex_mail_fail': aFlex Mail event failed; 'drop_server_ehlo_ok': Server EHLO_OK dropped; 'client_ehlo_saved': Client EHLO saved; **Type:** string **Supported Values:** all, curr_proxy, total_proxy, request, request_success, no_proxy, client_reset, server_reset, no_tuple, parse_req_fail, server_select_fail, forward_req_fail, forward_req_data_fail, req_retran, req_ofo, server_reselect, server_prem_close, new_server_conn, snat_fail, tcp_out_reset, Aflex_switch, Aflex_switch_ok, recv_client_command_EHLO, recv_client_command_HELO, recv_client_command_MAIL, recv_client_command_RCPT, recv_client_command_DATA, recv_client_command_RSET, recv_client_command_VRFY, recv_client_command_EXPN, recv_client_command_HELP, recv_client_command_NOOP, recv_client_command_QUIT, recv_client_command_STARTTLS, recv_client_command_others, send_client_service_ready, send_client_service_not_ready, send_client_close_connection, send_client_go_ahead, send_client_start_TLS_first, send_client_TLS_not_available, send_client_no_command, send_server_cmd_reset, TLS_established, L4_switch, recv_server_service_not_ready, recv_server_unknow_reply_code, client_domain_switch, client_domain_switch_ok, LB_switch, LB_switch_ok, read_request_line_fail, get_all_headers_fail, too_many_headers, line_too_long, line_across_packet, line_extend, line_extend_fail, line_table_extend, line_table_extend_fail, parse_request_line_fail, insert_resonse_line_fail, remove_resonse_line_fail, parse_resonse_line_fail, Aflex_lb_reselect, Aflex_lb_reselect_ok, server_STARTTLS_init, server_STARTTLS_fail, rserver_STARTTLS_disable, recv_client_command_TURN, recv_client_command_ETRN, send_server_ehlo, fail_to_save_client_ehlo, aflex_mail_fail, drop_server_ehlo_ok, client_ehlo_saved .. _3076_sip: sip ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_sip_sampling-enable: sip_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'msg_proxy_current': Number of current sip proxy connections; 'msg_proxy_total': Total number of sip proxy connections; 'msg_proxy_mem_allocd': some help string; 'msg_proxy_mem_cached': some help string; 'msg_proxy_mem_freed': some help string; 'msg_proxy_client_recv': Number of SIP messages received from client; 'msg_proxy_client_send_success': Number of SIP messages received from client and forwarded to server; 'msg_proxy_client_incomplete': Number of packet which contains incomplete message; 'msg_proxy_client_drop': Number of AX drop; 'msg_proxy_client_connection': Connecting server; 'msg_proxy_client_fail': Number of SIP messages received from client but failed to forward to server; 'msg_proxy_client_fail_parse': msg_proxy_client_fail_parse; 'msg_proxy_client_fail_process': msg_proxy_client_fail_process; 'msg_proxy_client_fail_snat': msg_proxy_client_fail_snat; 'msg_proxy_client_exceed_tmp_buff': msg_proxy_client_exceed_tmp_buff; 'msg_proxy_client_fail_send_pkt': msg_proxy_client_fail_send_pkt; 'msg_proxy_client_fail_start_server_Conn': msg_proxy_client_fail_start_server_Conn; 'msg_proxy_server_recv': Number of SIP messages received from server; 'msg_proxy_server_send_success': Number of SIP messages received from server and forwarded to client; 'msg_proxy_server_incomplete': Number of packet which contains incomplete message; 'msg_proxy_server_drop': Number of AX drop; 'msg_proxy_server_fail': Number of SIP messages received from server but failed to forward to client; 'msg_proxy_server_fail_parse': some help string; 'msg_proxy_server_fail_process': some help string; 'msg_proxy_server_fail_selec_connt': some help string; 'msg_proxy_server_fail_snat': some help string; 'msg_proxy_server_exceed_tmp_buff': some help string; 'msg_proxy_server_fail_send_pkt': some help string; 'msg_proxy_create_server_conn': Number of server connection system tries to create; 'msg_proxy_start_server_conn': Number of server connection created successfully; 'msg_proxy_fail_start_server_conn': Number of server connection create failed; 'msg_proxy_server_conn_fail_snat': some help string; 'msg_proxy_fail_construct_server_conn': some help string; 'msg_proxy_fail_reserve_pconn': some help string; 'msg_proxy_start_server_conn_failed': some help string; 'msg_proxy_server_conn_already_exists': some help string; 'msg_proxy_fail_insert_server_conn': some help string; 'msg_proxy_parse_msg_fail': some help string; 'msg_proxy_process_msg_fail': msg_proxy_process_msg_fail; 'msg_proxy_no_vport': some help string; 'msg_proxy_fail_select_server': some help string; 'msg_proxy_fail_alloc_mem': some help string; 'msg_proxy_unexpected_err': some help string; 'msg_proxy_l7_cpu_failed': some help string; 'msg_proxy_l4_to_l7': some help string; 'msg_proxy_l4_from_l7': some help string; 'msg_proxy_to_l4_send_pkt': some help string; 'msg_proxy_l4_from_l4_send': some help string; 'msg_proxy_l7_to_L4': some help string; 'msg_proxy_mag_back': some help string; 'msg_proxy_fail_dcmsg': some help string; 'msg_proxy_deprecated_conn': some help string; 'msg_proxy_hold_msg': some help string; 'msg_proxy_split_pkt': some help string; 'msg_proxy_pipline_msg': some help string; 'msg_proxy_client_reset': some help string; 'msg_proxy_server_reset': some help string; 'session_created': SIP Session created; 'session_freed': SIP Session freed; 'session_in_rml': some help string; 'session_invalid': some help string; 'conn_allocd': some help string; 'conn_freed': some help string; 'session_callid_allocd': some help string; 'session_callid_freed': some help string; 'line_mem_allocd': some help string; 'line_mem_freed': some help string; 'table_mem_allocd': some help string; 'table_mem_freed': some help string; 'cmsg_no_uri_header': some help string; 'cmsg_no_uri_session': some help string; 'sg_no_uri_header': some help string; 'smsg_no_uri_session': some help string; 'line_too_long': line_too_long; 'fail_read_start_line': fail_read_start_line; 'fail_parse_start_line': fail_parse_start_line; 'invalid_start_line': invalid_start_line; 'request_unknown_version': request_unknown_version; 'response_unknown_version': some help string; 'request_unknown': request_unknown; 'fail_parse_headers': fail_parse_headers; 'too_many_headers': some help string; 'invalid_header': some help string; 'header_name_too_long': some help string; 'body_too_big': body_too_big; 'fail_get_counter': fail_get_counter; 'msg_no_call_id': some help string; 'identify_dir_failed': some help string; 'no_sip_request': some help string; 'deprecated_msg': some help string; 'fail_insert_callid_session': some help string; 'fail_insert_uri_session': some help string; 'fail_insert_header': some help string; 'select_server_conn': some help string; 'select_server_conn_by_callid': some help string; 'select_server_conn_by_uri': some help string; 'select_server_conn_by_rev_tuple': some help string; 'select_server_conn_failed': some help string; 'select_client_conn': some help string; 'X_forward_for_select_client': some help string; 'call_id_select_client': some help string; 'uri_select_client': some help string; 'client_select_failed': some help string; 'acl_denied': some help string; 'assemble_frag_failed': some help string; 'wrong_ip_version': wrong_ip_version; 'size_too_large': size_too_large; 'fail_split_fragment': some help string; 'client_keepalive_received': some help string; 'server_keepalive_received': some help string; 'client_keepalive_send': some help string; 'server_keepalive_send': some help string; 'ax_health_check_received': some help string; 'client_request': some help string; 'client_request_ok': some help string; 'concatenate_msg': some help string; 'save_uri': some help string; 'save_uri_ok': some help string; 'save_call_id': some help string; 'save_call_id_ok': some help string; 'msg_translation': some help string; 'msg_translation_fail': msg_translation_fail; 'msg_trans_start_line': some help string; 'msg_trans_start_headers': some help string; 'msg_trans_body': some help string; 'request_register': some help string; 'request_invite': some help string; 'request_ack': some help string; 'request_cancel': some help string; 'request_bye': some help string; 'request_options': some help string; 'request_prack': some help string; 'request_subscribe': some help string; 'request_notify': some help string; 'request_publish': some help string; 'request_info': some help string; 'request_refer': some help string; 'request_message': some help string; 'request_update': some help string; 'response_unknown': some help string; 'response_1XX': some help string; 'response_2XX': some help string; 'response_3XX': some help string; 'response_4XX': some help string; 'response_5XX': some help string; 'response_6XX': some help string; 'ha_send_sip_session': some help string; 'ha_send_sip_session_ok': some help string; 'ha_fail_get_msg_header': ha_fail_get_msg_header; 'ha_recv_sip_session': some help string; 'ha_insert_sip_session_ok': some help string; 'ha_update_sip_session_ok': some help string; 'ha_invalid_pkt': some help string; 'ha_fail_alloc_sip_session': some help string; 'ha_fail_alloc_call_id': some help string; 'ha_fail_clone_sip_session': some help string; 'save_smp_call_id_rtp': some help string; 'update_smp_call_id_rtp': some help string; 'smp_call_id_rtp_session_match': some help string; 'smp_call_id_rtp_session_not_match': some help string; 'process_error_when_message_switch': some help string; **Type:** string **Supported Values:** all, msg_proxy_current, msg_proxy_total, msg_proxy_mem_allocd, msg_proxy_mem_cached, msg_proxy_mem_freed, msg_proxy_client_recv, msg_proxy_client_send_success, msg_proxy_client_incomplete, msg_proxy_client_drop, msg_proxy_client_connection, msg_proxy_client_fail, msg_proxy_client_fail_parse, msg_proxy_client_fail_process, msg_proxy_client_fail_snat, msg_proxy_client_exceed_tmp_buff, msg_proxy_client_fail_send_pkt, msg_proxy_client_fail_start_server_Conn, msg_proxy_server_recv, msg_proxy_server_send_success, msg_proxy_server_incomplete, msg_proxy_server_drop, msg_proxy_server_fail, msg_proxy_server_fail_parse, msg_proxy_server_fail_process, msg_proxy_server_fail_selec_connt, msg_proxy_server_fail_snat, msg_proxy_server_exceed_tmp_buff, msg_proxy_server_fail_send_pkt, msg_proxy_create_server_conn, msg_proxy_start_server_conn, msg_proxy_fail_start_server_conn, msg_proxy_server_conn_fail_snat, msg_proxy_fail_construct_server_conn, msg_proxy_fail_reserve_pconn, msg_proxy_start_server_conn_failed, msg_proxy_server_conn_already_exists, msg_proxy_fail_insert_server_conn, msg_proxy_parse_msg_fail, msg_proxy_process_msg_fail, msg_proxy_no_vport, msg_proxy_fail_select_server, msg_proxy_fail_alloc_mem, msg_proxy_unexpected_err, msg_proxy_l7_cpu_failed, msg_proxy_l4_to_l7, msg_proxy_l4_from_l7, msg_proxy_to_l4_send_pkt, msg_proxy_l4_from_l4_send, msg_proxy_l7_to_L4, msg_proxy_mag_back, msg_proxy_fail_dcmsg, msg_proxy_deprecated_conn, msg_proxy_hold_msg, msg_proxy_split_pkt, msg_proxy_pipline_msg, msg_proxy_client_reset, msg_proxy_server_reset, session_created, session_freed, session_in_rml, session_invalid, conn_allocd, conn_freed, session_callid_allocd, session_callid_freed, line_mem_allocd, line_mem_freed, table_mem_allocd, table_mem_freed, cmsg_no_uri_header, cmsg_no_uri_session, sg_no_uri_header, smsg_no_uri_session, line_too_long, fail_read_start_line, fail_parse_start_line, invalid_start_line, request_unknown_version, response_unknown_version, request_unknown, fail_parse_headers, too_many_headers, invalid_header, header_name_too_long, body_too_big, fail_get_counter, msg_no_call_id, identify_dir_failed, no_sip_request, deprecated_msg, fail_insert_callid_session, fail_insert_uri_session, fail_insert_header, select_server_conn, select_server_conn_by_callid, select_server_conn_by_uri, select_server_conn_by_rev_tuple, select_server_conn_failed, select_client_conn, X_forward_for_select_client, call_id_select_client, uri_select_client, client_select_failed, acl_denied, assemble_frag_failed, wrong_ip_version, size_too_large, fail_split_fragment, client_keepalive_received, server_keepalive_received, client_keepalive_send, server_keepalive_send, ax_health_check_received, client_request, client_request_ok, concatenate_msg, save_uri, save_uri_ok, save_call_id, save_call_id_ok, msg_translation, msg_translation_fail, msg_trans_start_line, msg_trans_start_headers, msg_trans_body, request_register, request_invite, request_ack, request_cancel, request_bye, request_options, request_prack, request_subscribe, request_notify, request_publish, request_info, request_refer, request_message, request_update, response_unknown, response_1XX, response_2XX, response_3XX, response_4XX, response_5XX, response_6XX, ha_send_sip_session, ha_send_sip_session_ok, ha_fail_get_msg_header, ha_recv_sip_session, ha_insert_sip_session_ok, ha_update_sip_session_ok, ha_invalid_pkt, ha_fail_alloc_sip_session, ha_fail_alloc_call_id, ha_fail_clone_sip_session, save_smp_call_id_rtp, update_smp_call_id_rtp, smp_call_id_rtp_session_match, smp_call_id_rtp_session_not_match, process_error_when_message_switch .. _3076_ssl-acme-cert-log: ssl-acme-cert-log ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ssl-forward-proxy-cert: ssl-forward-proxy-cert ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_l7session: l7session ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_l7session_sampling-enable: l7session_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'start_server_conn_succ': Start Server Conn Success; 'conn_not_exist': Conn does not exist; 'data_event': Data event from TCP; 'client_fin': FIN from client; 'server_fin': FIN from server; 'wbuf_event': Wbuf event from TCP; 'wbuf_cb_failed': Wbuf event callback failed; 'err_event': Err event from TCP; 'err_cb_failed': Err event callback failed; 'server_conn_failed': Server connection failed; 'client_rst': RST from client; 'server_rst': RST from server; 'client_rst_req': RST from client - request; 'client_rst_connecting': RST from client - connecting; 'client_rst_connected': RST from client - connected; 'client_rst_rsp': RST from client - response; 'server_rst_req': RST from server - request; 'server_rst_connecting': RST from server - connecting; 'server_rst_connected': RST from server - connected; 'server_rst_rsp': RST from server - response; 'proxy_v1_connection': counter for Proxy v1 connection; 'proxy_v2_connection': counter for Proxy v2 connection; 'curr_proxy': Curr proxy conn; 'curr_proxy_client': Curr proxy conn - client; 'curr_proxy_server': Curr proxy conn - server; 'curr_proxy_es': Curr proxy conn - ES; 'total_proxy': Total proxy conn; 'total_proxy_client': Total proxy conn - client; 'total_proxy_server': Total proxy conn - server; 'total_proxy_es': Total proxy conn - ES; 'server_select_fail': Server selection fail; 'est_event': Est event from TCP; 'est_cb_failed': Est event callback fail; 'data_cb_failed': Data event callback fail; 'hps_fwdreq_fail': Fwd req fail; 'hps_fwdreq_fail_buff': Fwd req fail - buff; 'hps_fwdreq_fail_rport': Fwd req fail - rport; 'hps_fwdreq_fail_route': Fwd req fail - route; 'hps_fwdreq_fail_persist': Fwd req fail - persist; 'hps_fwdreq_fail_server': Fwd req fail - server; 'hps_fwdreq_fail_tuple': Fwd req fail - tuple; 'udp_data_event': Data event from UDP; **Type:** string **Supported Values:** all, start_server_conn_succ, conn_not_exist, data_event, client_fin, server_fin, wbuf_event, wbuf_cb_failed, err_event, err_cb_failed, server_conn_failed, client_rst, server_rst, client_rst_req, client_rst_connecting, client_rst_connected, client_rst_rsp, server_rst_req, server_rst_connecting, server_rst_connected, server_rst_rsp, proxy_v1_connection, proxy_v2_connection, curr_proxy, curr_proxy_client, curr_proxy_server, curr_proxy_es, total_proxy, total_proxy_client, total_proxy_server, total_proxy_es, server_select_fail, est_event, est_cb_failed, data_cb_failed, hps_fwdreq_fail, hps_fwdreq_fail_buff, hps_fwdreq_fail_rport, hps_fwdreq_fail_route, hps_fwdreq_fail_persist, hps_fwdreq_fail_server, hps_fwdreq_fail_tuple, udp_data_event .. _3076_dns-cache: dns-cache ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_dns-cache_sampling-enable: dns-cache_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_q': Total query; 'total_r': Total server response; 'hit': Total cache hit; 'bad_q': Query not passed; 'encode_q': Query encoded; 'multiple_q': Query with multiple questions; 'oversize_q': Query exceed cache size; 'bad_r': Response not passed; 'oversize_r': Response exceed cache size; 'encode_r': Response encoded; 'multiple_r': Response with multiple questions; 'answer_r': Response with multiple answers; 'ttl_r': Response with short TTL; 'ageout': Total aged out; 'bad_answer': Bad Answer; 'ageout_weight': Total aged for lower weight; 'total_log': Total stats log sent; 'total_alloc': Total allocated; 'total_freed': Total freed; 'current_allocate': Current allocate; 'current_data_allocate': Current data allocate; 'resolver_queue_full': Resolver task queue full; 'truncated_r': Response with Truncation bit set; **Type:** string **Supported Values:** all, total_q, total_r, hit, bad_q, encode_q, multiple_q, oversize_q, bad_r, oversize_r, encode_r, multiple_r, answer_r, ttl_r, ageout, bad_answer, ageout_weight, total_log, total_alloc, total_freed, current_allocate, current_data_allocate, resolver_queue_full, truncated_r .. _3076_ipv6-class-list-list: ipv6-class-list-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-list** **Type:** List **name** **Description** Specify name of the class list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** test **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _3076_ipv6-class-list-list_ipv6-list: ipv6-class-list-list_ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'add': Add the entry; 'delete': Delete the entry; **Type:** string **Supported Values:** add, delete **glid** **Description** Use global Limit ID (Specify global LID index) **Type:** string **Format:** string-rlx **Maximum Length:** 1023 characters **Maximum Length:** 1 characters **Mutual Exclusion:** glid,lid, lsn-lid, and lsn-radius-profile are mutually exclusive **ipv6-addr** **Description** Specify IPv6 host or subnet **Type:** string **Format:** ipv6-address-plen **lid** **Description** Use Limit ID defined in template (Specify LID index) **Type:** number **Range:** 1-1023 **Mutual Exclusion:** lid,glid, lsn-lid, and lsn-radius-profile are mutually exclusive **lsn-lid** **Description** LSN Limit ID (LID index) **Type:** number **Range:** 1-1023 **Mutual Exclusion:** lsn-lid,lid, glid, and lsn-radius-profile are mutually exclusive **lsn-radius-profile** **Description** LSN RADIUS Profile Index **Type:** number **Range:** 1-16 **Mutual Exclusion:** lsn-radius-profile,lid, glid, and lsn-lid are mutually exclusive .. _3076_ssl-crl: ssl-crl ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ip-dns-cache: ip-dns-cache ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_server-ssl-counters: server-ssl-counters ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_hw-compress: hw-compress ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_hw-compress_sampling-enable: hw-compress_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'request_count': Total request count; 'submit_count': Total submit count; 'response_count': Total response count; 'failure_count': Total failure count; 'failure_code': Last failure code; 'ring_full_count': Compression queue full; 'max_outstanding_request_count': Max queued request count; 'max_outstanding_submit_count': Max queued submit count; **Type:** string **Supported Values:** all, request_count, submit_count, response_count, failure_count, failure_code, ring_full_count, max_outstanding_request_count, max_outstanding_submit_count .. _3076_transparent-acl-template: transparent-acl-template ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **name** **Description** Specify template name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Reference Object:** :doc:`/axapi/v3/slb/template/tcp ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_player-id-global: player-id-global ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **abs-max-expiration** **Description** Absolute max record expiration value (default 10 minutes) (Absolute max record expiration time in minutes, default 10) **Type:** number **Range:** 1-32767 **Default:** 10 **enable-64bit-player-id** **Description** Enable 64 bit player id check. Default is 32 bit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enforcement-timer** **Description** Time to playerid enforcement after bootup (default 480 seconds) (Time to playerid enforcement in seconds, default 480) **Type:** number **Range:** 1-32767 **Default:** 480 **force-passive** **Description** Forces the device to be in passive mode (Only stats and no packet drops) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **min-expiration** **Description** Minimum record expiration value (default 1 min) (Min record expiration time in minutes, default 1) **Type:** number **Range:** 1-32767 **Default:** 1 **pkt-activity-expiration** **Description** Packet activity record expiration value (default 5 minutes) (Packet activity record expiration time in minutes, default 5) **Type:** number **Range:** 1-32767 **Default:** 5 **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_player-id-global_sampling-enable: player-id-global_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_playerids_created': Playerid records created; 'total_playerids_deleted': Playerid records deleted; 'total_abs_max_age_outs': Playerid records max time aged out; 'total_pkt_activity_age_outs': Playerid records idle timeout; 'total_invalid_playerid_pkts': Invalid playerid packets; 'total_invalid_playerid_drops': Invalid playerid packet drops; 'total_valid_playerid_pkts': Valid playerid packets; **Type:** string **Supported Values:** all, total_playerids_created, total_playerids_deleted, total_abs_max_age_outs, total_pkt_activity_age_outs, total_invalid_playerid_pkts, total_invalid_playerid_drops, total_valid_playerid_pkts .. _3076_service-group-list: service-group-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **backup-server-event-log** **Description** Send log info on back up server events **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-rate** **Description** Dynamically enable stateless method by conn-rate (Rate to trigger stateless method(conn/sec)) **Type:** number **Range:** 1-1000000 **Mutual Exclusion:** conn-rate and l4-session-usage are mutually exclusive **conn-rate-duration** **Description** Period that trigger condition consistently happens(seconds) **Type:** number **Range:** 1-600 **conn-rate-grace-period** **Description** Define the grace period during transition (Define the grace period during transition(seconds)) **Type:** number **Range:** 1-600 **conn-rate-log** **Description** Send log if transition happens **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **conn-rate-revert-duration** **Description** Period that revert condition consistently happens(seconds) **Type:** number **Range:** 1-600 **conn-revert-rate** **Description** Rate to revert to statelful method (conn/sec) **Type:** number **Range:** 1-1000000 **extended-stats** **Description** Enable extended statistics on service group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **health-check** **Description** Health Check (Monitor Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check, shared-partition-svcgrp-health-check, and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable health check **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable,health-check, shared-partition-svcgrp-health-check, and svcgrp-health-check-shared are mutually exclusive **l4-session-revert-duration** **Description** Period that revert condition consistently happens(seconds) **Type:** number **Range:** 1-600 **l4-session-usage** **Description** Dynamically enable stateless method by session usage (Usage to trigger stateless method) **Type:** number **Range:** 1-100 **Mutual Exclusion:** l4-session-usage and conn-rate are mutually exclusive **l4-session-usage-duration** **Description** Period that trigger condition consistently happens(seconds) **Type:** number **Range:** 1-600 **l4-session-usage-grace-period** **Description** Define the grace period during transition (Define the grace period during transition(seconds)) **Type:** number **Range:** 1-600 **l4-session-usage-log** **Description** Send log if transition happens **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **l4-session-usage-revert-rate** **Description** Usage to revert to statelful method **Type:** number **Range:** 1-100 **lb-method** **Description** 'dst-ip-hash': Load-balancing based on only Dst IP and Port hash; 'dst-ip-only-hash': Load-balancing based on only Dst IP hash; 'fastest-response': Fastest response time on service port level; 'least-request': Least request on service port level; 'src-ip-hash': Load-balancing based on only Src IP and Port hash; 'src-ip-only-hash': Load-balancing based on only Src IP hash; 'weighted-rr': Weighted round robin on server level; 'service-weighted-rr': Weighted round robin on service port level; 'round-robin': Round robin on server level; 'round-robin-strict': Strict mode round robin on server level; 'odd-even-hash': odd/even hash based of client src-ip; **Type:** string **Supported Values:** dst-ip-hash, dst-ip-only-hash, fastest-response, least-request, src-ip-hash, src-ip-only-hash, weighted-rr, service-weighted-rr, round-robin, round-robin-strict, odd-even-hash **Default:** round-robin **Mutual Exclusion:** lb-method,lrprr-method, lc-method, stateless-lb-method, llb-method, and lclb-method are mutually exclusive **lc-method** **Description** 'least-connection': Least connection on server level; 'service-least-connection': Least connection on service port level; 'weighted-least-connection': Weighted least connection on server level; 'service-weighted-least-connection': Weighted least connection on service port level; **Type:** string **Supported Values:** least-connection, service-least-connection, weighted-least-connection, service-weighted-least-connection **Mutual Exclusion:** lc-method,lb-method, lrprr-method, stateless-lb-method, llb-method, and lclb-method are mutually exclusive **lclb-method** **Description** 'link-cost-load-balance': Link cost load balance; **Type:** string **Supported Values:** link-cost-load-balance **Mutual Exclusion:** lclb-method,lb-method, lrprr-method, lc-method, stateless-lb-method, and llb-method are mutually exclusive **link-probe-template** **Description** Link Probe template (Link Probe template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/link-probe ` **llb-method** **Description** 'next-hop-link': Server selection w/ link probe template on service port level; **Type:** string **Supported Values:** next-hop-link **Mutual Exclusion:** llb-method,lb-method, lrprr-method, lc-method, stateless-lb-method, and lclb-method are mutually exclusive **lrprr-method** **Description** 'service-least-request-pseudo-round-robin': Least request on service port level and select the oldest node for sub-select; **Type:** string **Supported Values:** service-least-request-pseudo-round-robin **Mutual Exclusion:** lrprr-method,lb-method, lc-method, stateless-lb-method, llb-method, and lclb-method are mutually exclusive **member-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/service-group/{name}/member/{name}+{port} ` **min-active-member** **Description** Minimum Active Member Per Priority (Minimum Active Member before Action) **Type:** number **Range:** 1-1024 **min-active-member-action** **Description** 'dynamic-priority': dynamic change member priority to met the min-active-member requirement; 'skip-pri-set': Skip Current Priority Set If Min not met; **Type:** string **Supported Values:** dynamic-priority, skip-pri-set **name** **Description** SLB Service Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **persist-scoring** **Description** 'global': Use Global Configuration; 'enable': Enable persist-scoring; 'disable': Disable persist-scoring; **Type:** string **Supported Values:** global, enable, disable **Default:** global **priorities** **Type:** List **priority-affinity** **Description** Priority affinity. Persist to the same priority if possible. **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **protocol** **Description** 'tcp': TCP LB service; 'udp': UDP LB service; **Type:** string **Supported Values:** tcp, udp **pseudo-round-robin** **Description** PRR, select the oldest node for sub-select **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **report-delay** **Description** Reporting frequency (in minutes) **Type:** number **Range:** 1-7200 **reset** **Description:** reset is a **JSON Block**. Please see below for :ref:`3076_service-group-list_reset` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/service-group/{name}/reset ` **reset-on-server-selection-fail** **Description** Send reset to client if server selection fails **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reset-priority-affinity** **Description** Reset **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rpt-ext-server** **Description** Report top 10 fastest/slowest servers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sample-rsp-time** **Description** sample server response time **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sampling-enable** **Type:** List **shared-partition-policy-template** **Description** Reference a policy template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-policy-template and template-policy are mutually exclusive **shared-partition-svcgrp-health-check** **Description** Reference a health-check from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-svcgrp-health-check, health-check, and health-check-disable are mutually exclusive **stateless-auto-switch** **Description** Enable auto stateless method **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stateless-lb-method** **Description** 'stateless-dst-ip-hash': Stateless load-balancing based on Dst IP and Dst port hash; 'stateless-per-pkt-round-robin': Stateless load-balancing using per-packet round-robin; 'stateless-src-dst-ip-hash': Stateless load-balancing based on IP and port hash for both Src and Dst; 'stateless-src-dst-ip-only-hash': Stateless load-balancing based on only IP hash for both Src and Dst; 'stateless-src-ip-hash': Stateless load-balancing based on Src IP and Src port hash; 'stateless-src-ip-only-hash': Stateless load-balancing based on only Src IP hash; 'stateless-per-pkt-weighted-rr': Stateless load-balancing using per-packet weighted round robin on server level; 'stateless-per-pkt-service-weighted-rr': Stateless load-balancing using per-packet weighted round robin on service port level; **Type:** string **Supported Values:** stateless-dst-ip-hash, stateless-per-pkt-round-robin, stateless-src-dst-ip-hash, stateless-src-dst-ip-only-hash, stateless-src-ip-hash, stateless-src-ip-only-hash, stateless-per-pkt-weighted-rr, stateless-per-pkt-service-weighted-rr **Mutual Exclusion:** stateless-lb-method,lb-method, lrprr-method, lc-method, llb-method, and lclb-method are mutually exclusive **stateless-lb-method2** **Description** 'stateless-dst-ip-hash': Stateless load-balancing based on Dst IP and Dst port hash; 'stateless-per-pkt-round-robin': Stateless load-balancing using per-packet round-robin; 'stateless-src-dst-ip-hash': Stateless load-balancing based on IP and port hash for both Src and Dst; 'stateless-src-dst-ip-only-hash': Stateless load-balancing based on only IP hash for both Src and Dst; 'stateless-src-ip-hash': Stateless load-balancing based on Src IP and Src port hash; 'stateless-src-ip-only-hash': Stateless load-balancing based on only Src IP hash; 'stateless-per-pkt-weighted-rr': Stateless load-balancing using per-packet weighted round robin on server level; 'stateless-per-pkt-service-weighted-rr': Stateless load-balancing using per-packet weighted round robin on service port level; **Type:** string **Supported Values:** stateless-dst-ip-hash, stateless-per-pkt-round-robin, stateless-src-dst-ip-hash, stateless-src-dst-ip-only-hash, stateless-src-ip-hash, stateless-src-ip-only-hash, stateless-per-pkt-weighted-rr, stateless-per-pkt-service-weighted-rr **stats-data-action** **Description** 'stats-data-enable': Enable statistical data collection for service group; 'stats-data-disable': Disable statistical data collection for service group; **Type:** string **Supported Values:** stats-data-enable, stats-data-disable **Default:** stats-data-enable **strict-select** **Description** strict selection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **svcgrp-health-check-shared** **Description** Health Check (Monitor Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** svcgrp-health-check-shared and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **template-policy** **Description** Policy template (Policy template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** template-policy and shared-partition-policy-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/policy ` **template-policy-shared** **Description** Policy template **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/policy ` **template-port** **Description** Port template (Port template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/port ` **top-fastest** **Description** Report top 10 fastest servers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **top-slowest** **Description** Report top 10 slowest servers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **traffic-replication-mirror** **Description** Mirror Bi-directional Packet **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** traffic-replication-mirror,traffic-replication-mirror-da-repl, traffic-replication-mirror-ip-repl, traffic-replication-mirror-sa-da-repl, and traffic-replication-mirror-sa-repl are mutually exclusive **traffic-replication-mirror-da-repl** **Description** Replace Destination MAC **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** traffic-replication-mirror-da-repl,traffic-replication-mirror, traffic-replication-mirror-ip-repl, traffic-replication-mirror-sa-da-repl, and traffic-replication-mirror-sa-repl are mutually exclusive **traffic-replication-mirror-ip-repl** **Description** Replaces IP with server-IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** traffic-replication-mirror-ip-repl,traffic-replication-mirror, traffic-replication-mirror-da-repl, traffic-replication-mirror-sa-da-repl, and traffic-replication-mirror-sa-repl are mutually exclusive **traffic-replication-mirror-sa-da-repl** **Description** Replace Source MAC and Destination MAC **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** traffic-replication-mirror-sa-da-repl,traffic-replication-mirror, traffic-replication-mirror-da-repl, traffic-replication-mirror-ip-repl, and traffic-replication-mirror-sa-repl are mutually exclusive **traffic-replication-mirror-sa-repl** **Description** Replace Source MAC **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** traffic-replication-mirror-sa-repl,traffic-replication-mirror, traffic-replication-mirror-da-repl, traffic-replication-mirror-ip-repl, and traffic-replication-mirror-sa-da-repl are mutually exclusive **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 .. _3076_service-group-list_member-list: service-group-list_member-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **fqdn-name** **Description** Server hostname - Not applicable if real server is already defined **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **host** **Description** IP Address - Not applicable if real server is already defined **Type:** string **Format:** ipv4-address **member-priority** **Description** Priority of Port in the Group (Priority of Port in the Group, default is 1) **Type:** number **Range:** 1-16 **Default:** 1 **member-state** **Description** 'enable': Enable member service port; 'disable': Disable member service port; 'disable-with-health-check': disable member service port, but health check work; **Type:** string **Supported Values:** enable, disable, disable-with-health-check **Default:** enable **member-stats-data-disable** **Description** Disable statistical data collection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **member-template** **Description** Real server port template (Real server port template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/port ` **name** **Description** Member name **Type:** string **Format:** comp-string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/server ` **port** **Description** Port number **Type:** number **Range:** 0-65534 **Default:** 65534 **Reference Object:** :doc:`/axapi/v3/slb/server/port ` **resolve-as** **Description** 'resolve-to-ipv4': Use A Query only to resolve FQDN; 'resolve-to-ipv6': Use AAAA Query only to resolve FQDN; 'resolve-to-ipv4-and-ipv6': Use A as well as AAAA Query to resolve FQDN; **Type:** string **Supported Values:** resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6 **Default:** resolve-to-ipv4 **sampling-enable** **Type:** List **server-ipv6-addr** **Description** IPV6 Address - Not applicable if real server is already defined **Type:** string **Format:** ipv6-address **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 .. _3076_service-group-list_member-list_sampling-enable: service-group-list_member-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_fwd_bytes': Bytes processed in forward direction; 'total_fwd_pkts': Packets processed in forward direction; 'total_rev_bytes': Bytes processed in reverse direction; 'total_rev_pkts': Packets processed in reverse direction; 'total_conn': Total established connections; 'total_rev_pkts_inspected': Total reverse packets inspected; 'total_rev_pkts_inspected_status_code_2xx': Total reverse packets inspected status code 2xx; 'total_rev_pkts_inspected_status_code_non_5xx': Total reverse packets inspected status code non 5xx; 'curr_req': Current requests; 'total_req': Total requests; 'total_req_succ': Total requests successful; 'peak_conn': Peak connections; 'response_time': Response time; 'fastest_rsp_time': Fastest response time; 'slowest_rsp_time': Slowest response time; 'curr_ssl_conn': Current SSL connections; 'total_ssl_conn': Total SSL connections; 'curr_conn_overflow': Current connection counter overflow count; 'state_flaps': State flaps count; **Type:** string **Supported Values:** all, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, total_rev_pkts_inspected, total_rev_pkts_inspected_status_code_2xx, total_rev_pkts_inspected_status_code_non_5xx, curr_req, total_req, total_req_succ, peak_conn, response_time, fastest_rsp_time, slowest_rsp_time, curr_ssl_conn, total_ssl_conn, curr_conn_overflow, state_flaps .. _3076_service-group-list_reset: service-group-list_reset ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **auto-switch** **Description** Reset auto stateless state **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _3076_service-group-list_priorities: service-group-list_priorities ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **priority** **Description** Priority option. Define different action for each priority node. (Priority in the Group) **Type:** number **Range:** 1-16 **priority-action** **Description** 'drop': Drop request when all priority nodes fail; 'drop-if-exceed-limit': Drop request when connection over limit; 'proceed': Proceed to next priority when all priority nodes fail(default); 'reset': Send client reset when all priority nodes fail; 'reset-if-exceed-limit': Send client reset when connection over limit; **Type:** string **Supported Values:** drop, drop-if-exceed-limit, proceed, reset, reset-if-exceed-limit **Default:** proceed .. _3076_service-group-list_sampling-enable: service-group-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'server_selection_fail_drop': Drops due to Service selection failure; 'server_selection_fail_reset': Resets sent out for Service selection failure; 'service_peak_conn': Peak connection count for the Service Group; 'service_healthy_host': Service Group healthy host count; 'service_unhealthy_host': Service Group unhealthy host count; 'service_req_count': Service Group request count; 'service_resp_count': Service Group response count; 'service_resp_2xx': Service Group response 2xx count; 'service_resp_3xx': Service Group response 3xx count; 'service_resp_4xx': Service Group response 4xx count; 'service_resp_5xx': Service Group response 5xx count; 'service_curr_conn_overflow': Current connection counter overflow count; **Type:** string **Supported Values:** all, server_selection_fail_drop, server_selection_fail_reset, service_peak_conn, service_healthy_host, service_unhealthy_host, service_req_count, service_resp_count, service_resp_2xx, service_resp_3xx, service_resp_4xx, service_resp_5xx, service_curr_conn_overflow .. _3076_ssl-error: ssl-error ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_icap_http: icap_http ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_icap_http_sampling-enable: icap_http_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'status_200': Status code 200; 'status_201': Status code 201; 'status_202': Status code 202; 'status_203': Status code 203; 'status_204': Status code 204; 'status_205': Status code 205; 'status_206': Status code 206; 'status_207': Status code 207; 'status_100': Status code 100; 'status_101': Status code 101; 'status_102': Status code 102; 'status_300': Status code 300; 'status_301': Status code 301; 'status_302': Status code 302; 'status_303': Status code 303; 'status_304': Status code 304; 'status_305': Status code 305; 'status_306': Status code 306; 'status_307': Status code 307; 'status_400': Status code 400; 'status_401': Status code 401; 'status_402': Status code 402; 'status_403': Status code 403; 'status_404': Status code 404; 'status_405': Status code 405; 'status_406': Status code 406; 'status_407': Status code 407; 'status_408': Status code 408; 'status_409': Status code 409; 'status_410': Status code 410; 'status_411': Status code 411; 'status_412': Status code 412; 'status_413': Status code 413; 'status_414': Status code 414; 'status_415': Status code 415; 'status_416': Status code 416; 'status_417': Status code 417; 'status_418': Status code 418; 'status_422': Status code 422; 'status_423': Status code 423; 'status_424': Status code 424; 'status_425': Status code 425; 'status_426': Status code 426; 'status_449': Status code 449; 'status_450': Status code 450; 'status_500': Status code 500; 'status_501': Status code 501; 'status_502': Status code 502; 'status_503': Status code 503; 'status_504': Status code 504; 'status_505': Status code 505; 'status_506': Status code 506; 'status_507': Status code 507; 'status_508': Status code 508; 'status_509': Status code 509; 'status_510': Status code 510; 'status_1xx': status code 1XX; 'status_2xx': status code 2XX; 'status_3xx': status code 3XX; 'status_4xx': status code 4XX; 'status_5xx': status code 5XX; 'status_6xx': status code 6XX; 'status_unknown': Status code unknown; **Type:** string **Supported Values:** all, status_200, status_201, status_202, status_203, status_204, status_205, status_206, status_207, status_100, status_101, status_102, status_300, status_301, status_302, status_303, status_304, status_305, status_306, status_307, status_400, status_401, status_402, status_403, status_404, status_405, status_406, status_407, status_408, status_409, status_410, status_411, status_412, status_413, status_414, status_415, status_416, status_417, status_418, status_422, status_423, status_424, status_425, status_426, status_449, status_450, status_500, status_501, status_502, status_503, status_504, status_505, status_506, status_507, status_508, status_509, status_510, status_1xx, status_2xx, status_3xx, status_4xx, status_5xx, status_6xx, status_unknown .. _3076_server-list: server-list ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': Enable this Real Server; 'disable': Disable this Real Server; 'disable-with-health-check': disable real server, but health check work; **Type:** string **Supported Values:** enable, disable, disable-with-health-check **Default:** enable **alternate-server** **Type:** List **conn-limit** **Description** Connection Limit **Type:** number **Range:** 1-64000000 **Default:** 64000000 **conn-resume** **Description** Connection Resume (Connection Resume (min active conn before resume taking new conn)) **Type:** number **Range:** 1-1000000 **ethernet** **Description** ethernet interface **Type:** number **Format:** interface **Reference Object:** :doc:`/axapi/v3/interface/ethernet ` **extended-stats** **Description** Enable extended statistics on real server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **external-ip** **Description** External IP address for NAT of GSLB **Type:** string **Format:** ipv4-address **fqdn-name** **Description** Server hostname **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fqdn-name, server-ipv6-addr, and host are mutually exclusive **health-check** **Description** Health Check Monitor (Health monitor name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check, shared-partition-health-check, and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable configured health check configuration **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable,health-check, shared-partition-health-check, and health-check-shared are mutually exclusive **health-check-shared** **Description** Health Check Monitor (Health monitor name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check-shared and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **host** **Description** IP Address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** host, server-ipv6-addr, and fqdn-name are mutually exclusive **ipv6** **Description** IPv6 address Mapping of GSLB **Type:** string **Format:** ipv6-address **l2-health-check-path** **Description** L2 health check path **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/system/path ` **name** **Description** Server Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **port-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/server/{name}/port/{port-number}+{protocol} ` **resolve-as** **Description** 'resolve-to-ipv4': Use A Query only to resolve FQDN; 'resolve-to-ipv6': Use AAAA Query only to resolve FQDN; 'resolve-to-ipv4-and-ipv6': Use A as well as AAAA Query to resolve FQDN; **Type:** string **Supported Values:** resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6 **Default:** resolve-to-ipv4 **sampling-enable** **Type:** List **server-ipv6-addr** **Description** IPV6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** server-ipv6-addr, host, and fqdn-name are mutually exclusive **shared-partition-health-check** **Description** Reference a health-check from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-health-check, health-check, and health-check-disable are mutually exclusive **shared-partition-server-template** **Description** Reference a server template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-server-template and template-server are mutually exclusive **slow-start** **Description** Slowly ramp up the connection number after server is up (start from 128, then double every 10 sec till 4096) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **spoofing-cache** **Description** This server is a spoofing cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stats-data-action** **Description** 'stats-data-enable': Enable statistical data collection for real server; 'stats-data-disable': Disable statistical data collection for real server; **Type:** string **Supported Values:** stats-data-enable, stats-data-disable **Default:** stats-data-enable **template-link-cost** **Description** Link-Cost template (Link-Cost template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/link-cost ` **template-server** **Description** Server template (Server template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Mutual Exclusion:** template-server and shared-partition-server-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/server ` **template-server-shared** **Description** Server Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/server ` **trunk** **Description** trunk interface **Type:** number **Range:** 1-4096 **Reference Object:** :doc:`/axapi/v3/interface/trunk ` **use-aam-server** **Description** Using aam server. For health check, please configure it in aam server **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 **weight** **Description** Weight for this Real Server (Connection Weight) **Type:** number **Range:** 1-1000 **Default:** 1 .. _3076_server-list_port-list: server-list_port-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': enable; 'disable': disable; 'disable-with-health-check': disable port, but health check work; **Type:** string **Supported Values:** enable, disable, disable-with-health-check **Default:** enable **alternate-port** **Type:** List **auth-cfg** **Description:** auth-cfg is a **JSON Block**. Please see below for :ref:`3076_server-list_port-list_auth-cfg` **Type:** Object **conn-limit** **Description** Connection Limit **Type:** number **Range:** 1-64000000 **Default:** 64000000 **conn-resume** **Description** Connection Resume **Type:** number **Range:** 1-1000000 **extended-stats** **Description** Enable extended statistics on real server port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **follow-port-protocol** **Description** 'tcp': TCP Port; 'udp': UDP Port; **Type:** string **Supported Values:** tcp, udp **health-check** **Description** Health Check (Monitor Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check,shared-rport-health-check, health-check-follow-port, and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable health check **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable,health-check, shared-rport-health-check, rport-health-check-shared, and health-check-follow-port are mutually exclusive **health-check-follow-port** **Description** Specify which port to follow for health status (Port Number) **Type:** number **Range:** 1-65534 **Mutual Exclusion:** health-check-follow-port, health-check, and health-check-disable are mutually exclusive **no-logging** **Description** Do not log connection over limit event **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no-ssl** **Description** No SSL **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **only** **Description** Force using HTTP/2 with Prior Knowledge all the time **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **packet-capture-template** **Description** Name of the packet capture template to be bind with this object **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/slb-port-tmpl ` **port-number** **Description** Port Number **Type:** number **Range:** 0-65534 **protocol** **Description** 'tcp': TCP Port; 'udp': UDP Port; **Type:** string **Supported Values:** tcp, udp **range** **Description** Port range (Port range value - used for vip-to-rport-mapping and vport-rport range mapping) **Type:** number **Range:** 0-254 **Default:** 0 **rport-health-check-shared** **Description** Health Check (Monitor Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** rport-health-check-shared and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **sampling-enable** **Type:** List **shared-partition-port-template** **Description** Reference a port template from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-partition-port-template and template-port are mutually exclusive **shared-rport-health-check** **Description** Reference a health-check from shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared-rport-health-check, health-check, and health-check-disable are mutually exclusive **stats-data-action** **Description** 'stats-data-enable': Enable statistical data collection for real server port; 'stats-data-disable': Disable statistical data collection for real server port; **Type:** string **Supported Values:** stats-data-enable, stats-data-disable **Default:** stats-data-enable **support-http2** **Description** Starting HTTP/2 with Prior Knowledge **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **template-port** **Description** Port template (Port template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** default **Mutual Exclusion:** template-port and shared-partition-port-template are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/template/port ` **template-port-shared** **Description** Port Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/port ` **template-server-ssl** **Description** Server side SSL template (Server side SSL Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/server-ssl ` **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 **weight** **Description** Port Weight (Connection Weight) **Type:** number **Range:** 1-1000 **Default:** 1 .. _3076_server-list_port-list_sampling-enable: server-list_port-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'curr_req': Current requests; 'total_req': Total Requests; 'total_req_succ': Total requests succ; 'total_fwd_bytes': Bytes processed in forward direction; 'total_fwd_pkts': Packets processed in forward direction; 'total_rev_bytes': Bytes processed in reverse direction; 'total_rev_pkts': Packets processed in reverse direction; 'total_conn': Total connections; 'last_total_conn': Last total connections; 'peak_conn': Peak connections; 'es_resp_200': Response status 200; 'es_resp_300': Response status 300; 'es_resp_400': Response status 400; 'es_resp_500': Response status 500; 'es_resp_other': Response status other; 'es_req_count': Total proxy requests; 'es_resp_count': Total proxy response; 'es_resp_invalid_http': Total non-http response; 'total_rev_pkts_inspected': Total reverse packets inspected; 'total_rev_pkts_inspected_good_status_code': Total reverse packets with good status code inspected; 'response_time': Response time; 'fastest_rsp_time': Fastest response time; 'slowest_rsp_time': Slowest response time; 'curr_ssl_conn': Current SSL connections; 'total_ssl_conn': Total SSL connections; 'resp-count': Total Response Count; 'resp-1xx': Response status 1xx; 'resp-2xx': Response status 2xx; 'resp-3xx': Response status 3xx; 'resp-4xx': Response status 4xx; 'resp-5xx': Response status 5xx; 'resp-other': Response status Other; 'resp-latency': Time to First Response Byte; 'curr_pconn': Current persistent connections; **Type:** string **Supported Values:** all, curr_req, total_req, total_req_succ, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, last_total_conn, peak_conn, es_resp_200, es_resp_300, es_resp_400, es_resp_500, es_resp_other, es_req_count, es_resp_count, es_resp_invalid_http, total_rev_pkts_inspected, total_rev_pkts_inspected_good_status_code, response_time, fastest_rsp_time, slowest_rsp_time, curr_ssl_conn, total_ssl_conn, resp-count, resp-1xx, resp-2xx, resp-3xx, resp-4xx, resp-5xx, resp-other, resp-latency, curr_pconn .. _3076_server-list_port-list_alternate-port: server-list_port-list_alternate-port ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **alternate** **Description** Alternate Server Number **Type:** number **Range:** 1-16 **alternate-name** **Description** Alternate Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **alternate-server-port** **Description** Port (Alternate Server Port Value) **Type:** number **Range:** 1-65535 .. _3076_server-list_port-list_auth-cfg: server-list_port-list_auth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **service-principal-name** **Description** Service Principal Name (Kerberos principal name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _3076_server-list_alternate-server: server-list_alternate-server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **alternate** **Description** Alternate Server (Alternate Server Number) **Type:** number **Range:** 1-16 **alternate-name** **Description** Alternate Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _3076_server-list_sampling-enable: server-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total-conn': Total established connections; 'fwd-pkt': Forward Packets Processed; 'rev-pkt': Reverse Packets Processed; 'peak-conn': Peak number of established connections; 'total_req': Total Requests processed; 'total_req_succ': Total Requests succeeded; 'curr_ssl_conn': Current SSL connections established; 'total_ssl_conn': Total SSL connections established; 'total_fwd_bytes': Bytes processed in forward direction; 'total_rev_bytes': Bytes processed in reverse direction; 'total_fwd_pkts': Packets processed in forward direction; 'total_rev_pkts': Packets processed in reverse direction; 'ip_only_lb_fwd_bytes': IP-Only-LB Bytes processed in forward direction; 'ip_only_lb_rev_bytes': IP-Only-LB Bytes processed in reverse direction; 'ip_only_lb_fwd_pkts': IP-Only-LB Packets processed in forward direction; 'ip_only_lb_rev_pkts': IP-Only-LB Packets processed in reverse direction; **Type:** string **Supported Values:** all, total-conn, fwd-pkt, rev-pkt, peak-conn, total_req, total_req_succ, curr_ssl_conn, total_ssl_conn, total_fwd_bytes, total_rev_bytes, total_fwd_pkts, total_rev_pkts, ip_only_lb_fwd_bytes, ip_only_lb_rev_bytes, ip_only_lb_fwd_pkts, ip_only_lb_rev_pkts .. _3076_switch: switch ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_switch_sampling-enable: switch_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'fwlb': FWLB; 'licexpire_drop': License Expire Drop; 'bwl_drop': BW Limit Drop; 'rx_kernel': Received kernel; 'rx_arp_req': ARP REQ Rcvd; 'rx_arp_resp': ARP RESP Rcvd; 'vlan_flood': VLAN Flood; 'l2_def_vlan_drop': L2 Default Vlan FWD Drop; 'ipv4_noroute_drop': IPv4 No Route Drop; 'ipv6_noroute_drop': IPv6 No Route Drop; 'prot_down_drop': Prot Down Drop; 'l2_forward': L2 Forward; 'l3_forward_ip': L3 IP Forward; 'l3_forward_ipv6': L3 IPv6 Forward; 'l4_process': L4 Process; 'unknown_prot_drop': Unknown Prot Drop; 'ttl_exceeded_drop': TTL Exceeded Drop; 'linkdown_drop': Link Down Drop; 'sport_drop': SPORT Drop; 'incorrect_len_drop': Incorrect Length Drop; 'ip_defrag': IP Defrag; 'acl_deny': ACL Denys; 'ipfrag_tcp': IP(TCP) Fragment Rcvd; 'ipfrag_overlap': IP Fragment Overlap; 'ipfrag_timeout': IP Fragment Timeout; 'ipfrag_overload': IP Frag Overload Drops; 'ipfrag_reasmoks': IP Fragment Reasm OKs; 'ipfrag_reasmfails': IP Fragment Reasm Fails; 'land_drop': Anomaly Land Attack Drop; 'ipoptions_drop': Anomaly IP OPT Drops; 'badpkt_drop': Bad Pkt Drop; 'pingofdeath_drop': Anomaly PingDeath Drop; 'allfrag_drop': Anomaly All Frag Drop; 'tcpnoflag_drop': Anomaly TCP noFlag Drop; 'tcpsynfrag_drop': Anomaly SYN Frag Drop; 'tcpsynfin_drop': Anomaly TCP SYNFIN Drop; 'ipsec_drop': IPSec Drop; 'bpdu_rcvd': BPDUs Received; 'bpdu_sent': BPDUs Sent; 'ctrl_syn_rate_drop': SYN rate exceeded Drop; 'ip_defrag_invalid_len': IP Invalid Length Frag; 'ipv4_frag_6rd_ok': IPv4 Frag 6RD OK; 'ipv4_frag_6rd_drop': IPv4 Frag 6RD Dropped; 'no_ip_drop': No IP Drop; 'ipv6frag_udp': IPv6 Frag UDP; 'ipv6frag_udp_dropped': IPv6 Frag UDP Dropped; 'ipv6frag_tcp_dropped': IPv6 Frag TCP Dropped; 'ipv6frag_ipip_ok': IPv6 Frag IPIP OKs; 'ipv6frag_ipip_dropped': IPv6 Frag IPIP Drop; 'ip_frag_oversize': IP Fragment oversize; 'ip_frag_too_many': IP Fragment too many; 'ipv4_novlanfwd_drop': IPv4 No L3 VLAN FWD Drop; 'ipv6_novlanfwd_drop': IPv6 No L3 VLAN FWD Drop; 'fpga_error_pkt1': FPGA Error PKT1; 'fpga_error_pkt2': FPGA Error PKT2; 'max_arp_drop': Max ARP Drop; 'ipv6frag_tcp': IPv6 Frag TCP; 'ipv6frag_icmp': IPv6 Frag ICMP; 'ipv6frag_ospf': IPv6 Frag OSPF; 'ipv6frag_esp': IPv6 Frag ESP; 'l4_in_ctrl_cpu': L4 In Ctrl CPU; 'mgmt_svc_drop': Management Service Drop; 'jumbo_frag_drop': Jumbo Frag Drop; 'ipv6_jumbo_frag_drop': IPv6 Jumbo Frag Drop; 'ipipv6_jumbo_frag_drop': IPIPv6 Jumbo Frag Drop; 'ipv6_ndisc_dad_solicits': IPv6 DAD on Solicits; 'ipv6_ndisc_dad_adverts': IPv6 DAD on Adverts; 'ipv6_ndisc_mac_changes': IPv6 DAD MAC Changed; 'ipv6_ndisc_out_of_memory': IPv6 DAD Out-of-memory; 'sp_non_ctrl_pkt_drop': Shared IP mode non ctrl packet to linux drop; 'urpf_pkt_drop': URPF check packet drop; 'fw_smp_zone_mismatch': FW SMP Zone Mismatch; 'ipfrag_udp': IP(UDP) Fragment Rcvd; 'ipfrag_icmp': IP(ICMP) Fragment Rcvd; 'ipfrag_ospf': IP(OSPF) Fragment Rcvd; 'ipfrag_esp': IP(ESP) Fragment Rcvd; 'ipfrag_tcp_dropped': IP Frag TCP Dropped; 'ipfrag_udp_dropped': IP Frag UDP Dropped; 'ipfrag_ipip_dropped': IP Frag IPIP Drop; 'redirect_fwd_fail': Redirect failed in the fwd direction; 'redirect_fwd_sent': Redirect succeeded in the fwd direction; 'redirect_rev_fail': Redirect failed in the rev direction; 'redirect_rev_sent': Redirect succeeded in the rev direction; 'redirect_setup_fail': Redirect connection setup failed; 'ip_frag_sent': IP frag sent; 'invalid_rx_arp_pkt': Invalid ARP PKT Rcvd; 'invalid_sender_mac_arp_drop': ARP PKT dropped due to invalid sender MAC; 'dev_based_arp_drop': ARP PKT dropped due to interface state checks; 'scaleout_arp_drop': ARP PKT dropped due to scaleout checks; 'virtual_ip_not_found_arp_drop': ARP PKT dropped due to virtual IP not found; 'inactive_static_nat_pool_arp_drop': ARP PKT dropped due to inactive static nat pool; 'inactive_nat_pool_arp_drop': ARP PKT dropped due to inactive nat pool; 'scaleout_hairpin_arp_drop': ARP PKT dropped due to scaleout hairpin checks; 'self_grat_arp_drop': Self generated grat ARP PKT dropped; 'self_grat_nat_ip_arp_drop': Self generated grat ARP PKT dropped for NAT IP; 'ip_not_found_arp_drop': ARP PKT dropped due to IP not found; 'dev_link_down_arp_drop': ARP PKT dropped due to interface is down; 'lacp_tx_intf_err_drop': LACP interface error corrected; 'service_chain_sent': Service Chain Packets Sent; 'service_chain_rcvd': Service Chain Packets Rcvd; 'unnumbered_nat_error': Unnumbered NAT error; 'unnumbered_unsupported_drop': Unsupported protocol for unnumbered; 'ipv6frag_gre_dropped': IPv6 Frag gre Drop; 'ipv6_ndisc_dad_prefix_mismatch_drop': IPv6 DAD on Advertise drop for prefix mismatch; 'bw_ignore_limit': BW Limit ignored packets count; 'ppsl_drop_egr': Packet-Per-Sec Limit Drop at egress; 'ppsl_drop_ing': Packet-Per-Sec Limit Drop at ingress; 'ppsl_ignore_limit': Packet-Per-Sec Limit ignored packets count; 'closed_port_syn_drop': Linux Closed Port SYN Drop; **Type:** string **Supported Values:** all, fwlb, licexpire_drop, bwl_drop, rx_kernel, rx_arp_req, rx_arp_resp, vlan_flood, l2_def_vlan_drop, ipv4_noroute_drop, ipv6_noroute_drop, prot_down_drop, l2_forward, l3_forward_ip, l3_forward_ipv6, l4_process, unknown_prot_drop, ttl_exceeded_drop, linkdown_drop, sport_drop, incorrect_len_drop, ip_defrag, acl_deny, ipfrag_tcp, ipfrag_overlap, ipfrag_timeout, ipfrag_overload, ipfrag_reasmoks, ipfrag_reasmfails, land_drop, ipoptions_drop, badpkt_drop, pingofdeath_drop, allfrag_drop, tcpnoflag_drop, tcpsynfrag_drop, tcpsynfin_drop, ipsec_drop, bpdu_rcvd, bpdu_sent, ctrl_syn_rate_drop, ip_defrag_invalid_len, ipv4_frag_6rd_ok, ipv4_frag_6rd_drop, no_ip_drop, ipv6frag_udp, ipv6frag_udp_dropped, ipv6frag_tcp_dropped, ipv6frag_ipip_ok, ipv6frag_ipip_dropped, ip_frag_oversize, ip_frag_too_many, ipv4_novlanfwd_drop, ipv6_novlanfwd_drop, fpga_error_pkt1, fpga_error_pkt2, max_arp_drop, ipv6frag_tcp, ipv6frag_icmp, ipv6frag_ospf, ipv6frag_esp, l4_in_ctrl_cpu, mgmt_svc_drop, jumbo_frag_drop, ipv6_jumbo_frag_drop, ipipv6_jumbo_frag_drop, ipv6_ndisc_dad_solicits, ipv6_ndisc_dad_adverts, ipv6_ndisc_mac_changes, ipv6_ndisc_out_of_memory, sp_non_ctrl_pkt_drop, urpf_pkt_drop, fw_smp_zone_mismatch, ipfrag_udp, ipfrag_icmp, ipfrag_ospf, ipfrag_esp, ipfrag_tcp_dropped, ipfrag_udp_dropped, ipfrag_ipip_dropped, redirect_fwd_fail, redirect_fwd_sent, redirect_rev_fail, redirect_rev_sent, redirect_setup_fail, ip_frag_sent, invalid_rx_arp_pkt, invalid_sender_mac_arp_drop, dev_based_arp_drop, scaleout_arp_drop, virtual_ip_not_found_arp_drop, inactive_static_nat_pool_arp_drop, inactive_nat_pool_arp_drop, scaleout_hairpin_arp_drop, self_grat_arp_drop, self_grat_nat_ip_arp_drop, ip_not_found_arp_drop, dev_link_down_arp_drop, lacp_tx_intf_err_drop, service_chain_sent, service_chain_rcvd, unnumbered_nat_error, unnumbered_unsupported_drop, ipv6frag_gre_dropped, ipv6_ndisc_dad_prefix_mismatch_drop, bw_ignore_limit, ppsl_drop_egr, ppsl_drop_ing, ppsl_ignore_limit, closed_port_syn_drop, tls13_drop_req, tls13_ignore_req, tls12_drop_req, tls12_ignore_req, tls12_tls13_drop_req, tls12_tls13_ignore_req .. _3076_ftp-ctl: ftp-ctl ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _3076_ftp-ctl_sampling-enable: ftp-ctl_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'sessions_num': Total Control Sessions; 'alg_pkts_num': Total ALG packets; 'alg_pkts_xmitted_num': ALG packets rexmitted; 'alg_port_helper_created': Total PORT helper sessions; 'alg_pasv_helper_created': Total PASV helper sessions; 'alg_port_helper_freed_unused': PORT helper freed unused; 'alg_pasv_helper_freed_unused': PASV helper freed unused; 'alg_port_helper_nat_free': PORT helper NAT free; **Type:** string **Supported Values:** all, sessions_num, alg_pkts_num, alg_pkts_xmitted_num, alg_port_helper_created, alg_pasv_helper_created, alg_port_helper_freed_unused, alg_pasv_helper_freed_unused, alg_port_helper_nat_free