.. _system: system ====== Configure System Parameters system Specification -------------------- ===================================== =============================================== ===================================== =============================================== **Type** *Configuration Resource* **Element Name** system **Element URI** /axapi/v3/system **Element Attributes** system_attributes **Schema** :download:`system schema ` ===================================== =============================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/system .. raw:: html :ref:`1699_system_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/system .. raw:: html :ref:`1699_system_attributes` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/system .. raw:: html :ref:`1699_system_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/system .. raw:: html :ref:`1699_system_attributes` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/system .. raw:: html :ref:`1699_system_attributes` .. raw:: html
.. _1699_system_attributes: system attributes ----------------- **add-cpu-core** **Description:** add-cpu-core is a **JSON Block**. Please see below for :ref:`1699_add-cpu-core` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/add-cpu-core ` **add-port** **Description:** add-port is a **JSON Block**. Please see below for :ref:`1699_add-port` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/add-port ` **all-vlan-limit** **Description:** all-vlan-limit is a **JSON Block**. Please see below for :ref:`1699_all-vlan-limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/all-vlan-limit ` **anomaly-log** **Description** log system anomalies **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **app-performance** **Description:** app-performance is a **JSON Block**. Please see below for :ref:`1699_app-performance` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/app-performance ` **apps-global** **Description:** apps-global is a **JSON Block**. Please see below for :ref:`1699_apps-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/apps-global ` **asic-debug-dump** **Description:** asic-debug-dump is a **JSON Block**. Please see below for :ref:`1699_asic-debug-dump` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/asic-debug-dump ` **attack** **Description** System Attack **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **attack-log** **Description** log attack anomalies **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bandwidth** **Description:** bandwidth is a **JSON Block**. Please see below for :ref:`1699_bandwidth` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/bandwidth ` **bfd** **Description:** bfd is a **JSON Block**. Please see below for :ref:`1699_bfd` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/bfd ` **class-list-hitcount-enable** **Description** Enable class list hit count **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **cm-update-file-name-ref** **Description:** cm-update-file-name-ref is a **JSON Block**. Please see below for :ref:`1699_cm-update-file-name-ref` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cm-update-file-name-ref ` **control-cpu** **Description:** control-cpu is a **JSON Block**. Please see below for :ref:`1699_control-cpu` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/control-cpu ` **core** **Description:** core is a **JSON Block**. Please see below for :ref:`1699_core` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/core ` **cosq-show** **Description:** cosq-show is a **JSON Block**. Please see below for :ref:`1699_cosq-show` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cosq-show ` **cosq-stats** **Description:** cosq-stats is a **JSON Block**. Please see below for :ref:`1699_cosq-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cosq-stats ` **counter-lib-accounting** **Description:** counter-lib-accounting is a **JSON Block**. Please see below for :ref:`1699_counter-lib-accounting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/counter-lib-accounting ` **cpu-hyper-thread** **Description:** cpu-hyper-thread is a **JSON Block**. Please see below for :ref:`1699_cpu-hyper-thread` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cpu-hyper-thread ` **cpu-list** **Description:** cpu-list is a **JSON Block**. Please see below for :ref:`1699_cpu-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cpu-list ` **cpu-load-sharing** **Description:** cpu-load-sharing is a **JSON Block**. Please see below for :ref:`1699_cpu-load-sharing` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cpu-load-sharing ` **cpu-map** **Description:** cpu-map is a **JSON Block**. Please see below for :ref:`1699_cpu-map` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cpu-map ` **data-cpu** **Description:** data-cpu is a **JSON Block**. Please see below for :ref:`1699_data-cpu` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/data-cpu ` **ddos-attack** **Description** System DDoS Attack **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ddos-log** **Description** log DDoS attack anomalies **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **deep-hrxq** **Description:** deep-hrxq is a **JSON Block**. Please see below for :ref:`1699_deep-hrxq` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/deep-hrxq ` **del-port** **Description:** del-port is a **JSON Block**. Please see below for :ref:`1699_del-port` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/del-port ` **delete-cpu-core** **Description:** delete-cpu-core is a **JSON Block**. Please see below for :ref:`1699_delete-cpu-core` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/delete-cpu-core ` **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`1699_dns` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/dns ` **dns-cache** **Description:** dns-cache is a **JSON Block**. Please see below for :ref:`1699_dns-cache` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/dns-cache ` **domain-list-hitcount-enable** **Description** Enable class list hit count **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **domain-list-info** **Description:** domain-list-info is a **JSON Block**. Please see below for :ref:`1699_domain-list-info` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/domain-list-info ` **drop-linux-closed-port-syn** **Description** 'enable': enable (default); 'disable': disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **dynamic-service-dns-socket-pool** **Description** Enable socket pool for dynamic-service DNS **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **environment** **Description:** environment is a **JSON Block**. Please see below for :ref:`1699_environment` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/environment ` **fpga-core-crc** **Description:** fpga-core-crc is a **JSON Block**. Please see below for :ref:`1699_fpga-core-crc` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/fpga-core-crc ` **fw** **Description:** fw is a **JSON Block**. Please see below for :ref:`1699_fw` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/fw ` **geo-db-hitcount-enable** **Description** Enable Geolocation database hit count **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geo-location** **Description:** geo-location is a **JSON Block**. Please see below for :ref:`1699_geo-location` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/geo-location ` **geoloc** **Description:** geoloc is a **JSON Block**. Please see below for :ref:`1699_geoloc` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/geoloc ` **geoloc-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/system/geoloc-list/{name} ` **geoloc-name-helper** **Description:** geoloc-name-helper is a **JSON Block**. Please see below for :ref:`1699_geoloc-name-helper` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/geoloc-name-helper ` **geolocation-file** **Description:** geolocation-file is a **JSON Block**. Please see below for :ref:`1699_geolocation-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/geolocation-file ` **glid** **Description** Apply limits to the whole system **Type:** number **Range:** 1-1023 **Reference Object:** :doc:`/axapi/v3/glid ` **guest-file** **Description:** guest-file is a **JSON Block**. Please see below for :ref:`1699_guest-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/guest-file ` **gui-image-list** **Description:** gui-image-list is a **JSON Block**. Please see below for :ref:`1699_gui-image-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/gui-image-list ` **hardware** **Description:** hardware is a **JSON Block**. Please see below for :ref:`1699_hardware` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/hardware ` **hardware-forward** **Description:** hardware-forward is a **JSON Block**. Please see below for :ref:`1699_hardware-forward` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/hardware-forward ` **hrxq-status** **Description:** hrxq-status is a **JSON Block**. Please see below for :ref:`1699_hrxq-status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/hrxq-status ` **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`1699_icmp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/icmp ` **icmp-rate** **Description:** icmp-rate is a **JSON Block**. Please see below for :ref:`1699_icmp-rate` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/icmp-rate ` **icmp6** **Description:** icmp6 is a **JSON Block**. Please see below for :ref:`1699_icmp6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/icmp6 ` **inuse-cpu-list** **Description:** inuse-cpu-list is a **JSON Block**. Please see below for :ref:`1699_inuse-cpu-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/inuse-cpu-list ` **inuse-port-list** **Description:** inuse-port-list is a **JSON Block**. Please see below for :ref:`1699_inuse-port-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/inuse-port-list ` **io-cpu** **Description:** io-cpu is a **JSON Block**. Please see below for :ref:`1699_io-cpu` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/io-cpu ` **ip-dns-cache** **Description:** ip-dns-cache is a **JSON Block**. Please see below for :ref:`1699_ip-dns-cache` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ip-dns-cache ` **ip-stats** **Description:** ip-stats is a **JSON Block**. Please see below for :ref:`1699_ip-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ip-stats ` **ip6-stats** **Description:** ip6-stats is a **JSON Block**. Please see below for :ref:`1699_ip6-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ip6-stats ` **ipmi** **Description:** ipmi is a **JSON Block**. Please see below for :ref:`1699_ipmi` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipmi ` **ipmi-service** **Description:** ipmi-service is a **JSON Block**. Please see below for :ref:`1699_ipmi-service` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipmi-service ` **ipsec** **Description:** ipsec is a **JSON Block**. Please see below for :ref:`1699_ipsec` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipsec ` **link-capability** **Description:** link-capability is a **JSON Block**. Please see below for :ref:`1699_link-capability` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/link-capability ` **link-monitor** **Description:** link-monitor is a **JSON Block**. Please see below for :ref:`1699_link-monitor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/link-monitor ` **log-cpu-interval** **Description** Log high CPU interval (Specify consecutive seconds before logging high CPU) **Type:** number **Range:** 15-255 **management-interface-mode** **Description:** management-interface-mode is a **JSON Block**. Please see below for :ref:`1699_management-interface-mode` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/management-interface-mode ` **memory** **Description:** memory is a **JSON Block**. Please see below for :ref:`1699_memory` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/memory ` **mgmt-port** **Description:** mgmt-port is a **JSON Block**. Please see below for :ref:`1699_mgmt-port` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/mgmt-port ` **modify-port** **Description:** modify-port is a **JSON Block**. Please see below for :ref:`1699_modify-port` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/modify-port ` **module-ctrl-cpu** **Description** 'high': high cpu usage; 'low': low cpu usage; 'medium': medium cpu usage; **Type:** string **Supported Values:** high, low, medium **mon-template** **Description:** mon-template is a **JSON Block**. Please see below for :ref:`1699_mon-template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/mon-template ` **multi-queue-support** **Description:** multi-queue-support is a **JSON Block**. Please see below for :ref:`1699_multi-queue-support` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/multi-queue-support ` **ndisc-ra** **Description:** ndisc-ra is a **JSON Block**. Please see below for :ref:`1699_ndisc-ra` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ndisc-ra ` **password-policy** **Description:** password-policy is a **JSON Block**. Please see below for :ref:`1699_password-policy` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/password-policy ` **per-vlan-limit** **Description:** per-vlan-limit is a **JSON Block**. Please see below for :ref:`1699_per-vlan-limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/per-vlan-limit ` **platformtype** **Description:** platformtype is a **JSON Block**. Please see below for :ref:`1699_platformtype` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/platformtype ` **port-info** **Description:** port-info is a **JSON Block**. Please see below for :ref:`1699_port-info` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/port-info ` **port-list** **Description:** port-list is a **JSON Block**. Please see below for :ref:`1699_port-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/port-list ` **ports** **Description:** ports is a **JSON Block**. Please see below for :ref:`1699_ports` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ports ` **promiscuous-mode** **Description** Run in promiscous mode settings **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **queuing-buffer** **Description:** queuing-buffer is a **JSON Block**. Please see below for :ref:`1699_queuing-buffer` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/queuing-buffer ` **radius** **Description:** radius is a **JSON Block**. Please see below for :ref:`1699_radius` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/radius ` **reboot** **Description:** reboot is a **JSON Block**. Please see below for :ref:`1699_reboot` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/reboot ` **resource-accounting** **Description:** resource-accounting is a **JSON Block**. Please see below for :ref:`1699_resource-accounting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/resource-accounting ` **resource-usage** **Description:** resource-usage is a **JSON Block**. Please see below for :ref:`1699_resource-usage` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/resource-usage ` **session** **Description:** session is a **JSON Block**. Please see below for :ref:`1699_session` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/session ` **session-reclaim-limit** **Description:** session-reclaim-limit is a **JSON Block**. Please see below for :ref:`1699_session-reclaim-limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/session-reclaim-limit ` **set-tcp-syn-per-sec** **Description:** set-tcp-syn-per-sec is a **JSON Block**. Please see below for :ref:`1699_set-tcp-syn-per-sec` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/set-tcp-syn-per-sec ` **shared-poll-mode** **Description:** shared-poll-mode is a **JSON Block**. Please see below for :ref:`1699_shared-poll-mode` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/shared-poll-mode ` **shell-privileges** **Description:** shell-privileges is a **JSON Block**. Please see below for :ref:`1699_shell-privileges` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/shell-privileges ` **shutdown** **Description:** shutdown is a **JSON Block**. Please see below for :ref:`1699_shutdown` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/shutdown ` **sockstress-disable** **Description** Disable sockstress protection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **spe-profile** **Description:** spe-profile is a **JSON Block**. Please see below for :ref:`1699_spe-profile` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/spe-profile ` **spe-status** **Description:** spe-status is a **JSON Block**. Please see below for :ref:`1699_spe-status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/spe-status ` **src-ip-hash-enable** **Description** Enable source ip hash **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ssl-req-q** **Description:** ssl-req-q is a **JSON Block**. Please see below for :ref:`1699_ssl-req-q` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ssl-req-q ` **syslog-time-msec** **Description:** syslog-time-msec is a **JSON Block**. Please see below for :ref:`1699_syslog-time-msec` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/syslog-time-msec ` **table-integrity-check** **Description:** table-integrity-check is a **JSON Block**. Please see below for :ref:`1699_table-integrity-check` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/table-integrity-check ` **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`1699_tcp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/tcp ` **tcp-stats** **Description:** tcp-stats is a **JSON Block**. Please see below for :ref:`1699_tcp-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/tcp-stats ` **tcp-syn-per-sec** **Description:** tcp-syn-per-sec is a **JSON Block**. Please see below for :ref:`1699_tcp-syn-per-sec` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/tcp-syn-per-sec ` **telemetry-log** **Description:** telemetry-log is a **JSON Block**. Please see below for :ref:`1699_telemetry-log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/telemetry-log ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1699_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/template ` **template-bind** **Description:** template-bind is a **JSON Block**. Please see below for :ref:`1699_template-bind` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/template-bind ` **throughput** **Description:** throughput is a **JSON Block**. Please see below for :ref:`1699_throughput` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/throughput ` **timeout-value** **Description:** timeout-value is a **JSON Block**. Please see below for :ref:`1699_timeout-value` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/timeout-value ` **trunk** **Description:** trunk is a **JSON Block**. Please see below for :ref:`1699_trunk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/trunk ` **trunk-hw-hash** **Description:** trunk-hw-hash is a **JSON Block**. Please see below for :ref:`1699_trunk-hw-hash` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/trunk-hw-hash ` **trunk-xaui-hw-hash** **Description:** trunk-xaui-hw-hash is a **JSON Block**. Please see below for :ref:`1699_trunk-xaui-hw-hash` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/trunk-xaui-hw-hash ` **upgrade-status** **Description:** upgrade-status is a **JSON Block**. Please see below for :ref:`1699_upgrade-status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/upgrade-status ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve-mac-scheme** **Description:** ve-mac-scheme is a **JSON Block**. Please see below for :ref:`1699_ve-mac-scheme` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ve-mac-scheme ` .. _1699_geo-location: geo-location ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **entry-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/system/geo-location/entry/{geo-locn-obj-name} ` **geo-location-geolite2-city** **Description** Load built-in Maxmind GeoLite2-City database. Database available from http://www.maxmind.com **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geo-location-geolite2-country** **Description** Load built-in Maxmind GeoLite2-Country database. Database available from http://www.maxmind.com **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geo-location-iana** **Description** Load built-in IANA Database **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **geolite2-city-include-ipv6** **Description** Include IPv6 address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geolite2-country-include-ipv6** **Description** Include IPv6 address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geoloc-load-file-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_geo-location_entry-list: geo-location_entry-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **geo-locn-multiple-addresses** **Type:** List **geo-locn-obj-name** **Description** Specify geo-location name, section range is (1-15) **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_geo-location_entry-list_geo-locn-multiple-addresses: geo-location_entry-list_geo-locn-multiple-addresses ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **first-ip-address** **Description** Specify IP information (Specify IP address) **Type:** string **Format:** ipv4-address **first-ipv6-address** **Description** Specify IPv6 address **Type:** string **Format:** ipv6-address **geol-ipv4-mask** **Description** Specify IPv4 mask **Type:** string **Format:** ipv4-netmask **Mutual Exclusion:** geol-ipv4-mask and ip-addr2 are mutually exclusive **geol-ipv6-mask** **Description** Specify IPv6 mask **Type:** number **Range:** 0-128 **Mutual Exclusion:** geol-ipv6-mask and ipv6-addr2 are mutually exclusive **ip-addr2** **Description** Specify IP address range **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ip-addr2 and geol-ipv4-mask are mutually exclusive **ipv6-addr2** **Description** Specify IPv6 address range **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ipv6-addr2 and geol-ipv6-mask are mutually exclusive .. _1699_geo-location_geoloc-load-file-list: geo-location_geoloc-load-file-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **geo-location-load-filename** **Description** Specify file to be loaded **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **template-name** **Description** CSV template to load this file **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/template/csv ` .. _1699_mgmt-port: mgmt-port ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mac-address** **Description** mac-address to be configured as mgmt port **Type:** string **Format:** mac-address **Maximum Length:** 14 characters **Maximum Length:** 14 characters **pci-address** **Description** pci-address to be configured as mgmt port **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-index** **Description** port index to be configured (Specify port index) **Type:** number **Range:** 0-32 .. _1699_geolocation-file: geolocation-file ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **error-info** **Description:** error-info is a **JSON Block**. Please see below for :ref:`1699_geolocation-file_error-info` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/geolocation-file/error-info ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_geolocation-file_error-info: geolocation-file_error-info ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ndisc-ra: ndisc-ra ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ndisc-ra_sampling-enable: ndisc-ra_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'good_recv': Good Router Solicitations (R.S.) Received; 'periodic_sent': Periodic Router Advertisements (R.A.) Sent; 'rate_limit': R.S. Rate Limited; 'bad_hop_limit': R.S. Bad Hop Limit; 'truncated': R.S. Truncated; 'bad_icmpv6_csum': R.S. Bad ICMPv6 Checksum; 'bad_icmpv6_code': R.S. Unknown ICMPv6 Code; 'bad_icmpv6_option': R.S. Bad ICMPv6 Option; 'l2_addr_and_unspec': R.S. Src Link-Layer Option and Unspecified Address; 'no_free_buffers': No Free Buffers to send R.A.; **Type:** string **Supported Values:** all, good_recv, periodic_sent, rate_limit, bad_hop_limit, truncated, bad_icmpv6_csum, bad_icmpv6_code, bad_icmpv6_option, l2_addr_and_unspec, no_free_buffers .. _1699_tcp: tcp ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_tcp_sampling-enable: tcp_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'activeopens': Active open conns; 'passiveopens': Passive open conns; 'attemptfails': Connect attemp failures; 'estabresets': Resets rcvd on EST conn; 'insegs': Total in TCP packets; 'outsegs': Total out TCP packets; 'retranssegs': Retransmited packets; 'inerrs': Input errors; 'outrsts': Reset Sent; 'sock_alloc': Sockets allocated; 'orphan_count': Orphan sockets; 'mem_alloc': Memory alloc; 'recv_mem': Total rx buffer; 'send_mem': Total tx buffer; 'currestab': Currently EST conns; 'currsyssnt': TCP in SYN-SNT state; 'currsynrcv': TCP in SYN-RCV state; 'currfinw1': TCP in FIN-W1 state; 'currfinw2': TCP FIN-W2 state; 'currtimew': TCP TimeW state; 'currclose': TCP in Close state; 'currclsw': TCP in CloseW state; 'currlack': TCP in LastACK state; 'currlstn': TCP in Listen state; 'currclsg': TCP in Closing state; 'pawsactiverejected': TCP paw active rej; 'syn_rcv_rstack': Rcv RST|ACK on SYN; 'syn_rcv_rst': Rcv RST on SYN; 'syn_rcv_ack': Rcv ACK on SYN; 'ax_rexmit_syn': TCP rexmit SYN; 'tcpabortontimeout': TCP abort on timeout; 'noroute': TCPIP out noroute; 'exceedmss': MSS exceeded pkt dropped; **Type:** string **Supported Values:** all, activeopens, passiveopens, attemptfails, estabresets, insegs, outsegs, retranssegs, inerrs, outrsts, sock_alloc, orphan_count, mem_alloc, recv_mem, send_mem, currestab, currsyssnt, currsynrcv, currfinw1, currfinw2, currtimew, currclose, currclsw, currlack, currlstn, currclsg, pawsactiverejected, syn_rcv_rstack, syn_rcv_rst, syn_rcv_ack, ax_rexmit_syn, tcpabortontimeout, noroute, exceedmss, tfo_conns, tfo_actives, tfo_denied .. _1699_bandwidth: bandwidth ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_bandwidth_sampling-enable: bandwidth_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'input-bytes-per-sec': In Bytes per second; 'output-bytes-per-sec': Out Bytes per second; **Type:** string **Supported Values:** all, input-bytes-per-sec, output-bytes-per-sec .. _1699_session: session ^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_session_sampling-enable: session_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_l4_conn': Total L4 Count; 'conn_counter': Conn Count; 'conn_freed_counter': Conn Freed; 'total_l4_packet_count': Total L4 Packet Count; 'total_l7_packet_count': Total L7 Packet Count; 'total_l4_conn_proxy': Total L4 Conn Proxy Count; 'total_l7_conn': Total L7 Conn; 'total_tcp_conn': Total TCP Conn; 'curr_free_conn': Curr Free Conn; 'tcp_est_counter': TCP Established; 'tcp_half_open_counter': TCP Half Open; 'tcp_half_close_counter': TCP Half Closed; 'udp_counter': UDP Count; 'ip_counter': IP Count; 'other_counter': Non TCP/UDP IP sessions; 'reverse_nat_tcp_ounter': Reverse NAT TCP; 'reverse_nat_udp_ounter': Reverse NAT UDP; 'tcp_syn_half_open_counter': TCP SYN Half Open; 'conn_smp_alloc_counter': Conn SMP Alloc; 'conn_smp_free_counter': Conn SMP Free; 'conn_smp_aged_counter': Conn SMP Aged; 'ssl_count_curr': Curr SSL Count; 'ssl_count_total': Total SSL Count; 'server_ssl_count_curr': Current SSL Server Count; 'server_ssl_count_total': Total SSL Server Count; 'client_ssl_reuse_total': Total SSL Client Reuse; 'server_ssl_reuse_total': Total SSL Server Reuse; 'ssl_failed_total': Total SSL Failures; 'ssl_failed_ca_verification': SSL Cert Auth Verification Errors; 'ssl_server_cert_error': SSL Server Cert Errors; 'ssl_client_cert_auth_fail': SSL Client Cert Auth Failures; 'total_ip_nat_donn': Total IP Nat Conn; 'total_l2l3_conn': Totl L2/L3 Connections; 'client_ssl_ctx_malloc_failure': Client SSL Ctx malloc Failures; 'conn_type_0_available': Conn Type 0 Available; 'conn_type_1_available': Conn Type 1 Available; 'conn_type_2_available': Conn Type 2 Available; 'conn_type_3_available': Conn Type 3 Available; 'conn_type_4_available': Conn Type 4 Available; 'conn_smp_type_0_available': Conn SMP Type 0 Available; 'conn_smp_type_1_available': Conn SMP Type 1 Available; 'conn_smp_type_2_available': Conn SMP Type 2 Available; 'conn_smp_type_3_available': Conn SMP Type 3 Available; 'conn_smp_type_4_available': Conn SMP Type 4 Available; 'sctp-half-open-counter': SCTP Half Open; 'sctp-est-counter': SCTP Established; 'nonssl_bypass': NON SSL Bypass Count; 'ssl_failsafe_total': Total SSL Failsafe Count; 'ssl_forward_proxy_failed_handshake_total': Total SSL Forward Proxy Failed Handshake Count; 'ssl_forward_proxy_failed_tcp_total': Total SSL Forward Proxy Failed TCP Count; 'ssl_forward_proxy_failed_crypto_total': Total SSL Forward Proxy Failed Crypto Count; 'ssl_forward_proxy_failed_cert_verify_total': Total SSL Forward Proxy Failed Certificate Verification Count; 'ssl_forward_proxy_invalid_ocsp_stapling_total': Total SSL Forward Proxy Invalid OCSP Stapling Count; 'ssl_forward_proxy_revoked_ocsp_total': Total SSL Forward Proxy Revoked OCSP Response Count; 'ssl_forward_proxy_failed_cert_signing_total': Total SSL Forward Proxy Failed Certificate Signing Count; 'ssl_forward_proxy_failed_ssl_version_total': Total SSL Forward Proxy Unsupported version Count; 'ssl_forward_proxy_sni_bypass_total': Total SSL Forward Proxy SNI Bypass Count; 'ssl_forward_proxy_client_auth_bypass_total': Total SSL Forward Proxy Client Auth Bypass Count; 'conn_app_smp_alloc_counter': Conn APP SMP Alloc; **Type:** string **Supported Values:** all, total_l4_conn, conn_counter, conn_freed_counter, total_l4_packet_count, total_l7_packet_count, total_l4_conn_proxy, total_l7_conn, total_tcp_conn, curr_free_conn, tcp_est_counter, tcp_half_open_counter, tcp_half_close_counter, udp_counter, ip_counter, other_counter, reverse_nat_tcp_counter, reverse_nat_udp_counter, tcp_syn_half_open_counter, conn_smp_alloc_counter, conn_smp_free_counter, conn_smp_aged_counter, ssl_count_curr, ssl_count_total, server_ssl_count_curr, server_ssl_count_total, client_ssl_reuse_total, server_ssl_reuse_total, ssl_failed_total, ssl_failed_ca_verification, ssl_server_cert_error, ssl_client_cert_auth_fail, total_ip_nat_conn, total_l2l3_conn, client_ssl_ctx_malloc_failure, conn_type_0_available, conn_type_1_available, conn_type_2_available, conn_type_3_available, conn_type_4_available, conn_smp_type_0_available, conn_smp_type_1_available, conn_smp_type_2_available, conn_smp_type_3_available, conn_smp_type_4_available, sctp-half-open-counter, sctp-est-counter, nonssl_bypass, ssl_failsafe_total, ssl_forward_proxy_failed_handshake_total, ssl_forward_proxy_failed_tcp_total, ssl_forward_proxy_failed_crypto_total, ssl_forward_proxy_failed_cert_verify_total, ssl_forward_proxy_invalid_ocsp_stapling_total, ssl_forward_proxy_revoked_ocsp_total, ssl_forward_proxy_failed_cert_signing_total, ssl_forward_proxy_failed_ssl_version_total, ssl_forward_proxy_sni_bypass_total, ssl_forward_proxy_client_auth_bypass_total, conn_app_smp_alloc_counter, diameter_conn_counter, diameter_conn_freed_counter, debug_tcp_counter, debug_udp_counter, total_fw_conn, total_local_conn, total_curr_conn, client_ssl_fatal_alert, client_ssl_fin_rst, fp_session_fin_rst, server_ssl_fatal_alert, server_ssl_fin_rst, client_template_int_err, client_template_unknown_err, server_template_int_err, server_template_unknown_err, total_debug_conn, ssl_forward_proxy_failed_aflex_total, ssl_forward_proxy_cert_subject_bypass_total, ssl_forward_proxy_cert_issuer_bypass_total, ssl_forward_proxy_cert_san_bypass_total, ssl_forward_proxy_no_sni_bypass_total, ssl_forward_proxy_no_sni_reset_total, ssl_forward_proxy_username_bypass_total, ssl_forward_proxy_ad_grpup_bypass_total, diameter_concurrent_user_sessions_counter .. _1699_table-integrity-check: table-integrity-check ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** Enable table integrity check **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 .. _1699_session-reclaim-limit: session-reclaim-limit ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **nscan-limit** **Description** smp session scan limit (number of smp sessions per scan) **Type:** number **Range:** 1-20480 **Default:** 4096 **scan-freq** **Description** smp session scan frequency (scan per second) **Type:** number **Range:** 5-50 **Default:** 5 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_inuse-cpu-list: inuse-cpu-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_add-port: add-port ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-index** **Description** port index to be configured (Specify port index) **Type:** number **Range:** 0-32 .. _1699_bfd: bfd ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_bfd_sampling-enable: bfd_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'ip_checksum_error': IP packet checksum errors; 'udp_checksum_error': UDP packet checksum errors; 'session_not_found': Session not found; 'multihop_mismatch': Multihop session or packet mismatch; 'version_mismatch': BFD version mismatch; 'length_too_small': Packets too small; 'data_is_short': Packet data length too short; 'invalid_detect_mult': Invalid detect multiplier; 'invalid_multipoint': Invalid multipoint setting; 'invalid_my_disc': Invalid my descriptor; 'invalid_ttl': Invalid TTL; 'auth_length_invalid': Invalid authentication length; 'auth_mismatch': Authentication mismatch; 'auth_type_mismatch': Authentication type mismatch; 'auth_key_id_mismatch': Authentication key-id mismatch; 'auth_key_mismatch': Authentication key mismatch; 'auth_seqnum_invalid': Invalid authentication sequence number; 'auth_failed': Authentication failures; 'local_state_admin_down': Local admin down session state; 'dest_unreachable': Destination unreachable; 'other_error': Other errors; **Type:** string **Supported Values:** all, ip_checksum_error, udp_checksum_error, session_not_found, multihop_mismatch, version_mismatch, length_too_small, data_is_short, invalid_detect_mult, invalid_multipoint, invalid_my_disc, invalid_ttl, auth_length_invalid, auth_mismatch, auth_type_mismatch, auth_key_id_mismatch, auth_key_mismatch, auth_seqnum_invalid, auth_failed, local_state_admin_down, dest_unreachable, no_ipv6_enable, other_error .. _1699_trunk-xaui-hw-hash: trunk-xaui-hw-hash ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mode** **Description** Set HW hash mode, default is 6 (1:dst-mac 2:src-mac 3:src-dst-mac 4:src-ip 5:dst-ip 6:rtag6 7:rtag7) **Type:** number **Range:** 1-7 **Default:** 6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_environment: environment ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_port-info: port-info ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_trunk-hw-hash: trunk-hw-hash ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mode** **Description** Set HW hash mode, default is 6 (1:dst-mac 2:src-mac 3:src-dst-mac 4:src-ip 5:dst-ip 6:rtag6 7:rtag7) **Type:** number **Range:** 1-7 **Default:** 6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_template: template ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **template-policy** **Description** Apply policy template to the whole system (Policy template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/policy ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_template-bind: template-bind ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **monitor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/system/template-bind/monitor/{template-monitor} ` .. _1699_template-bind_monitor-list: template-bind_monitor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **template-monitor** **Description** Monitor template ID Number **Type:** number **Range:** 1-16 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ipmi: ipmi ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip** **Description:** ip is a **JSON Block**. Please see below for :ref:`1699_ipmi_ip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipmi/ip ` **ipsrc** **Description:** ipsrc is a **JSON Block**. Please see below for :ref:`1699_ipmi_ipsrc` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipmi/ipsrc ` **reset** **Description** Reset IPMI Controller **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tool** **Description:** tool is a **JSON Block**. Please see below for :ref:`1699_ipmi_tool` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipmi/tool ` **user** **Description:** user is a **JSON Block**. Please see below for :ref:`1699_ipmi_user` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipmi/user ` .. _1699_ipmi_ip: ipmi_ip ^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **default-gateway** **Description** Default gateway address **Type:** string **Format:** ipv4-address **ipv4-address** **Description** IP address **Type:** string **Format:** ipv4-address **ipv4-netmask** **Description** IP subnet mask **Type:** string **Format:** ipv4-netmask .. _1699_ipmi_ipsrc: ipmi_ipsrc ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **dhcp** **Description** IP addr obtained by BMC running DHCP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **static** **Description** Manually configured static IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_ipmi_tool: ipmi_tool ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **cmd** **Description** Command to execute in double quotes **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1699_ipmi_user: ipmi_user ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **add** **Description** Add a new IPMI user (IPMI User Name) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **administrator** **Description** Full control **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **callback** **Description** Lowest privilege level **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** Disable an existing IPMI user (IPMI User Name) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **newname** **Description** New IPMI User Name **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **newpass** **Description** New Password **Type:** string **Format:** password **Maximum Length:** 17 characters **Maximum Length:** 1 characters **operator** **Description** Most BMC commands are allowed **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **password** **Description** Password **Type:** string **Format:** password **Maximum Length:** 17 characters **Maximum Length:** 1 characters **privilege** **Description** Change an existing IPMI user privilege (IPMI User Name) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **setname** **Description** Change User Name (Current IPMI User Name) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **setpass** **Description** Change Password (IPMI User Name) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **user** **Description** Only 'benign' commands are allowed **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_icmp-rate: icmp-rate ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_icmp-rate_sampling-enable: icmp-rate_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'over_limit_drop': Over limit drops; 'limit_intf_drop': Interfaces rate limit drops; 'limit_vserver_drop': Virtual Server rate limit drops; 'limit_total_drop': Total rate limit drops; 'lockup_time_left': Lockup time left; 'curr_rate': Current rate; 'v6_over_limit_drop': Over limit drops (v6); 'v6_limit_intf_drop': Interfaces rate limit drops (v6); 'v6_limit_vserver_drop': Virtual Server rate limit drops (v6); 'v6_limit_total_drop': Total rate limit drops (v6); 'v6_lockup_time_left': Lockup time left (v6); 'v6_curr_rate': Current rate (v6); **Type:** string **Supported Values:** all, over_limit_drop, limit_intf_drop, limit_vserver_drop, limit_total_drop, lockup_time_left, curr_rate, v6_over_limit_drop, v6_limit_intf_drop, v6_limit_vserver_drop, v6_limit_total_drop, v6_lockup_time_left, v6_curr_rate .. _1699_ssl-req-q: ssl-req-q ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ssl-req-q_sampling-enable: ssl-req-q_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num-ssl-queues': num-ssl-queues; 'ssl-req-q-depth-tot': ssl-req-q-depth-tot; 'ssl-req-q-inuse-tot': ssl-req-q-inuse-tot; 'ssl-hw-q-depth-tot': ssl-hw-q-depth-tot; 'ssl-hw-q-inuse-tot': ssl-hw-q-inuse-tot; **Type:** string **Supported Values:** all, num-ssl-queues, ssl-req-q-depth-tot, ssl-req-q-inuse-tot, ssl-hw-q-depth-tot, ssl-hw-q-inuse-tot .. _1699_telemetry-log: telemetry-log ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **device-status** **Description:** device-status is a **JSON Block**. Please see below for :ref:`1699_telemetry-log_device-status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/telemetry-log/device-status ` **partition-metrics** **Description:** partition-metrics is a **JSON Block**. Please see below for :ref:`1699_telemetry-log_partition-metrics` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/telemetry-log/partition-metrics ` **top-k-app-svc-list** **Description:** top-k-app-svc-list is a **JSON Block**. Please see below for :ref:`1699_telemetry-log_top-k-app-svc-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/telemetry-log/top-k-app-svc-list ` **top-k-source-list** **Description:** top-k-source-list is a **JSON Block**. Please see below for :ref:`1699_telemetry-log_top-k-source-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/telemetry-log/top-k-source-list ` .. _1699_telemetry-log_device-status: telemetry-log_device-status ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_telemetry-log_partition-metrics: telemetry-log_partition-metrics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_telemetry-log_top-k-app-svc-list: telemetry-log_top-k-app-svc-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_telemetry-log_top-k-source-list: telemetry-log_top-k-source-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ipsec: ipsec ^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **crypto-core** **Description** Crypto cores assigned for IPsec processing **Type:** number **Range:** 0-64 **Default:** 0 **crypto-mem** **Description** Crypto memory percentage assigned for IPsec processing (rounded to increments of 10) **Type:** number **Range:** 0-100 **Default:** 0 **fpga-decrypt** **Description:** fpga-decrypt is a **JSON Block**. Please see below for :ref:`1699_ipsec_fpga-decrypt` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipsec/fpga-decrypt ` **packet-round-robin** **Description** Enable packet round robin for IPsec packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ipsec_fpga-decrypt: ipsec_fpga-decrypt ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'enable': Enable FPGA decryption offload; 'disable': Disable FPGA decryption offload; **Type:** string **Supported Values:** enable, disable **Default:** disable .. _1699_hrxq-status: hrxq-status ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_cosq-stats: cosq-stats ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_password-policy: password-policy ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **aging** **Description** 'Strict': Strict: Max Age-60 Days; 'Medium': Medium: Max Age- 90 Days; 'Simple': Simple: Max Age-120 Days; **Type:** string **Supported Values:** Strict, Medium, Simple **complexity** **Description** 'Strict': Strict: Min length:8, Min Lower Case:2, Min Upper Case:2, Min Numbers:2, Min Special Character:1; 'Medium': Medium: Min length:6, Min Lower Case:2, Min Upper Case:2, Min Numbers:1, Min Special Character:1; 'Simple': Simple: Min length:4, Min Lower Case:1, Min Upper Case:1, Min Numbers:1, Min Special Character:0; **Type:** string **Supported Values:** Strict, Medium, Simple **history** **Description** 'Strict': Strict: Does not allow upto 5 old passwords; 'Medium': Medium: Does not allow upto 4 old passwords; 'Simple': Simple: Does not allow upto 3 old passwords; **Type:** string **Supported Values:** Strict, Medium, Simple **min-pswd-len** **Description** Configure custom password length **Type:** number **Range:** 8-64 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_queuing-buffer: queuing-buffer ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Enable/Disable micro-burst traffic support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_cpu-map: cpu-map ^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ports: ports ^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **link-detection-interval** **Description** Link detection interval in msecs **Type:** number **Range:** 50-60000 **Default:** 1000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_core: core ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_app-performance: app-performance ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_app-performance_sampling-enable: app-performance_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total-throughput-bits-per-sec': Total Throughput in bits/sec; 'l4-conns-per-sec': L4 Connections/sec; 'l7-conns-per-sec': L7 Connections/sec; 'l7-trans-per-sec': L7 Transactions/sec; 'ssl-conns-per-sec': SSL Connections/sec; 'ip-nat-conns-per-sec': IP NAT Connections/sec; 'total-new-conns-per-sec': Total New Connections Established/sec; 'total-curr-conns': Total Current Established Connections; 'l4-bandwidth': L4 Bandwidth in bits/sec; 'l7-bandwidth': L7 Bandwidth in bits/sec; 'serv-ssl-conns-per-sec': Server SSL Connections/sec; 'fw-conns-per-sec': FW Connections/sec; 'gifw-conns-per-sec': GiFW Connections/sec; **Type:** string **Supported Values:** all, total-throughput-bits-per-sec, l4-conns-per-sec, l7-conns-per-sec, l7-trans-per-sec, ssl-conns-per-sec, ip-nat-conns-per-sec, total-new-conns-per-sec, total-curr-conns, l4-bandwidth, l7-bandwidth, serv-ssl-conns-per-sec, fw-conns-per-sec, gifw-conns-per-sec .. _1699_counter-lib-accounting: counter-lib-accounting ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_inuse-port-list: inuse-port-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_control-cpu: control-cpu ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_tcp-syn-per-sec: tcp-syn-per-sec ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_radius: radius ^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **server** **Description:** server is a **JSON Block**. Please see below for :ref:`1699_radius_server` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/radius/server ` .. _1699_radius_server: radius_server ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **accounting-interim-update** **Description** 'ignore': Ignore (default); 'append-entry': Append the AVPs to existing entry; 'replace-entry': Replace the AVPs of existing entry; **Type:** string **Supported Values:** ignore, append-entry, replace-entry **Default:** ignore **accounting-on** **Description** 'ignore': Ignore (default); 'delete-entries-using-attribute': Delete entries matching attribute in RADIUS Table; **Type:** string **Supported Values:** ignore, delete-entries-using-attribute **Default:** ignore **accounting-start** **Description** 'ignore': Ignore; 'append-entry': Append the AVPs to existing entry (default); 'replace-entry': Replace the AVPs of existing entry; **Type:** string **Supported Values:** ignore, append-entry, replace-entry **Default:** append-entry **accounting-stop** **Description** 'ignore': Ignore; 'delete-entry': Delete the entry (default); 'delete-entry-and-sessions': Delete the entry and data sessions associated(CGN only); **Type:** string **Supported Values:** ignore, delete-entry, delete-entry-and-sessions **Default:** delete-entry **attribute** **Type:** List **attribute-name** **Description** 'msisdn': Clear using MSISDN; 'imei': Clear using IMEI; 'imsi': Clear using IMSI; 'custom1': Clear using CUSTOM1 attribute configured; 'custom2': Clear using CUSTOM2 attribute configured; 'custom3': Clear using CUSTOM3 attribute configured; **Type:** string **Supported Values:** msisdn, imei, imsi, custom1, custom2, custom3 **Mutual Exclusion:** attribute-name and custom-attribute-name are mutually exclusive **custom-attribute-name** **Description** Clear using customized attribute **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **Mutual Exclusion:** custom-attribute-name and attribute-name are mutually exclusive **disable-reply** **Description** Toggle option for RADIUS reply packet(Default: Accounting response will be sent) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) **listen-port** **Description** Configure the listen port of RADIUS server (default 1813) (Port number) **Type:** number **Range:** 1024-65535 **Default:** 1813 **remote** **Description:** remote is a **JSON Block**. Please see below for :ref:`1699_radius_server_remote` **Type:** Object **sampling-enable** **Type:** List **secret** **Description** Configure shared secret **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **secret-string** **Description** The RADIUS secret **Type:** string **Format:** password **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vrid** **Description** Join a VRRP-A failover group **Type:** number **Range:** 1-31 .. _1699_radius_server_remote: radius_server_remote ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-list** **Type:** List .. _1699_radius_server_remote_ip-list: radius_server_remote_ip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-list-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) **ip-list-name** **Description** IP-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ip-list-secret** **Description** Configure shared secret **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-list-secret-string** **Description** The RADIUS secret **Type:** string **Format:** password **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _1699_radius_server_sampling-enable: radius_server_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'msisdn-received': MSISDN Received; 'imei-received': IMEI Received; 'imsi-received': IMSI Received; 'custom-received': Custom attribute Received; 'radius-request-received': RADIUS Request Received; 'radius-request-dropped': RADIUS Request Dropped (Malformed Packet); 'request-bad-secret-dropped': RADIUS Request Bad Secret Dropped; 'request-no-key-vap-dropped': RADIUS Request No Key Attribute Dropped; 'request-malformed-dropped': RADIUS Request Malformed Dropped; 'request-ignored': RADIUS Request Ignored; 'radius-table-full': RADIUS Request Dropped (Table Full); 'secret-not-configured-dropped': RADIUS Secret Not Configured Dropped; 'ha-standby-dropped': HA Standby Dropped; 'ipv6-prefix-length-mismatch': Framed IPV6 Prefix Length Mismatch; 'invalid-key': Radius Request has Invalid Key Field; 'smp-created': RADIUS SMP Created; 'smp-deleted': RADIUS SMP Deleted; 'smp-mem-allocated': RADIUS SMP Memory Allocated; 'smp-mem-alloc-failed': RADIUS SMP Memory Allocation Failed; 'smp-mem-freed': RADIUS SMP Memory Freed; 'smp-in-rml': RADIUS SMP in RML; 'mem-allocated': RADIUS Memory Allocated; 'mem-alloc-failed': RADIUS Memory Allocation Failed; 'mem-freed': RADIUS Memory Freed; 'ha-sync-create-sent': HA Record Sync Create Sent; 'ha-sync-delete-sent': HA Record Sync Delete Sent; 'ha-sync-create-recv': HA Record Sync Create Received; 'ha-sync-delete-recv': HA Record Sync Delete Received; 'acct-on-filters-full': RADIUS Acct On Request Ignored(Filters Full); 'acct-on-dup-request': Duplicate RADIUS Acct On Request; 'ip-mismatch-delete': Radius Entry IP Mismatch Delete; 'ip-add-race-drop': Radius Entry IP Add Race Drop; 'ha-sync-no-key-vap-dropped': HA Record Sync No key dropped; 'inter-card-msg-fail-drop': Inter-Card Message Fail Drop; 'radius-packets-redirected': RADIUS packets redirected (SO); 'radius-packets-redirect-fail-dropped': RADIUS packets dropped due to redirect failure (SO); 'radius-packets-process-local': RADIUS packets processed locally without redirection (SO); 'radius-packets-dropped-not-lo': RADIUS packets dropped dest not loopback (SO); **Type:** string **Supported Values:** all, msisdn-received, imei-received, imsi-received, custom-received, radius-request-received, radius-request-dropped, request-bad-secret-dropped, request-no-key-vap-dropped, request-malformed-dropped, request-ignored, radius-table-full, secret-not-configured-dropped, ha-standby-dropped, ipv6-prefix-length-mismatch, invalid-key, smp-created, smp-deleted, smp-mem-allocated, smp-mem-alloc-failed, smp-mem-freed, smp-in-rml, mem-allocated, mem-alloc-failed, mem-freed, ha-sync-create-sent, ha-sync-delete-sent, ha-sync-create-recv, ha-sync-delete-recv, acct-on-filters-full, acct-on-dup-request, ip-mismatch-delete, ip-add-race-drop, ha-sync-no-key-vap-dropped, inter-card-msg-fail-drop, radius-packets-redirected, radius-packets-redirect-fail-dropped, radius-packets-process-local, radius-packets-dropped-not-lo .. _1699_radius_server_attribute: radius_server_attribute ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **attribute-value** **Description** 'inside-ipv6-prefix': Framed IPv6 Prefix; 'inside-ip': Inside IP address; 'inside-ipv6': Inside IPv6 address; 'imei': International Mobile Equipment Identity (IMEI); 'imsi': International Mobile Subscriber Identity (IMSI); 'msisdn': Mobile Subscriber Integrated Services Digital Network-Number (MSISDN); 'custom1': Customized attribute 1; 'custom2': Customized attribute 2; 'custom3': Customized attribute 3; **Type:** string **Supported Values:** inside-ipv6-prefix, inside-ip, inside-ipv6, imei, imsi, msisdn, custom1, custom2, custom3 **custom-number** **Description** RADIUS attribute number **Type:** number **Range:** 1-255 **custom-vendor** **Description** RADIUS vendor attribute information (RADIUS vendor ID) **Type:** number **Range:** 1-65535 **name** **Description** Customized attribute name **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **number** **Description** RADIUS attribute number **Type:** number **Range:** 1-255 **prefix-length** **Description** '32': Prefix length 32; '48': Prefix length 48; '64': Prefix length 64; '80': Prefix length 80; '96': Prefix length 96; '112': Prefix length 112; **Type:** string **Supported Values:** 32, 48, 64, 80, 96, 112 **prefix-number** **Description** RADIUS attribute number **Type:** number **Range:** 1-255 **prefix-vendor** **Description** RADIUS vendor attribute information (RADIUS vendor ID) **Type:** number **Range:** 1-65535 **value** **Description** 'hexadecimal': Type of attribute value is hexadecimal; **Type:** string **Supported Values:** hexadecimal **vendor** **Description** RADIUS vendor attribute information (RADIUS vendor ID) **Type:** number **Range:** 1-65535 .. _1699_modify-port: modify-port ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-index** **Description** port index to be configured (Specify port index) **Type:** number **Range:** 0-32 **port-number** **Description** port number to be configured (Specify port number) **Type:** number **Range:** 1-32 .. _1699_del-port: del-port ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-index** **Description** port index to be configured (Specify port index) **Type:** number **Range:** 0-32 .. _1699_management-interface-mode: management-interface-mode ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **dedicated** **Description** Set management interface in dedicated mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **non-dedicated** **Description** Set management interface in non-dedicated mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_shared-poll-mode: shared-poll-mode ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable shared poll mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enable shared poll mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_reboot: reboot ^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_domain-list-info: domain-list-info ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ve-mac-scheme: ve-mac-scheme ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve-mac-scheme-val** **Description** 'hash-based': Hash-based using the VE number; 'round-robin': Round Robin scheme; 'system-mac': Use system MAC address; **Type:** string **Supported Values:** hash-based, round-robin, system-mac **Default:** hash-based .. _1699_link-monitor: link-monitor ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable Link Monitoring **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enable Link Monitoring **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_apps-global: apps-global ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **log-session-on-established** **Description** Send TCP session creation log on completion of 3-way handshake **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **msl-time** **Description** Configure maximum session life, default is 2 seconds (1-40 seconds, default is 2 seconds) **Type:** number **Range:** 1-40 **Default:** 2 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_multi-queue-support: multi-queue-support ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Enable Multi-Queue-Support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_trunk: trunk ^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **load-balance** **Description:** load-balance is a **JSON Block**. Please see below for :ref:`1699_trunk_load-balance` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/trunk/load-balance ` .. _1699_trunk_load-balance: trunk_load-balance ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **use-l3** **Description** Layer-3 Header based load balancing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-l3 and use-l4 are mutually exclusive **use-l4** **Description** Layer-3/4 Header based load balancing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-l4 and use-l3 are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_resource-usage: resource-usage ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **aflex-table-entry-count** **Description** Total aFleX table entry in the system (Total aFlex entry in the system) **Type:** number **auth-portal-html-file-size** **Description** Specify maximum html file size for each html page in auth portal (in KB) **Type:** number **Range:** 4-120 **Default:** 20 **auth-portal-image-file-size** **Description** Specify maximum image file size for default portal (in KB) **Type:** number **Range:** 1-80 **Default:** 6 **authz-policy-number** **Description** Specify the maximum number of authorization policies **Type:** number **class-list-ac-entry-count** **Description** Total entries for AC class-list **Type:** number **class-list-ipv6-addr-count** **Description** Total IPv6 addresses for class-list **Type:** number **l4-session-count** **Description** Total Sessions in the System **Type:** number **max-aflex-authz-collection-number** **Description** Specify the maximum number of collections supported by aFleX authorization **Type:** number **Range:** 256-4096 **Default:** 512 **max-aflex-file-size** **Description** Set maximum aFleX file size (Maximum file size in KBytes, default is 32K) **Type:** number **Range:** 16-256 **Default:** 32 **nat-pool-addr-count** **Description** Total configurable NAT Pool addresses in the System **Type:** number **radius-table-size** **Description** Total configurable CGNV6 RADIUS Table entries **Type:** number **ssl-context-memory** **Description** Total SSL context memory needed in units of MB. Will be rounded to closest multiple of 2MB **Type:** number **Range:** 256-16384 **Default:** 2048 **ssl-dma-memory** **Description** Total SSL DMA memory needed in units of MB. Will be rounded to closest multiple of 2MB **Type:** number **Range:** 32-2048 **Default:** 256 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **visibility** **Description:** visibility is a **JSON Block**. Please see below for :ref:`1699_resource-usage_visibility` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/resource-usage/visibility ` .. _1699_resource-usage_visibility: resource-usage_visibility ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **monitored-entity-count** **Description** Total number of monitored entities for visibility **Type:** number **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_throughput: throughput ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_throughput_sampling-enable: throughput_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'global-system-throughput-bits-per-sec': Global System throughput in bits/sec; 'per-part-throughput-bits-per-sec': Partition throughput in bits/sec; **Type:** string **Supported Values:** all, global-system-throughput-bits-per-sec, per-part-throughput-bits-per-sec .. _1699_cm-update-file-name-ref: cm-update-file-name-ref ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **dest_name** **Description** bind dest name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **id** **Description** Specify unique Partition id **Type:** number **source_name** **Description** bind source name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _1699_spe-status: spe-status ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_fpga-core-crc: fpga-core-crc ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **monitor-disable** **Description** Disable FPGA Core CRC error monitoring and act on it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reboot-enable** **Description** Enable system reboot if system encounters FPGA Core CRC error **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_cpu-load-sharing: cpu-load-sharing ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **cpu-usage** **Description:** cpu-usage is a **JSON Block**. Please see below for :ref:`1699_cpu-load-sharing_cpu-usage` **Type:** Object **disable** **Description** Disable CPU load sharing in overload situations **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **packets-per-second** **Description:** packets-per-second is a **JSON Block**. Please see below for :ref:`1699_cpu-load-sharing_packets-per-second` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_cpu-load-sharing_packets-per-second: cpu-load-sharing_packets-per-second ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **min** **Description** Minimum packets-per-second threshold (per CPU) before redistribution will take effect (Minimum packets-per-second threshold (per CPU) before redistribution will take effect (default: 100000)) **Type:** number **Range:** 0-30000000 **Default:** 100000 .. _1699_cpu-load-sharing_cpu-usage: cpu-load-sharing_cpu-usage ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **high** **Description** CPU usage threshold (percentage) that will trigger the redistribution (default: 75) **Type:** number **Range:** 0-100 **Default:** 75 **low** **Description** CPU usage threshold (percentage) that will restore the normal packet distribution (default: 60) **Type:** number **Range:** 0-100 **Default:** 60 .. _1699_geoloc-list-list: geoloc-list-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exclude-geoloc-name-list** **Type:** List **include-geoloc-name-list** **Type:** List **name** **Description** Specify name of Geolocation list **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **shared** **Description** Enable sharing with other partitions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_geoloc-list-list_sampling-enable: geoloc-list-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hit-count': hit-count; 'total-geoloc': total-geoloc; 'total-active': total-active; **Type:** string **Supported Values:** all, hit-count, total-geoloc, total-active .. _1699_geoloc-list-list_include-geoloc-name-list: geoloc-list-list_include-geoloc-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **include-geoloc-name-val** **Description** Geolocation name to add **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _1699_geoloc-list-list_exclude-geoloc-name-list: geoloc-list-list_exclude-geoloc-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exclude-geoloc-name-val** **Description** Geolocation name to exclude **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _1699_shutdown: shutdown ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ip-stats: ip-stats ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ip-stats_sampling-enable: ip-stats_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'inreceives': Incoming packets received; 'inhdrerrors': Incoming packet header errors; 'intoobigerrors': Incoming packet too big errors; 'innoroutes': Incoming no route packet drops; 'inaddrerrors': Incoming packet address errors; 'inunknownprotos': Incoming unkown protocol packet drops; 'intruncatedpkts': Incoming truncated packets; 'indiscards': Incoming packets discarded; 'indelivers': Incoming packets delivered; 'outforwdatagrams': Outgoing forwarded datagrams; 'outrequests': Outgoing packets; 'outdiscards': Outgoing packets discarded; 'outnoroutes': Outgoing no route packet drops; 'reasmtimeout': Reassembly timed out packet drops; 'reasmreqds': Incoming reassembly requests; 'reasmoks': Incoming reassembled packets; 'reasmfails': Incoming reassembly requests failed; 'fragoks': Outgoing packets fragmented; 'fragfails': Outgoing packets fragmentation failed; 'fragcreates': Outgoing fragmented packets; 'inmcastpkts': Incoming multicast packets; 'outmcastpkts': Outgoing multicast packets; **Type:** string **Supported Values:** all, inreceives, inhdrerrors, intoobigerrors, innoroutes, inaddrerrors, inunknownprotos, intruncatedpkts, indiscards, indelivers, outforwdatagrams, outrequests, outdiscards, outnoroutes, reasmtimeout, reasmreqds, reasmoks, reasmfails, fragoks, fragfails, fragcreates, inmcastpkts, outmcastpkts .. _1699_ip6-stats: ip6-stats ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ip6-stats_sampling-enable: ip6-stats_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'inreceives': Incoming packets received; 'inhdrerrors': Incoming packet header errors; 'intoobigerrors': Incoming packet too big errors; 'innoroutes': Incoming no route packet drops; 'inaddrerrors': Incoming packet address errors; 'inunknownprotos': Incoming unkown protocol packet drops; 'intruncatedpkts': Incoming truncated packets; 'indiscards': Incoming packets discarded; 'indelivers': Incoming packets delivered; 'outforwdatagrams': Outgoing forwarded datagrams; 'outrequests': Outgoing packets; 'outdiscards': Outgoing packets discarded; 'outnoroutes': Outgoing no route packet drops; 'reasmtimeout': Reassembly timed out packet drops; 'reasmreqds': Incoming reassembly requests; 'reasmoks': Incoming reassembled packets; 'reasmfails': Incoming reassembly requests failed; 'fragoks': Outgoing packets fragmented; 'fragfails': Outgoing packets fragmentation failed; 'fragcreates': Outgoing fragmented packets; 'inmcastpkts': Incoming multicast packets; 'outmcastpkts': Outgoing multicast packets; **Type:** string **Supported Values:** all, inreceives, inhdrerrors, intoobigerrors, innoroutes, inaddrerrors, inunknownprotos, intruncatedpkts, indiscards, indelivers, outforwdatagrams, outrequests, outdiscards, outnoroutes, reasmtimeout, reasmreqds, reasmoks, reasmfails, fragoks, fragfails, fragcreates, inmcastpkts, outmcastpkts .. _1699_io-cpu: io-cpu ^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **max-cores** **Description** max number of IO cores (Specify number of cores) **Type:** number **Range:** 0-128 .. _1699_dns: dns ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_dns_sampling-enable: dns_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'slb_req': No. of requests; 'slb_resp': No. of responses; 'slb_no_resp': No. of resource failures; 'slb_req_rexmit': No. of request retransmits; 'slb_resp_no_match': No. of requests with no response; '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; **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 .. _1699_memory: memory ^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_memory_sampling-enable: memory_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'usage-percentage': Memory Usage percentage; **Type:** string **Supported Values:** all, usage-percentage .. _1699_cpu-hyper-thread: cpu-hyper-thread ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable CPU Hyperthreading **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enable CPU Hyperthreading **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_spe-profile: spe-profile ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'ipv4-only': Enable IPv4 HW forward entries only; 'ipv6-only': Enable IPv6 HW forward entries only; 'ipv4-ipv6': Enable Both IPv4/IPv6 HW forward entries (shared); **Type:** string **Supported Values:** ipv4-only, ipv6-only, ipv4-ipv6 **Default:** ipv4-ipv6 .. _1699_add-cpu-core: add-cpu-core ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **core-index** **Description** core index to be added (Specify core index) **Type:** number **Range:** 0-128 .. _1699_cpu-list: cpu-list ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_icmp: icmp ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_icmp_sampling-enable: icmp_sampling-enable ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num': Total number; 'inmsgs': In Messages; 'inerrors': In Errors; 'indestunreachs': In Destination Unreachable; 'intimeexcds': In TTL Exceeds; 'inparmprobs': In Parameter Problem; 'insrcquenchs': In Source Quench Error; 'inredirects': In Redirects; 'inechos': In Echo requests; 'inechoreps': In Echo replies; 'intimestamps': In Timestamp; 'intimestampreps': In Timestamp Rep; 'inaddrmasks': In Address Masks; 'inaddrmaskreps': In Address Mask Rep; 'outmsgs': Out Message; 'outerrors': Out Errors; 'outdestunreachs': Out Destination Unreachable; 'outtimeexcds': Out TTL Exceeds; 'outparmprobs': Out Parameter Problem; 'outsrcquenchs': Out Source Quench Error; 'outredirects': Out Redirects; 'outechos': Out Echo Requests; 'outechoreps': Out Echo Replies; 'outtimestamps': Out Time Stamp; 'outtimestampreps': Out Time Stamp Rep; 'outaddrmasks': Out Address Mask; 'outaddrmaskreps': Out Address Mask Rep; **Type:** string **Supported Values:** all, num, inmsgs, inerrors, indestunreachs, intimeexcds, inparmprobs, insrcquenchs, inredirects, inechos, inechoreps, intimestamps, intimestampreps, inaddrmasks, inaddrmaskreps, outmsgs, outerrors, outdestunreachs, outtimeexcds, outparmprobs, outsrcquenchs, outredirects, outechos, outechoreps, outtimestamps, outtimestampreps, outaddrmasks, outaddrmaskreps .. _1699_gui-image-list: gui-image-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_hardware-forward: hardware-forward ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_hardware-forward_sampling-enable: hardware-forward_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hit-counts': Total packts hit counts; 'hit-index': HW Fwd hit index; 'ipv4-forward-counts': Total IPv4 hardware forwarded packets; 'ipv6-forward-counts': Total IPv6 hardware forwarded packets; 'hw-fwd-module-status': hardware forwarder status flags; 'hw-fwd-prog-reqs': hardware forward programming requests; 'hw-fwd-prog-errors': hardware forward programming Errors; 'hw-fwd-flow-singlebit-errors': hardware forward singlebit Errors; 'hw-fwd-flow-tag-mismatch': hardware forward tag mismatch errors; 'hw-fwd-flow-seq-mismatch': hardware forward sequence mismatch errors; 'hw-fwd-ageout-drop-count': hardware forward ageout drop count; 'hw-fwd-invalidation-drop': hardware forward invalid drop count; 'hw-fwd-flow-hit-index': hardware forward flow hit index; 'hw-fwd-flow-reason-flags': hardware forward flow reason flags; 'hw-fwd-flow-drop-count': hardware forward flow drop count; 'hw-fwd-flow-error-count': hardware forward flow error count; 'hw-fwd-flow-unalign-count': hardware forward flow unalign count; 'hw-fwd-flow-underflow-count': hardware forward flow underflow count; 'hw-fwd-flow-tx-full-drop': hardware forward flow tx full drop count; 'hw-fwd-flow-qdr-full-drop': hardware forward flow qdr full drop count; 'hw-fwd-phyport-mismatch-drop': hardware forward phyport mismatch count; 'hw-fwd-vlanid-mismatch-drop': hardware forward vlanid mismatch count; 'hw-fwd-vmid-drop': hardware forward vmid mismatch count; 'hw-fwd-protocol-mismatch-drop': hardware forward protocol mismatch count; 'hw-fwd-avail-ipv4-entry': hardware forward available ipv4 entries count; 'hw-fwd-avail-ipv6-entry': hardware forward available ipv6 entries count; 'hw-fwd-entry-create': Hardware Entries Created; 'hw-fwd-entry-create-failure': Hardware Entries Created; 'hw-fwd-entry-create-fail-server-down': Hardware Entries Created; 'hw-fwd-entry-create-fail-max-entry': Hardware Entries Created; 'hw-fwd-entry-free': Hardware Entries Freed; 'hw-fwd-entry-free-opp-entry': Hardware Entries Free due to opposite tuple entry ageout event; 'hw-fwd-entry-free-no-hw-prog': Hardware Entry Free no hw prog; 'hw-fwd-entry-free-no-conn': Hardware Entry Free no matched conn; 'hw-fwd-entry-free-no-sw-entry': Hardware Entry Free no software entry; 'hw-fwd-entry-counter': Hardware Entry Count; 'hw-fwd-entry-age-out': Hardware Entries Aged Out; 'hw-fwd-entry-age-out-idle': Hardware Entries Aged Out Idle; 'hw-fwd-entry-age-out-tcp-fin': Hardware Entries Aged Out TCP FIN; 'hw-fwd-entry-age-out-tcp-rst': Hardware Entries Aged Out TCP RST; 'hw-fwd-entry-age-out-invalid-dst': Hardware Entries Aged Out invalid dst; 'hw-fwd-entry-force-hw-invalidate': Hardware Entries Force HW Invalidate; 'hw-fwd-entry-invalidate-server-down': Hardware Entries Invalidate due to server down; 'hw-fwd-tcam-create': TCAM Entries Created; 'hw-fwd-tcam-free': TCAM Entries Freed; 'hw-fwd-tcam-counter': TCAM Entry Count; **Type:** string **Supported Values:** all, hit-counts, hit-index, ipv4-forward-counts, ipv6-forward-counts, hw-fwd-module-status, hw-fwd-prog-reqs, hw-fwd-prog-errors, hw-fwd-flow-singlebit-errors, hw-fwd-flow-tag-mismatch, hw-fwd-flow-seq-mismatch, hw-fwd-ageout-drop-count, hw-fwd-invalidation-drop, hw-fwd-flow-hit-index, hw-fwd-flow-reason-flags, hw-fwd-flow-drop-count, hw-fwd-flow-error-count, hw-fwd-flow-unalign-count, hw-fwd-flow-underflow-count, hw-fwd-flow-tx-full-drop, hw-fwd-flow-qdr-full-drop, hw-fwd-phyport-mismatch-drop, hw-fwd-vlanid-mismatch-drop, hw-fwd-vmid-drop, hw-fwd-protocol-mismatch-drop, hw-fwd-avail-ipv4-entry, hw-fwd-avail-ipv6-entry, hw-fwd-entry-create, hw-fwd-entry-create-failure, hw-fwd-entry-create-fail-server-down, hw-fwd-entry-create-fail-max-entry, hw-fwd-entry-free, hw-fwd-entry-free-opp-entry, hw-fwd-entry-free-no-hw-prog, hw-fwd-entry-free-no-conn, hw-fwd-entry-free-no-sw-entry, hw-fwd-entry-counter, hw-fwd-entry-age-out, hw-fwd-entry-age-out-idle, hw-fwd-entry-age-out-tcp-fin, hw-fwd-entry-age-out-tcp-rst, hw-fwd-entry-age-out-invalid-dst, hw-fwd-entry-force-hw-invalidate, hw-fwd-entry-invalidate-server-down, hw-fwd-tcam-create, hw-fwd-tcam-free, hw-fwd-tcam-counter .. _1699_tcp-stats: tcp-stats ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_tcp-stats_sampling-enable: tcp-stats_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'connattempt': Connect initiated; 'connects': Connect established; 'drops': Connect dropped; 'conndrops': Embryonic connect dropped; 'closed': Connect closed; 'segstimed': Segs to get RTT; 'rttupdated': Update RTT; 'delack': Delayed acks sent; 'timeoutdrop': Conn dropped in rxmt timeout; 'rexmttimeo': Retransmit timeout; 'persisttimeo': Persist timeout; 'keeptimeo': Keepalive timeout; 'keepprobe': Keepalive probe sent; 'keepdrops': Connect dropped in keepalive; 'sndtotal': Total packet sent; 'sndpack': Data packet sent; 'sndbyte': Data bytes sent; 'sndrexmitpack': Data packet retransmit; 'sndrexmitbyte': Data byte retransmit; 'sndrexmitbad': Unnecessary packet retransmit; 'sndacks': Ack packet sent; 'sndprobe': Window probe sent; 'sndurg': URG packet sent; 'sndwinup': Window update packet sent; 'sndctrl': SYN|FIN|RST packet sent; 'sndrst': RST packet sent; 'sndfin': FIN packet sent; 'sndsyn': SYN packet sent; 'rcvtotal': Total packet received; 'rcvpack': Packet received; 'rcvbyte': Bytes received; 'rcvbadoff': Packet received with bad offset; 'rcvmemdrop': Packet dropped for lack of memory; 'rcvshort': Packet received too short; 'rcvduppack': Duplicate packet received; 'rcvdupbyte': Duplicate bytes received; 'rcvpartduppack': Packet with some duplicate data; 'rcvpartdupbyte': Dup. bytes in part-dup. packets; 'rcvoopack': Out-of-order packet received; 'rcvoobyte': Out-of-order bytes received; 'rcvpackafterwin': Packets with data after window; 'rcvbyteafterwin': Bytes rcvd after window; 'rcvwinprobe': Rcvd window probe packet; 'rcvdupack': Rcvd duplicate acks; 'rcvacktoomuch': Rcvd acks for unsent data; 'rcvackpack': Rcvd ack packets; 'rcvackbyte': Bytes acked by rcvd acks; 'rcvwinupd': Rcvd window update packets; 'pawsdrop': Segments dropped due to PAWS; 'predack': Hdr predict for acks; 'preddat': Hdr predict for data pkts; 'persistdrop': Timeout in persist state; 'mturesent': Resends due to MTU discovery; 'badrst': Ignored RST; 'finwait2_drops': Drop FIN_WAIT_2 connection after time limit; 'sack_recovery_episode': SACK recovery episodes; 'sack_rexmits': SACK rexmit segments; 'sack_rexmit_bytes': SACK rexmit bytes; 'sack_rcv_blocks': SACK received; 'sack_send_blocks': SACK sent; 'ecn_shs': ECN successful handshakes; 'ecn_rcwnd': ECN reduced the cwnd; 'sndcack': Challenge ACK sent; 'cacklim': Challenge ACK limited; **Type:** string **Supported Values:** all, connattempt, connects, drops, conndrops, closed, segstimed, rttupdated, delack, timeoutdrop, rexmttimeo, persisttimeo, keeptimeo, keepprobe, keepdrops, sndtotal, sndpack, sndbyte, sndrexmitpack, sndrexmitbyte, sndrexmitbad, sndacks, sndprobe, sndurg, sndwinup, sndctrl, sndrst, sndfin, sndsyn, rcvtotal, rcvpack, rcvbyte, rcvbadoff, rcvmemdrop, rcvduppack, rcvdupbyte, rcvpartduppack, rcvpartdupbyte, rcvoopack, rcvoobyte, rcvpackafterwin, rcvbyteafterwin, rcvwinprobe, rcvdupack, rcvacktoomuch, rcvackpack, rcvackbyte, rcvwinupd, pawsdrop, predack, preddat, persistdrop, badrst, finwait2_drops, sack_recovery_episode, sack_rexmits, sack_rexmit_bytes, sack_rcv_blocks, sack_send_blocks, sndcack, cacklim, reassmemdrop, reasstimeout, cc_idle, cc_reduce, rcvdsack, a2brcvwnd, a2bsackpresent, a2bdupack, a2brxdata, a2btcpoptions, a2boodata, a2bpartialack, a2bfsmtransition, a2btransitionnum, b2atransitionnum, bad_iochan, atcpforward, atcpsent, atcprexmitsadrop, atcpsendbackack, atcprexmit, atcpbuffallocfail, a2bappbuffering, atcpsendfail, earlyrexmit, mburstlim, a2bsndwnd, proxyheaderv1, proxyheaderv2 .. _1699_delete-cpu-core: delete-cpu-core ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **core-index** **Description** core index to be deleted (Specify core index) **Type:** number **Range:** 0-128 .. _1699_geoloc-name-helper: geoloc-name-helper ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_geoloc-name-helper_sampling-enable: geoloc-name-helper_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'place-holder': place-holder; **Type:** string **Supported Values:** all, place-holder .. _1699_shell-privileges: shell-privileges ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable-shell-privileges** **Description** enable the shell privileges for a given customer **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_link-capability: link-capability ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Enable/Disable link capabilities **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_timeout-value: timeout-value ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ftp** **Description** set timeout to stop ftp transfer in seconds, 0 is no limit **Type:** number **Range:** 0-9999 **Default:** 120 **http** **Description** set timeout to stop http transfer in seconds, 0 is no limit **Type:** number **Range:** 0-9999 **Default:** 0 **https** **Description** set timeout to stop https transfer in seconds, 0 is no limit **Type:** number **Range:** 0-9999 **Default:** 0 **scp** **Description** set timeout to stop scp transfer in seconds, 0 is no limit **Type:** number **Range:** 0-9999 **Default:** 300 **sftp** **Description** set timeout to stop sftp transfer in seconds, 0 is no limit **Type:** number **Range:** 0-9999 **Default:** 0 **tftp** **Description** set timeout to stop tftp transfer in seconds, 0 is no limit **Type:** number **Range:** 0-9999 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_asic-debug-dump: asic-debug-dump ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Enable/Disable L2L3 ASIC traffic discard/drop events and Dump debug information **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_port-list: port-list ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_resource-accounting: resource-accounting ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **template-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/system/resource-accounting/template/{name} ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_resource-accounting_template-list: resource-accounting_template-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **app-resources** **Description:** app-resources is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/resource-accounting/template/{name}/app-resources ` **name** **Description** Enter template name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **network-resources** **Description:** network-resources is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/resource-accounting/template/{name}/network-resources ` **system-resources** **Description:** system-resources is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/resource-accounting/template/{name}/system-resources ` **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_resource-accounting_template-list_app-resources: resource-accounting_template-list_app-resources ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-device-cfg** **Description:** gslb-device-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-device-cfg` **Type:** Object **gslb-geo-location-cfg** **Description:** gslb-geo-location-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-geo-location-cfg` **Type:** Object **gslb-ip-list-cfg** **Description:** gslb-ip-list-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-ip-list-cfg` **Type:** Object **gslb-policy-cfg** **Description:** gslb-policy-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-policy-cfg` **Type:** Object **gslb-service-cfg** **Description:** gslb-service-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-service-cfg` **Type:** Object **gslb-service-ip-cfg** **Description:** gslb-service-ip-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-service-ip-cfg` **Type:** Object **gslb-service-port-cfg** **Description:** gslb-service-port-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-service-port-cfg` **Type:** Object **gslb-site-cfg** **Description:** gslb-site-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-site-cfg` **Type:** Object **gslb-svc-group-cfg** **Description:** gslb-svc-group-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-svc-group-cfg` **Type:** Object **gslb-template-cfg** **Description:** gslb-template-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-template-cfg` **Type:** Object **gslb-zone-cfg** **Description:** gslb-zone-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_gslb-zone-cfg` **Type:** Object **health-monitor-cfg** **Description:** health-monitor-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_health-monitor-cfg` **Type:** Object **real-port-cfg** **Description:** real-port-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_real-port-cfg` **Type:** Object **real-server-cfg** **Description:** real-server-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_real-server-cfg` **Type:** Object **service-group-cfg** **Description:** service-group-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_service-group-cfg` **Type:** Object **threshold** **Description** Enter the threshold as a percentage (Threshold in percentage(default is 100%)) **Type:** number **Range:** 1-99 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **virtual-server-cfg** **Description:** virtual-server-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_app-resources_virtual-server-cfg` **Type:** Object .. _1699_resource-accounting_template-list_app-resources_gslb-site-cfg: resource-accounting_template-list_app-resources_gslb-site-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-site-max** **Description** Enter the number of gslb-site allowed (gslb-site count (default is max-value)) **Type:** number **gslb-site-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-policy-cfg: resource-accounting_template-list_app-resources_gslb-policy-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-policy-max** **Description** Enter the number of gslb-policy allowed (gslb-policy count (default is max-value)) **Type:** number **gslb-policy-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-service-cfg: resource-accounting_template-list_app-resources_gslb-service-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-service-max** **Description** Enter the number of gslb-service allowed (gslb-service count (default is max-value) **Type:** number **gslb-service-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-geo-location-cfg: resource-accounting_template-list_app-resources_gslb-geo-location-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-geo-location-max** **Description** Enter the number of gslb-geo-location allowed (gslb-geo-location count (default is max-value)) **Type:** number **gslb-geo-location-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_real-server-cfg: resource-accounting_template-list_app-resources_real-server-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **real-server-max** **Description** Enter the number of real-servers allowed (real-server count (default is max-value)) **Type:** number **real-server-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_virtual-server-cfg: resource-accounting_template-list_app-resources_virtual-server-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **virtual-server-max** **Description** Enter the number of virtual-servers allowed (virtual-server count (default is max-value)) **Type:** number **virtual-server-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-ip-list-cfg: resource-accounting_template-list_app-resources_gslb-ip-list-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-ip-list-max** **Description** Enter the number of gslb-ip-list allowed (gslb-ip-list count (default is max-value)) **Type:** number **gslb-ip-list-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-template-cfg: resource-accounting_template-list_app-resources_gslb-template-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-template-max** **Description** Enter the number of gslb-template allowed (gslb-template count (default is max-value)) **Type:** number **gslb-template-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_health-monitor-cfg: resource-accounting_template-list_app-resources_health-monitor-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **health-monitor-max** **Description** Enter the number of health monitors allowed (health-monitor count (default is max-value)) **Type:** number **Range:** 0-1023 **health-monitor-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-1023 **Default:** 0 .. _1699_resource-accounting_template-list_app-resources_gslb-service-port-cfg: resource-accounting_template-list_app-resources_gslb-service-port-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-service-port-max** **Description** Enter the number of gslb-service-port allowed ( gslb-service-port count (default is max-value)) **Type:** number **gslb-service-port-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-zone-cfg: resource-accounting_template-list_app-resources_gslb-zone-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-zone-max** **Description** Enter the number of gslb-zone allowed (gslb-zone count (default is max-value)) **Type:** number **gslb-zone-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_real-port-cfg: resource-accounting_template-list_app-resources_real-port-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **real-port-max** **Description** Enter the number of real-ports allowed (real-port count (default is max-value)) **Type:** number **real-port-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-svc-group-cfg: resource-accounting_template-list_app-resources_gslb-svc-group-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-svc-group-max** **Description** Enter the number of gslb-svc-group allowed (gslb-svc-group count (default is max-value)) **Type:** number **gslb-svc-group-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_service-group-cfg: resource-accounting_template-list_app-resources_service-group-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **service-group-max** **Description** Enter the number of service groups allowed (service-group count (default is max-value)) **Type:** number **service-group-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-device-cfg: resource-accounting_template-list_app-resources_gslb-device-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-device-max** **Description** Enter the number of gslb-device allowed (gslb-device count (default is max-value)) **Type:** number **gslb-device-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_app-resources_gslb-service-ip-cfg: resource-accounting_template-list_app-resources_gslb-service-ip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **gslb-service-ip-max** **Description** Enter the number of gslb-service-ip allowed (gslb-service-ip count (default is max-value)) **Type:** number **gslb-service-ip-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number .. _1699_resource-accounting_template-list_system-resources: resource-accounting_template-list_system-resources ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **bw-limit-cfg** **Description:** bw-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_bw-limit-cfg` **Type:** Object **concurrent-session-limit-cfg** **Description:** concurrent-session-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_concurrent-session-limit-cfg` **Type:** Object **fwcps-limit-cfg** **Description:** fwcps-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_fwcps-limit-cfg` **Type:** Object **l4-session-limit-cfg** **Description:** l4-session-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_l4-session-limit-cfg` **Type:** Object **l4cps-limit-cfg** **Description:** l4cps-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_l4cps-limit-cfg` **Type:** Object **l7cps-limit-cfg** **Description:** l7cps-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_l7cps-limit-cfg` **Type:** Object **natcps-limit-cfg** **Description:** natcps-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_natcps-limit-cfg` **Type:** Object **ssl-throughput-limit-cfg** **Description:** ssl-throughput-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_ssl-throughput-limit-cfg` **Type:** Object **sslcps-limit-cfg** **Description:** sslcps-limit-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_system-resources_sslcps-limit-cfg` **Type:** Object **threshold** **Description** Enter the threshold as a percentage (Threshold in percentage(default is 100%)) **Type:** number **Range:** 1-99 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_resource-accounting_template-list_system-resources_l4-session-limit-cfg: resource-accounting_template-list_system-resources_l4-session-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **l4-session-limit-max** **Description** Enter the l4 session limit in % (0.01% to 99.99%) (Enter a number from 0.01 to 99.99 (up to 2 digits precision)) **Type:** string **Maximum Length:** 5 characters **Maximum Length:** 1 characters **l4-session-limit-min-guarantee** **Description** minimum guaranteed value in % (up to 2 digits precision) (Enter a number from 0 to 99.99) **Type:** string **Maximum Length:** 5 characters **Maximum Length:** 1 characters **Default:** 0 .. _1699_resource-accounting_template-list_system-resources_l7cps-limit-cfg: resource-accounting_template-list_system-resources_l7cps-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **l7cps-limit-max** **Description** L7cps-limit (L7 cps limit (no limits applied by default)) **Type:** number **Range:** 100-300000 .. _1699_resource-accounting_template-list_system-resources_l4cps-limit-cfg: resource-accounting_template-list_system-resources_l4cps-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **l4cps-limit-max** **Description** Enter the L4 cps limit (L4 cps limit (no limits applied by default)) **Type:** number **Range:** 100-1000000 .. _1699_resource-accounting_template-list_system-resources_natcps-limit-cfg: resource-accounting_template-list_system-resources_natcps-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **natcps-limit-max** **Description** Enter the Nat cps limit (NAT cps limit (no limits applied by default)) **Type:** number **Range:** 100-1000000 .. _1699_resource-accounting_template-list_system-resources_sslcps-limit-cfg: resource-accounting_template-list_system-resources_sslcps-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sslcps-limit-max** **Description** Enter the SSL cps limit (SSL cps limit (no limits applied by default)) **Type:** number **Range:** 100-300000 .. _1699_resource-accounting_template-list_system-resources_fwcps-limit-cfg: resource-accounting_template-list_system-resources_fwcps-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **fwcps-limit-max** **Description** Enter the Firewall cps limit (Firewall cps limit (no limits applied by default)) **Type:** number **Range:** 100-1000000 .. _1699_resource-accounting_template-list_system-resources_ssl-throughput-limit-cfg: resource-accounting_template-list_system-resources_ssl-throughput-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ssl-throughput-limit-max** **Description** Enter the ssl throughput limit in mbps (SSL Througput limit in Mbit/s (no limits applied by default)) **Type:** number **Range:** 10-10000 **ssl-throughput-limit-watermark-disable** **Description** Disable watermark (90% drop, keep existing sessions, drop new sessions) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_resource-accounting_template-list_system-resources_bw-limit-cfg: resource-accounting_template-list_system-resources_bw-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **bw-limit-max** **Description** Enter the bandwidth limit in mbps (Bandwidth limit in Mbit/s (no limits applied by default)) **Type:** number **Range:** 10-10000 **bw-limit-watermark-disable** **Description** Disable watermark (90% drop, keep existing sessions, drop new sessions) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_resource-accounting_template-list_system-resources_concurrent-session-limit-cfg: resource-accounting_template-list_system-resources_concurrent-session-limit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **concurrent-session-limit-max** **Description** Enter the Concurrent Session limit (cps) (Concurrent-Session cps limit (no limits applied by default)) **Type:** number .. _1699_resource-accounting_template-list_network-resources: resource-accounting_template-list_network-resources ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv4-acl-line-cfg** **Description:** ipv4-acl-line-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_ipv4-acl-line-cfg` **Type:** Object **ipv6-acl-line-cfg** **Description:** ipv6-acl-line-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_ipv6-acl-line-cfg` **Type:** Object **object-group-cfg** **Description:** object-group-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_object-group-cfg` **Type:** Object **object-group-clause-cfg** **Description:** object-group-clause-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_object-group-clause-cfg` **Type:** Object **static-arp-cfg** **Description:** static-arp-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_static-arp-cfg` **Type:** Object **static-ipv4-route-cfg** **Description:** static-ipv4-route-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_static-ipv4-route-cfg` **Type:** Object **static-ipv6-route-cfg** **Description:** static-ipv6-route-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_static-ipv6-route-cfg` **Type:** Object **static-mac-cfg** **Description:** static-mac-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_static-mac-cfg` **Type:** Object **static-neighbor-cfg** **Description:** static-neighbor-cfg is a **JSON Block**. Please see below for :ref:`1699_resource-accounting_template-list_network-resources_static-neighbor-cfg` **Type:** Object **threshold** **Description** Enter the threshold as a percentage (Threshold in percentage(default is 100%)) **Type:** number **Range:** 1-99 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_resource-accounting_template-list_network-resources_static-ipv6-route-cfg: resource-accounting_template-list_network-resources_static-ipv6-route-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **static-ipv6-route-max** **Description** Enter the number of static ipv6 routes allowed (Static ipv6 routes (default is max-value)) **Type:** number **Range:** 0-4000 **static-ipv6-route-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-4000 **Default:** 0 .. _1699_resource-accounting_template-list_network-resources_object-group-clause-cfg: resource-accounting_template-list_network-resources_object-group-clause-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **object-group-clause-max** **Description** Enter the number of object group clauses allowed (Object group clauses (default is max-value)) **Type:** number **Range:** 0-8192000 **object-group-clause-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-8192000 **Default:** 0 .. _1699_resource-accounting_template-list_network-resources_static-ipv4-route-cfg: resource-accounting_template-list_network-resources_static-ipv4-route-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **static-ipv4-route-max** **Description** Enter the number of static ipv4 routes allowed (Static ipv4 routes (default is max-value)) **Type:** number **Range:** 0-4000 **static-ipv4-route-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-4000 **Default:** 0 .. _1699_resource-accounting_template-list_network-resources_static-arp-cfg: resource-accounting_template-list_network-resources_static-arp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **static-arp-max** **Description** Enter the number of static arp entries allowed (Static arp (default is max-value)) **Type:** number **Range:** 0-128 **static-arp-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-128 **Default:** 0 .. _1699_resource-accounting_template-list_network-resources_ipv4-acl-line-cfg: resource-accounting_template-list_network-resources_ipv4-acl-line-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv4-acl-line-max** **Description** Enter the number of ACL lines allowed (IPV4 ACL lines (default is max-value)) **Type:** number **Range:** 0-16000 **ipv4-acl-line-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-16000 **Default:** 0 .. _1699_resource-accounting_template-list_network-resources_static-mac-cfg: resource-accounting_template-list_network-resources_static-mac-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **static-mac-max** **Description** Enter the number of static MAC entries allowed (Static MACs (default is max-value)) **Type:** number **Range:** 0-500 **static-mac-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-500 **Default:** 0 .. _1699_resource-accounting_template-list_network-resources_ipv6-acl-line-cfg: resource-accounting_template-list_network-resources_ipv6-acl-line-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv6-acl-line-max** **Description** Enter the number of ACL lines allowed (IPV6 ACL lines (default is max-value)) **Type:** number **Range:** 0-16000 **ipv6-acl-line-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-16000 **Default:** 0 .. _1699_resource-accounting_template-list_network-resources_static-neighbor-cfg: resource-accounting_template-list_network-resources_static-neighbor-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **static-neighbor-max** **Description** Enter the number of static neighbor entries allowed (Static neighbors (default is max-value)) **Type:** number **Range:** 0-128 **static-neighbor-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-128 **Default:** 0 .. _1699_resource-accounting_template-list_network-resources_object-group-cfg: resource-accounting_template-list_network-resources_object-group-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **object-group-max** **Description** Enter the number of object groups allowed (Object group (default is max-value)) **Type:** number **Range:** 0-8000 **object-group-min-guarantee** **Description** Minimum guaranteed value ( Minimum guaranteed value) **Type:** number **Range:** 0-8000 **Default:** 0 .. _1699_hardware: hardware ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_all-vlan-limit: all-vlan-limit ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **bcast** **Description** broadcast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 5000 **ipmcast** **Description** IP multicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 5000 **mcast** **Description** multicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 5000 **unknown-ucast** **Description** unknown unicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 5000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_guest-file: guest-file ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_per-vlan-limit: per-vlan-limit ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **bcast** **Description** broadcast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 1000 **ipmcast** **Description** IP multicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 1000 **mcast** **Description** multicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 1000 **unknown-ucast** **Description** unknown unicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 1000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_deep-hrxq: deep-hrxq ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_cosq-show: cosq-show ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_syslog-time-msec: syslog-time-msec ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable-flag** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1699_ipmi-service: ipmi-service ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable IPMI on platform **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_data-cpu: data-cpu ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_dns-cache: dns-cache ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_dns-cache_sampling-enable: dns-cache_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total_q': Total query; 'total_r': Total server response; 'hit': Total cache hit; 'bad_q': Query not passed; 'encode_q': Query encoded; 'multiple_q': Query with multiple questions; 'oversize_q': Query exceed cache size; 'bad_r': Response not passed; 'oversize_r': Response exceed cache size; 'encode_r': Response encoded; 'multiple_r': Response with multiple questions; 'answer_r': Response with multiple answers; 'ttl_r': Response with short TTL; 'ageout': Total aged out; 'bad_answer': Bad Answer; 'ageout_weight': Total aged for lower weight; 'total_log': Total stats log sent; 'total_alloc': Total allocated; 'total_freed': Total freed; 'current_allocate': Current allocate; 'current_data_allocate': Current data allocate; **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 .. _1699_set-tcp-syn-per-sec: set-tcp-syn-per-sec ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tcp-syn-value** **Description** Configure Tcp SYN's per sec, default 70 **Type:** number **Range:** 25-6000 **Default:** 70 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_fw: fw ^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **application-flow** **Description** Number of flows **Type:** number **application-mempool** **Description** Enable application memory pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **basic-dpi-enable** **Description** Enable basic dpi **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_ip-dns-cache: ip-dns-cache ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_mon-template: mon-template ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **link-down-on-restart** **Description:** link-down-on-restart is a **JSON Block**. Please see below for :ref:`1699_mon-template_link-down-on-restart` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/mon-template/link-down-on-restart ` **monitor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/system/mon-template/monitor/{id} ` .. _1699_mon-template_link-down-on-restart: mon-template_link-down-on-restart ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_mon-template_monitor-list: mon-template_monitor-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1699_mon-template_monitor-list_clear-cfg: mon-template_monitor-list_clear-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **clear-all-sequence** **Description** Sequence number (Specify the port physical port number) **Type:** number **Range:** 1-16 **clear-sequence** **Description** Specify the port physical port number **Type:** number **Range:** 1-16 **sessions** **Description** 'all': Clear all sessions; 'sequence': Sequence number; **Type:** string **Supported Values:** all, sequence .. _1699_mon-template_monitor-list_link-enable-cfg: mon-template_monitor-list_link-enable-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ena-sequence** **Description** Sequence number (Specify the sequence number) **Type:** number **Range:** 1-16 **enaeth** **Description** Specify the physical port number (Ethernet interface number) **Type:** number **Format:** interface **Range:** 5-103 .. _1699_mon-template_monitor-list_link-up-cfg: mon-template_monitor-list_link-up-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **link-up-sequence1** **Description** Sequence number (Specify the sequence number) **Type:** number **Range:** 1-16 **link-up-sequence2** **Description** Sequence number (Specify the sequence number) **Type:** number **Range:** 1-16 **link-up-sequence3** **Description** Sequence number (Specify the sequece number) **Type:** number **Range:** 1-16 **linkup-ethernet1** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **Range:** 5-103 **linkup-ethernet2** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **Range:** 5-103 **linkup-ethernet3** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **Range:** 5-103 .. _1699_mon-template_monitor-list_link-down-cfg: mon-template_monitor-list_link-down-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **link-down-sequence1** **Description** Sequence number (Specify the sequence number) **Type:** number **Range:** 1-16 **link-down-sequence2** **Description** Sequence number (Specify the seqeuence number) **Type:** number **Range:** 1-16 **link-down-sequence3** **Description** Sequence number (Specify the sequence number) **Type:** number **Range:** 1-16 **linkdown-ethernet1** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **Range:** 5-103 **linkdown-ethernet2** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **Range:** 5-103 **linkdown-ethernet3** **Description** Specify the port physical port number (Ethernet interface number) **Type:** number **Format:** interface **Range:** 5-103 .. _1699_mon-template_monitor-list_link-disable-cfg: mon-template_monitor-list_link-disable-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dis-sequence** **Description** Sequence number (Specify the sequence number) **Type:** number **Range:** 1-16 **diseth** **Description** Specify the physical port number (Ethernet interface number) **Type:** number **Format:** interface **Range:** 5-103 .. _1699_geoloc: geoloc ^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_geoloc_sampling-enable: geoloc_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'place-holder': place-holder; **Type:** string **Supported Values:** all, place-holder .. _1699_upgrade-status: upgrade-status ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_icmp6: icmp6 ^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1699_icmp6_sampling-enable: icmp6_sampling-enable ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'in_msgs': In messages; 'in_errors': In Errors; 'in_dest_un_reach': In Destunation Unreachable; 'in_pkt_too_big': In Packet too big; 'in_time_exceeds': In TTL Exceeds; 'in_param_prob': In Parameter Problem; 'in_echoes': In Echo requests; 'in_exho_reply': In Echo replies; 'in_grp_mem_query': In Group member query; 'in_grp_mem_resp': In Group member reply; 'in_grp_mem_reduction': In Group member reduction; 'in_router_sol': In Router solicitation; 'in_ra': In Router advertisement; 'in_ns': In neighbor solicitation; 'in_na': In neighbor advertisement; 'in_redirect': In Redirects; 'out_msg': Out Messages; 'out_dst_un_reach': Out Destination Unreachable; 'out_pkt_too_big': Out Packet too big; 'out_time_exceeds': Out TTL Exceeds; 'out_param_prob': Out Parameter Problem; 'out_echo_req': Out Echo requests; 'out_echo_replies': Out Echo replies; 'out_rs': Out Router solicitation; 'out_ra': Out Router advertisement; 'out_ns': Out neighbor solicitation; 'out_na': Out neighbor advertisement; 'out_redirects': Out Redirects; 'out_mem_resp': Out Group member reply; 'out_mem_reductions': Out Group member reduction; 'err_rs': Error Router solicitation; 'err_ra': Error Router advertisement; 'err_ns': Error Neighbor solicitation; 'err_na': Error Neighbor advertisement; 'err_redirects': Error Redirects; 'err_echoes': Error Echo requests; 'err_echo_replies': Error Echo replies; **Type:** string **Supported Values:** all, in_msgs, in_errors, in_dest_un_reach, in_pkt_too_big, in_time_exceeds, in_param_prob, in_echoes, in_exho_reply, in_grp_mem_query, in_grp_mem_resp, in_grp_mem_reduction, in_router_sol, in_ra, in_ns, in_na, in_redirect, out_msg, out_dst_un_reach, out_pkt_too_big, out_time_exceeds, out_param_prob, out_echo_req, out_echo_replies, out_rs, out_ra, out_ns, out_na, out_redirects, out_mem_resp, out_mem_reductions, err_rs, err_ra, err_ns, err_na, err_redirects, err_echoes, err_echo_replies .. _1699_platformtype: platformtype ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters