.. _system: system ====== Configure System Parameters system Specification -------------------- ===================================== =============================================== **Parameter** **Value** ===================================== =============================================== **Type** *Configuration Resource* **Element Name** system **Element URI** /axapi/v3/system **Element Attributes** system_attributes **Partition Visibility** None **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:`1213_system_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/system .. raw:: html :ref:`1213_system_attributes` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/system .. raw:: html :ref:`1213_system_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/system .. raw:: html :ref:`1213_system_attributes` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/system .. raw:: html :ref:`1213_system_attributes` .. raw:: html
.. _1213_system_attributes: system attributes ----------------- **add-cpu-core** **Description:** add-cpu-core is a **JSON Block**. Please see below for :ref:`1213_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:`1213_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:`1213_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 **anomaly-log-rate-limit** **Description** Anomaly log rate-limit per second, default 32 **Type:** number **Range:** 1-100 **asic-mmu-fail-safe** **Description:** asic-mmu-fail-safe is a **JSON Block**. Please see below for :ref:`1213_asic-mmu-fail-safe` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/asic-mmu-fail-safe ` **attack-log** **Description** log attack anomalies **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bandwidth** **Description:** bandwidth is a **JSON Block**. Please see below for :ref:`1213_bandwidth` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/bandwidth ` **bfd** **Description:** bfd is a **JSON Block**. Please see below for :ref:`1213_bfd` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/bfd ` **control-cpu** **Description:** control-cpu is a **JSON Block**. Please see below for :ref:`1213_control-cpu` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/control-cpu ` **core** **Description:** core is a **JSON Block**. Please see below for :ref:`1213_core` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/core ` **cosq-show** **Description:** cosq-show is a **JSON Block**. Please see below for :ref:`1213_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:`1213_cosq-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cosq-stats ` **cpu-hyper-thread** **Description:** cpu-hyper-thread is a **JSON Block**. Please see below for :ref:`1213_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:`1213_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:`1213_cpu-load-sharing` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/cpu-load-sharing ` **data-cpu** **Description:** data-cpu is a **JSON Block**. Please see below for :ref:`1213_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 **default-mtu** **Description** Set all interfaces default mtu (Interface MTU, default 1 (System jumbo needs to be enabled)) **Type:** number **del-port** **Description:** del-port is a **JSON Block**. Please see below for :ref:`1213_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:`1213_delete-cpu-core` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/delete-cpu-core ` **environment** **Description:** environment is a **JSON Block**. Please see below for :ref:`1213_environment` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/environment ` **ext-only-logging** **Description:** ext-only-logging is a **JSON Block**. Please see below for :ref:`1213_ext-only-logging` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ext-only-logging ` **fpga-drop-counter** **Description:** fpga-drop-counter is a **JSON Block**. Please see below for :ref:`1213_fpga-drop-counter` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/fpga-drop-counter ` **geo-location** **Description:** geo-location is a **JSON Block**. Please see below for :ref:`1213_geo-location` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/geo-location ` **geoloc** **Description:** geoloc is a **JSON Block**. Please see below for :ref:`1213_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:`1213_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:`1213_geolocation-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/geolocation-file ` **glid** **Description** Apply limits to the whole system **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/glid ` **hardware** **Description:** hardware is a **JSON Block**. Please see below for :ref:`1213_hardware` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/hardware ` **hardware-forward** **Description:** hardware-forward is a **JSON Block**. Please see below for :ref:`1213_hardware-forward` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/hardware-forward ` **hw-blocking-enable** **Description** Enable system hardware blocking (default disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`1213_icmp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/icmp ` **icmp-rate** **Description:** icmp-rate is a **JSON Block**. Please see below for :ref:`1213_icmp-rate` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/icmp-rate ` **icmp6** **Description:** icmp6 is a **JSON Block**. Please see below for :ref:`1213_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:`1213_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:`1213_inuse-port-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/inuse-port-list ` **ip-stats** **Description:** ip-stats is a **JSON Block**. Please see below for :ref:`1213_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:`1213_ip6-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ip6-stats ` **ipsec** **Description:** ipsec is a **JSON Block**. Please see below for :ref:`1213_ipsec` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ipsec ` **link-capability** **Description:** link-capability is a **JSON Block**. Please see below for :ref:`1213_link-capability` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/link-capability ` **memory** **Description:** memory is a **JSON Block**. Please see below for :ref:`1213_memory` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/memory ` **mgmt-port** **Description:** mgmt-port is a **JSON Block**. Please see below for :ref:`1213_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:`1213_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 **multi-queue-support** **Description:** multi-queue-support is a **JSON Block**. Please see below for :ref:`1213_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:`1213_ndisc-ra` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ndisc-ra ` **per-vlan-limit** **Description:** per-vlan-limit is a **JSON Block**. Please see below for :ref:`1213_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:`1213_platformtype` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/platformtype ` **poll-model** **Description:** poll-model is a **JSON Block**. Please see below for :ref:`1213_poll-model` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/poll-model ` **port-info** **Description:** port-info is a **JSON Block**. Please see below for :ref:`1213_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:`1213_port-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/port-list ` **promiscuous-mode** **Description** Run in promiscous mode settings **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **reboot** **Description:** reboot is a **JSON Block**. Please see below for :ref:`1213_reboot` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/reboot ` **resource-usage** **Description:** resource-usage is a **JSON Block**. Please see below for :ref:`1213_resource-usage` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/resource-usage ` **session** **Description:** session is a **JSON Block**. Please see below for :ref:`1213_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:`1213_session-reclaim-limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/session-reclaim-limit ` **shm-logging** **Description:** shm-logging is a **JSON Block**. Please see below for :ref:`1213_shm-logging` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/shm-logging ` **shutdown** **Description:** shutdown is a **JSON Block**. Please see below for :ref:`1213_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:`1213_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:`1213_spe-status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/spe-status ` **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`1213_tcp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/tcp ` **tcp-stats** **Description:** tcp-stats is a **JSON Block**. Please see below for :ref:`1213_tcp-stats` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/tcp-stats ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1213_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/template ` **timeout-value** **Description:** timeout-value is a **JSON Block**. Please see below for :ref:`1213_timeout-value` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/timeout-value ` **trunk** **Description:** trunk is a **JSON Block**. Please see below for :ref:`1213_trunk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/trunk ` **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:`1213_ve-mac-scheme` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/ve-mac-scheme ` **xaui-dlb-mode** **Description:** xaui-dlb-mode is a **JSON Block**. Please see below for :ref:`1213_xaui-dlb-mode` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/xaui-dlb-mode ` .. _1213_shm-logging: shm-logging ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_poll-model: poll-model ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable Polling Model in both Pri and Sec **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pri** **Description** Primary image **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sec** **Description** Secondary image **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1213_port-list: port-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_mgmt-port: mgmt-port ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **port-index** **Description** port index to be configured (Specify port index) **Type:** number **Range:** 0-32 .. _1213_geolocation-file: geolocation-file ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **error-info** **Description:** error-info is a **JSON Block**. Please see below for :ref:`1213_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 .. _1213_geolocation-file_error-info: geolocation-file_error-info ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_per-vlan-limit: per-vlan-limit ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bcast** **Description** broadcast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 1000 **ipmcast** **Description** IP multicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 1000 **mcast** **Description** multicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 1000 **unknown-ucast** **Description** unknown unicast packets (per second limit) **Type:** number **Range:** 1-1000000 **Default:** 1000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_icmp: icmp ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_inuse-port-list: inuse-port-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_control-cpu: control-cpu ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_tcp: tcp ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_bandwidth: bandwidth ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_session: session ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_link-capability: link-capability ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Enable/Disable link capabilities **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_modify-port: modify-port ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **port-index** **Description** port index to be configured (Specify port index) **Type:** number **Range:** 0-32 **port-number** **Description** port number to be configured (Specify port number) **Type:** number **Range:** 1-32 .. _1213_shutdown: shutdown ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_all-vlan-limit: all-vlan-limit ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bcast** **Description** broadcast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 5000 **ipmcast** **Description** IP multicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 5000 **mcast** **Description** multicast packets (per second limit) **Type:** number **Range:** 1-65535 **Default:** 5000 **unknown-ucast** **Description** unknown unicast packets (per second limit) **Type:** number **Range:** 1-1200000 **Default:** 5000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_del-port: del-port ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **port-index** **Description** port index to be configured (Specify port index) **Type:** number **Range:** 0-32 .. _1213_ndisc-ra: ndisc-ra ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_session-reclaim-limit: session-reclaim-limit ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **nscan-limit** **Description** smp session scan limit (number of smp sessions per scan) **Type:** number **Range:** 1-20480 **Default:** 1024 **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 .. _1213_inuse-cpu-list: inuse-cpu-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_add-port: add-port ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **port-index** **Description** port index to be configured (Specify port index) **Type:** number **Range:** 0-32 .. _1213_ip6-stats: ip6-stats ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_asic-mmu-fail-safe: asic-mmu-fail-safe ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **monitor-disable** **Description** Enable Fail-safe software error monitoring and act on it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **monitor-interval** **Description** ASIC Fail-safe monitoring intervals in Seconds (Units of 1 Seconds (default 60)) **Type:** number **Range:** 5-300 **Default:** 60 **reboot-disable** **Description** Disable system reboot if system encounters mmu error **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **recovery-threshold** **Description** ASIC Fail-safe recovery threshold in Errors (Units of 1 Errors (default 2)) **Type:** number **Range:** 1-1000 **Default:** 2 **test-pattern-type** **Description** 'all-zeros': Inject all bits 0s in a byte; 'all-ones': Inject all bits 1s in a byte; 'lcb': Logical checker board; 'inverse-lcb': Inverse Logical checker board; **Type:** string **Supported Values:** all-zeros, all-ones, lcb, inverse-lcb **Default:** lcb **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_bfd: bfd ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_reboot: reboot ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_ip-stats: ip-stats ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_environment: environment ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_cosq-show: cosq-show ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_cpu-list: cpu-list ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_geo-location: geo-location ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **entry-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/system/geo-location/entry/{geo-locn-obj-name} ` **geo-location-geolite2-asn** **Description** Load built-in Maxmind GeoLite2-ASN database. Database available from http://www.maxmind.com **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geo-location-geolite2-city** **Description** Load built-in Maxmind GeoLite2-City database. Database available from http://www.maxmind.com **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geo-location-geolite2-country** **Description** Load built-in Maxmind GeoLite2-Country database. Database available from http://www.maxmind.com **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geo-location-iana** **Description** Load built-in IANA Database **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geolite2-asn-include-ipv6** **Description** Include IPv6 address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geolite2-city-include-ipv6** **Description** Include IPv6 address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geolite2-country-include-ipv6** **Description** Include IPv6 address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geoloc-load-file-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_geo-location_entry-list: geo-location_entry-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1213_geo-location_entry-list_geo-locn-multiple-addresses: geo-location_entry-list_geo-locn-multiple-addresses ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **first-ip-address** **Description** Specify IP information (Specify IP address) **Type:** string **Format:** ipv4-address **first-ipv6-address** **Description** Specify IPv6 address **Type:** string **Format:** ipv6-address **geol-ipv4-mask** **Description** Specify IPv4 mask **Type:** string **Format:** ipv4-netmask **Mutual Exclusion:** geol-ipv4-mask and ip-addr2 are mutually exclusive **geol-ipv6-mask** **Description** Specify IPv6 mask **Type:** number **Range:** 0-128 **Mutual Exclusion:** geol-ipv6-mask and ipv6-addr2 are mutually exclusive **ip-addr2** **Description** Specify IP address range **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ip-addr2 and geol-ipv4-mask are mutually exclusive **ipv6-addr2** **Description** Specify IPv6 address range **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ipv6-addr2 and geol-ipv6-mask are mutually exclusive .. _1213_geo-location_geoloc-load-file-list: geo-location_geoloc-load-file-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **geo-location-load-file-include-ipv6** **Description** Include IPv6 address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geo-location-load-filename** **Description** Specify file to be loaded **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _1213_template: template ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **monitor-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_template_monitor-cfg: template_monitor-cfg ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **template-monitor** **Description** Apply monitor template to the whole system (Monitor template ID Number) **Type:** number **Range:** 1-16 .. _1213_port-info: port-info ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_ipsec: ipsec ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **crypto-core** **Description** Crypto cores assigned for IPsec processing **Type:** number **Range:** 0-56 **Default:** 0 **crypto-mem** **Description** Crypto memory percentage assigned for IPsec processing **Type:** number **Range:** 0-100 **Default:** 0 **packet-round-robin** **Description** Enable packet round robin for IPsec packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_cpu-hyper-thread: cpu-hyper-thread ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable CPU Hyperthreading **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enable CPU Hyperthreading **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1213_memory: memory ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_data-cpu: data-cpu ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_geoloc-list-list: geoloc-list-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **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 .. _1213_geoloc-list-list_include-geoloc-name-list: geoloc-list-list_include-geoloc-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **include-geoloc-name-val** **Description** Geolocation name to add **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _1213_geoloc-list-list_exclude-geoloc-name-list: geoloc-list-list_exclude-geoloc-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exclude-geoloc-name-val** **Description** Geolocation name to exclude **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _1213_ve-mac-scheme: ve-mac-scheme ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve-mac-scheme-val** **Description** 'hash-based': Hash-based using the VE number; 'round-robin': Round Robin scheme; 'system-mac': Use system MAC address; **Type:** string **Supported Values:** hash-based, round-robin, system-mac **Default:** hash-based .. _1213_fpga-drop-counter: fpga-drop-counter ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_multi-queue-support: multi-queue-support ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Enable Multi-Queue-Support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1213_icmp-rate: icmp-rate ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_spe-profile: spe-profile ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'ipv4-only': Enable IPv4 HW forward entries only; 'ipv6-only': Enable IPv6 HW forward entries only; 'ipv4-ipv6': Enable Both IPv4/IPv6 HW forward entries (shared); **Type:** string **Supported Values:** ipv4-only, ipv6-only, ipv4-ipv6 **Default:** ipv4-ipv6 .. _1213_hardware: hardware ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_add-cpu-core: add-cpu-core ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **core-index** **Description** core index to be added (Specify core index) **Type:** number **Range:** 0-128 .. _1213_trunk: trunk ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **load-balance** **Description:** load-balance is a **JSON Block**. Please see below for :ref:`1213_trunk_load-balance` **Type:** Object **Reference Object:** :doc:`/axapi/v3/system/trunk/load-balance ` .. _1213_trunk_load-balance: trunk_load-balance ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **use-l3** **Description** Layer-3 Header based load balancing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-l3 and use-l4 are mutually exclusive **use-l4** **Description** Layer-3/4 Header based load balancing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-l4 and use-l3 are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_core: core ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_resource-usage: resource-usage ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **class-list-ipv6-addr-count** **Description** Total IPv6 addresses for class-list **Type:** number **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_cpu-load-sharing: cpu-load-sharing ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cpu-usage** **Description:** cpu-usage is a **JSON Block**. Please see below for :ref:`1213_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:`1213_cpu-load-sharing_packets-per-second` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_cpu-load-sharing_packets-per-second: cpu-load-sharing_packets-per-second ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **min** **Description** Minimum packets-per-second threshold (per CPU) before redistribution will take effect (Minimum packets-per-second threshold (per CPU) before redistribution will take effect (default: 100000)) **Type:** number **Range:** 0-30000000 **Default:** 100000 .. _1213_cpu-load-sharing_cpu-usage: cpu-load-sharing_cpu-usage ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **high** **Description** CPU usage threshold (percentage) that will trigger the redistribution (default: 75) **Type:** number **Range:** 0-100 **Default:** 75 **low** **Description** CPU usage threshold (percentage) that will restore the normal packet distribution (default: 60) **Type:** number **Range:** 0-100 **Default:** 60 .. _1213_hardware-forward: hardware-forward ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_geoloc: geoloc ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_cosq-stats: cosq-stats ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_xaui-dlb-mode: xaui-dlb-mode ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Enable/Disable Dynamic Load Balancing traffic distribution support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_icmp6: icmp6 ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_delete-cpu-core: delete-cpu-core ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **core-index** **Description** core index to be deleted (Specify core index) **Type:** number **Range:** 0-128 .. _1213_geoloc-name-helper: geoloc-name-helper ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_ext-only-logging: ext-only-logging ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** enable external only logging for packet driven DDOS logs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_tcp-stats: tcp-stats ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_timeout-value: timeout-value ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ftp** **Description** set timeout to stop ftp transfer in seconds, 0 is no limit **Type:** number **Range:** 0-9999 **Default:** 120 **scp** **Description** set timeout to stop scp transfer in seconds, 0 is no limit **Type:** number **Range:** 0-9999 **Default:** 300 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_platformtype: platformtype ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1213_spe-status: spe-status ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters