.. _gslb: gslb ==== Global server load balance commands gslb Specification ------------------ ===================================== ============================================= **Parameter** **Value** ===================================== ============================================= **Type** *Intermediate Resource* **Element Name** gslb **Element URI** /axapi/v3/gslb **Element Attributes** gslb_attributes **Partition Visibility** shared **Schema** :download:`gslb schema ` ===================================== ============================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/gslb .. raw:: html gslb_attributes .. raw:: html
.. _1812_gslb_attributes: gslb attributes --------------- **active-rdt** **Description:** active-rdt is a **JSON Block**. Please see below for :ref:`1812_active-rdt` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/active-rdt ` **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`1812_dns` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/dns ` **geo-location-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/geo-location/{geo-locn-obj-name} ` **geoloc** **Description:** geoloc is a **JSON Block**. Please see below for :ref:`1812_geoloc` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/geoloc ` **geoloc-rdt** **Description:** geoloc-rdt is a **JSON Block**. Please see below for :ref:`1812_geoloc-rdt` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/geoloc-rdt ` **geolocation-file** **Description:** geolocation-file is a **JSON Block**. Please see below for :ref:`1812_geolocation-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/geolocation-file ` **group-info** **Description:** group-info is a **JSON Block**. Please see below for :ref:`1812_group-info` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/group-info ` **group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/group/{name} ` **ip-list-info** **Description:** ip-list-info is a **JSON Block**. Please see below for :ref:`1812_ip-list-info` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/ip-list-info ` **ip-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/ip-list/{gslb-ip-list-obj-name} ` **policy-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name} ` **protocol** **Description:** protocol is a **JSON Block**. Please see below for :ref:`1812_protocol` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/protocol ` **secure-attributes** **Description:** secure-attributes is a **JSON Block**. Please see below for :ref:`1812_secure-attributes` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/secure-attributes ` **service-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/service-group/{service-group-name} ` **service-ip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/service-ip/{node-name} ` **service-port** **Description:** service-port is a **JSON Block**. Please see below for :ref:`1812_service-port` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/service-port ` **site-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name} ` **statistics** **Description:** statistics is a **JSON Block**. Please see below for :ref:`1812_statistics` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/statistics ` **system** **Description:** system is a **JSON Block**. Please see below for :ref:`1812_system` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/system ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1812_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/template ` **zone-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name} ` .. _1812_geoloc-rdt: geoloc-rdt ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_statistics: statistics ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_protocol: protocol ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **auto-detect** **Description** Automatically detect SLB Config **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-new-gslb-sync** **Description** Disable new gslb config sync **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/protocol/enable/{type} ` **limit** **Description:** limit is a **JSON Block**. Please see below for :ref:`1812_protocol_limit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/protocol/limit ` **msg-format-acos-2x** **Description** Run GSLB Protocol in compatible mode with a ACOS 2.x GSLB peer **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ping-site** **Description** name of site or ip address to ping **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **secure** **Description:** secure is a **JSON Block**. Please see below for :ref:`1812_protocol_secure` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/protocol/secure ` **status-interval** **Description** Specify GSLB Message Protocol update period (The GSLB Protocol update interval (seconds), default is 30) **Type:** number **Range:** 1-1800 **use-mgmt-port** **Description** Use management port for connections in Shared Partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-mgmt-port and use-mgmt-port-for-all-partitions are mutually exclusive **use-mgmt-port-for-all-partitions** **Description** Use management port for connections in all L3v Partitions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-mgmt-port-for-all-partitions and use-mgmt-port are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_protocol_secure: protocol_secure ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'enable': Enable Secure; 'disable': Disable Secure (default); 'enable-fallback': Fall back to non-secure if fail; **Type:** string **Supported Values:** enable, disable, enable-fallback **Default:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_protocol_limit: protocol_limit ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ardt-query** **Description** Query Messages of Active RDT, default is 200 (Number) **Type:** number **Range:** 0-1000000 **Default:** 200 **ardt-response** **Description** Response Messages of Active RDT, default is 1000 (Number) **Type:** number **Range:** 0-1000000 **Default:** 1000 **ardt-session** **Description** Sessions of Active RDT, default is 32768 (Number) **Type:** number **Range:** 0-1000000 **Default:** 32768 **conn-response** **Description** Response Messages of Connection Load, default is no limit (Number) **Type:** number **Range:** 0-1000000 **Default:** 0 **message** **Description** Amount of Messages, default is 10000 (Number) **Type:** number **Range:** 0-1000000 **Default:** 10000 **response** **Description** Amount of Response Messages, default is 3600 (Number) **Type:** number **Range:** 0-1000000 **Default:** 3600 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_protocol_enable-list: protocol_enable-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **type** **Description** 'controller': Enable/Disable GSLB protocol as GSLB controller; 'device': Enable/Disable GSLB protocol as site device; **Type:** string **Supported Values:** controller, device **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_template: template ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **csv-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/template/csv/{csv-name} ` **snmp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/template/snmp/{snmp-name} ` .. _1812_template_snmp-list: template_snmp-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **auth-key** **Description** Specify authentication key (Specify key) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **auth-proto** **Description** 'sha': SHA; 'md5': MD5; **Type:** string **Supported Values:** sha, md5 **Default:** md5 **community** **Description** Specify community for version 2c (Community name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **context-engine-id** **Description** Specify context engine ID **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **context-name** **Description** Specify context name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **host** **Description** Specify host (Host name or ip address) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **interface** **Description** Specify Interface ID **Type:** number **Range:** 0-2147483647 **interval** **Description** Specify interval, default is 3 (Interval, unit: second, default is 3) **Type:** number **Range:** 1-999 **Default:** 3 **oid** **Description** Specify OID **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **port** **Description** Specify port, default is 161 (Port Number, default is 161) **Type:** number **Range:** 1-65535 **Default:** 161 **priv-key** **Description** Specify privacy key (Specify key) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **priv-proto** **Description** 'aes': AES; 'des': DES; **Type:** string **Supported Values:** aes, des **Default:** des **security-engine-id** **Description** Specify security engine ID **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **security-level** **Description** 'no-auth': No authentication; 'auth-no-priv': Authentication, but no privacy; 'auth-priv': Authentication and privacy; **Type:** string **Supported Values:** no-auth, auth-no-priv, auth-priv **Default:** no-auth **snmp-name** **Description** Specify name of snmp template **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **username** **Description** Specify username (User name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **version** **Description** 'v1': Version 1; 'v2c': Version 2c; 'v3': Version 3; **Type:** string **Supported Values:** v1, v2c, v3 **Default:** v3 .. _1812_template_csv-list: template_csv-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **csv-name** **Description** Specify name of csv template **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **delim-char** **Description** enter a delimiter character, default "," **Type:** string **Format:** string-rlx **Maximum Length:** 1 characters **Maximum Length:** 1 characters **Default:** , **Mutual Exclusion:** delim-char and delim-num are mutually exclusive **delim-num** **Description** enter a delimiter number, default 44 (",") **Type:** number **Range:** 0-255 **Default:** 44 **Mutual Exclusion:** delim-num and delim-char are mutually exclusive **ipv6-enable** **Description** Support IPv6 IP ranges **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **multiple-fields** **Type:** List **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_template_csv-list_multiple-fields: template_csv-list_multiple-fields ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **csv-type** **Description** 'ip-from': Beginning address of IP range or subnet; 'ip-to-mask': Ending address of IP range or Mask; 'continent': Continent; 'country': Country; 'state': State or province; 'city': City; **Type:** string **Supported Values:** ip-from, ip-to-mask, continent, country, state, city **field** **Description** Field index number (Index of Field) **Type:** number **Range:** 1-64 .. _1812_ip-list-info: ip-list-info ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_service-group-list: service-group-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dependency-site** **Description** Dependency on site **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** Disable all members **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-site-list** **Type:** List **member** **Type:** List **persistent-aging-time** **Description** Specify aging-time, unit: min, default is 5 (Aging time) **Type:** number **Range:** 1-65535 **Default:** 5 **persistent-ipv6-mask** **Description** Specify IPv6 mask length, default is 128 **Type:** number **Range:** 1-128 **Default:** 128 **persistent-mask** **Description** Specify IP mask, default is /32 **Type:** string **Format:** ipv4-netmask-brief **Default:** /32 **persistent-site** **Description** Persistent based on site **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-group-name** **Description** Specify Service Group name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_service-group-list_disable-site-list: service-group-list_disable-site-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **disable-site** **Description** Site name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/gslb/site ` .. _1812_service-group-list_member: service-group-list_member ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **member-name** **Description** Service name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _1812_service-port: service-port ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_system: system ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **age-interval** **Description** Interval to age runtime statistics. 0: never age, default is 10 (Time, unit: sec, default is 10) **Type:** number **Range:** 0-120 **Default:** 10 **geo-location-iana** **Description** Load built-in IANA table **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **gslb-group** **Description** GSLB Group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gslb-load-file-list** **Type:** List **gslb-service-ip** **Description** GSLB Service-IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gslb-site** **Description** GSLB Site **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hostname** **Description** System's Network Name **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-ttl** **Description** TTL of IP packets, default is 0 (IP TTL value, default is 0) **Type:** number **Range:** 0-255 **Default:** 0 **module** **Description** Specify Auto Map Module **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **slb-device** **Description** SLB Device **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **slb-server** **Description** SLB Server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **slb-virtual-server** **Description** SLB Virtual Server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ttl** **Description** Specify Auto Map TTL (TTL, default is 300) **Type:** number **Range:** 1-65535 **Default:** 300 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **wait** **Description** Disable GSLB until timeout if system is not ready (Time, unit: sec, default is 0) **Type:** number **Range:** 0-16384 **Default:** 0 .. _1812_system_gslb-load-file-list: system_gslb-load-file-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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/gslb/template/csv ` .. _1812_secure-attributes: secure-attributes ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'enable': Enable Secure; 'disable': Disable Secure; 'enable-fallback': Fall back to non-secure if fail; 'use-global-behavior': Follow global configuration under gslb protocol (default); **Type:** string **Supported Values:** enable, disable, enable-fallback, use-global-behavior **Default:** use-global-behavior **gslb-cert** **Description** Certificate for Secure GSLB (Certificate name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **gslb-key** **Description** Private Key for secure gslb signing (Key name) **Type:** string **Maximum Length:** 245 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_geo-location-list: geo-location-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 .. _1812_geo-location-list_geo-locn-multiple-addresses: geo-location-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 .. _1812_policy-list: policy-list ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **active-rdt** **Description:** active-rdt is a **JSON Block**. Please see below for :ref:`1812_policy-list_active-rdt` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name}/active-rdt ` **active-servers-enable** **Description** Enable Select Service-IP with the highest number of active servers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **active-servers-fail-break** **Description** Break when no active server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **admin-ip-enable** **Description** Enable admin ip **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **admin-ip-top-only** **Description** Return highest priority server only **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** admin-ip-top-only and ordered-ip-top-only are mutually exclusive **admin-preference** **Description** Select Service-IP for the device having maximum admin preference **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **alias-admin-preference** **Description** Select alias name having maximum admin preference **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **amount-first** **Description** Select record based on the amount of available service-ip **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **auto-map** **Description:** auto-map is a **JSON Block**. Please see below for :ref:`1812_policy-list_auto-map` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name}/auto-map ` **bw-cost-enable** **Description** Enable bw cost **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bw-cost-fail-break** **Description** Break when exceed limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **capacity** **Description:** capacity is a **JSON Block**. Please see below for :ref:`1812_policy-list_capacity` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name}/capacity ` **connection-load** **Description:** connection-load is a **JSON Block**. Please see below for :ref:`1812_policy-list_connection-load` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name}/connection-load ` **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`1812_policy-list_dns` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name}/dns ` **edns** **Description:** edns is a **JSON Block**. Please see below for :ref:`1812_policy-list_edns` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name}/edns ` **geo-location-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name}/geo-location/{name} ` **geo-location-match** **Description:** geo-location-match is a **JSON Block**. Please see below for :ref:`1812_policy-list_geo-location-match` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/policy/{name}/geo-location-match ` **geographic** **Description** Select Service-IP by geographic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **health-check** **Description** Select Service-IP by health status **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **health-check-preference-enable** **Description** Check health preference **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **health-preference-top** **Description** Only keep top n **Type:** number **Range:** 1-128 **ip-list** **Description** Specify IP List (IP List Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/gslb/ip-list ` **least-response** **Description** Least response selection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **metric-fail-break** **Description** Break if no valid Service-IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **metric-force-check** **Description** Always check Service-IP for all enabled metrics **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **metric-order** **Description** Specify order of metric **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **metric-type** **Description** **Type:** string **Format:** enum-list **name** **Description** Specify policy name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** default **num-session-enable** **Description** Enable Select Service-IP for device having maximum number of available sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **num-session-tolerance** **Description** The difference between the available sessions, default is 10 (Tolerance) **Type:** number **Range:** 0-100 **Default:** 10 **ordered-ip-top-only** **Description** Return highest priority server only **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** ordered-ip-top-only and admin-ip-top-only are mutually exclusive **round-robin** **Description** Round robin selection, enabled by default **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **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 **weighted-alias** **Description** Select alias name by weighted preference **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weighted-ip-enable** **Description** Enable Select Service-IP by weighted preference **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weighted-ip-total-hits** **Description** Weighted by total hits **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weighted-site-enable** **Description** Enable Select Service-IP by weighted site preference **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **weighted-site-total-hits** **Description** Weighted by total hits **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1812_policy-list_auto-map: policy-list_auto-map ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** All modules **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** all and module-type are mutually exclusive **module-disable** **Description** Specify Disable Auto Map Module **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **module-type** **Description** **Type:** string **Format:** enum-list **Mutual Exclusion:** module-type and all are mutually exclusive **ttl** **Description** Specify Auto Map TTL (TTL, default is 300) **Type:** number **Range:** 1-65535 **Default:** 300 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_policy-list_edns: policy-list_edns ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **client-subnet-geographic** **Description** Use client subnet for geo-location **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 .. _1812_policy-list_active-rdt: policy-list_active-rdt ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **controller** **Description** Active round-delay-time by controller **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **difference** **Description** The difference between the round-delay-time, default is 0 **Type:** number **Range:** 0-16383 **Default:** 0 **enable** **Description** Enable the active rdt **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fail-break** **Description** Break when no valid RDT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ignore-id** **Description** Ignore IP Address specified in IP List by ID **Type:** number **Range:** 0-31 **keep-tracking** **Description** Keep tracking client even round-delay-time samples are ready **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **limit** **Description** Limit of allowed RDT, default is 16383 (Limit, unit: millisecond) **Type:** number **Range:** 1-16383 **Default:** 16383 **proto-rdt-enable** **Description** Enable the round-delay-time to the controller **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **samples** **Description** Specify samples number for round-delay-time (Number of samples,default is 5) **Type:** number **Range:** 1-8 **Default:** 5 **single-shot** **Description** Single Shot RDT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **skip** **Description** Skip query if round-delay-time samples are not ready (Specify maximum skip count,default is 3) **Type:** number **Range:** 1-31 **Default:** 3 **timeout** **Description** Specify timeout if round-delay-time samples are not ready (Specify timeout, unit:sec,default is 3) **Type:** number **Range:** 1-255 **Default:** 3 **tolerance** **Description** The difference percentage between the round-delay-time, default is 10 (Tolerance) **Type:** number **Range:** 0-100 **Default:** 10 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_policy-list_capacity: policy-list_capacity ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **capacity-enable** **Description** Enable capacity **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **capacity-fail-break** **Description** Break when exceed threshold **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **threshold** **Description** Specify capacity threshold, default is 90 **Type:** number **Range:** 0-100 **Default:** 90 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_policy-list_geo-location-match: policy-list_geo-location-match ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **geo-type-overlap** **Description** 'global': Global Geo-location; 'policy': Policy Geo-location; **Type:** string **Supported Values:** global, policy **match-first** **Description** 'global': Global Geo-location; 'policy': Policy Geo-location; **Type:** string **Supported Values:** global, policy **Default:** global **overlap** **Description** Enable overlap mode to do longest match **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 .. _1812_policy-list_dns: policy-list_dns ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** Apply DNS action for service **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **action-type** **Description** 'drop': Drop query; 'reject': Send refuse response; 'ignore': Send empty response; **Type:** string **Supported Values:** drop, reject, ignore **active-only** **Description** Only keep active servers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **active-only-fail-safe** **Description** Continue if no candidate **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **aging-time** **Description** Specify aging-time, default is TTL in DNS record, unit: second (Aging time, default 0 means using TTL in DNS record as aging time) **Type:** number **Range:** 0-1000000000 **Default:** 0 **backup-alias** **Description** Return alias name when fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **backup-server** **Description** Return fallback server when fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **block-action** **Description** Specify Action **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **block-type** **Description** **Type:** string **Format:** enum-list **block-value** **Type:** List **cache** **Description** Cache DNS Server response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cname-detect** **Description** Apply GSLB for DNS Server response when service is Canonical Name (CNAME) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **delegation** **Description** Zone Delegation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-addition-mx** **Description** Append MX Records in Addition Section **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-auto-map** **Description** Automatically build DNS Infrastructure **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamic-preference** **Description** Make dynamically change the preference **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamic-weight** **Description** dynamically change the weight **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **external-ip** **Description** Return DNS response with external IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **external-soa** **Description** Return DNS response with external SOA Record **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geoloc-action** **Description** Apply DNS action by geo-location **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geoloc-alias** **Description** Return alias name by geo-location **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geoloc-policy** **Description** Apply different policy by geo-location **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hint** **Description** 'none': None; 'answer': Append Hint Records in DNS Answer Section; 'addition': Append Hint Records in DNS Addition Section; **Type:** string **Supported Values:** none, answer, addition **Default:** addition **ip-replace** **Description** Replace DNS Server Response with GSLB Service-IPs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6** **Type:** List **logging** **Description** 'none': None; 'query': DNS Query; 'response': DNS Response; 'both': Both DNS Query and Response; **Type:** string **Supported Values:** none, query, response, both **proxy-block-port-range-list** **Type:** List **selected-only** **Description** Only keep selected servers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **selected-only-value** **Description** Answer Number **Type:** number **Range:** 1-128 **server** **Description** Run GSLB as DNS server mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-addition-mx** **Description** Append MX Records in Addition Section **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-any** **Description** Provide All Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** server-any and server-any-with-metric are mutually exclusive **server-any-with-metric** **Description** Provide All Records with GSLB Metrics applied to A/AAAA Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** server-any-with-metric and server-any are mutually exclusive **server-authoritative** **Description** As authoritative server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-auto-ns** **Description** Provide A-Records for NS-Records automatically **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-auto-ptr** **Description** Provide PTR Records automatically **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-caa** **Description** Provide CAA Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-cname** **Description** Provide CNAME Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-custom** **Description** Provide Custom Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-full-list** **Description** Append All A Records in Authoritative Section **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-mode-only** **Description** Only run GSLB as DNS server mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** server-mode-only and zone-owner-mode are mutually exclusive **server-mx** **Description** Provide MX Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-naptr** **Description** Provide NAPTR Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-ns** **Description** Provide NS Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-ns-list** **Description** Append All NS Records in Authoritative Section **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-ptr** **Description** Provide PTR Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-sec** **Description** Provide DNSSEC support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-srv** **Description** Provide SRV Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server-txt** **Description** Provide TXT Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sticky** **Description** Make DNS Record sticky for certain time **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sticky-aging-time** **Description** Specify aging-time, unit: min, default is 5 (Aging time) **Type:** number **Range:** 1-65535 **Default:** 5 **sticky-ipv6-mask** **Description** Specify IPv6 mask length, default is 128 **Type:** number **Range:** 1-128 **Default:** 128 **sticky-mask** **Description** Specify IP mask, default is /32 **Type:** string **Format:** ipv4-netmask-brief **Default:** /32 **template** **Description** Logging template (Logging Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/logging ` **ttl** **Description** Specify the TTL value contained in DNS record (TTL value, unit: second, default is 10) **Type:** number **Range:** 0-1000000000 **Default:** 10 **Mutual Exclusion:** ttl and use-server-ttl are mutually exclusive **use-server-ttl** **Description** Use DNS Server Response TTL value in GSLB Proxy mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-server-ttl and ttl are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **zone-owner-mode** **Description** Only run GSLB as DNS server mode with zone ownership **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** zone-owner-mode and server-mode-only are mutually exclusive .. _1812_policy-list_dns_block-value: policy-list_dns_block-value ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **block-value** **Description** Specify Type Number **Type:** number **Range:** 1-255 .. _1812_policy-list_dns_ipv6: policy-list_dns_ipv6 ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dns-ipv6-mapping-type** **Description** 'addition': Append Mapped Record in DNS Addition Section; 'answer': Append Mapped Record in DNS Answer Section; 'exclusive': Only return AAAA Record; 'replace': Replace Record with Mapped Record; **Type:** string **Supported Values:** addition, answer, exclusive, replace **dns-ipv6-option** **Description** 'mix': Return both AAAA Record and A Record; 'smart': Return AAAA Record by DNS Query Type; 'mapping': Map A Record to AAAA Record; **Type:** string **Supported Values:** mix, smart, mapping .. _1812_policy-list_dns_proxy-block-port-range-list: policy-list_dns_proxy-block-port-range-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **proxy-block-range-from** **Description** Specify Type Range (From) **Type:** number **proxy-block-range-to** **Description** To **Type:** number .. _1812_policy-list_geo-location-list: policy-list_geo-location-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-multiple-fields** **Type:** List **ipv6-multiple-fields** **Type:** List **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 .. _1812_policy-list_geo-location-list_ip-multiple-fields: policy-list_geo-location-list_ip-multiple-fields ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-addr2-sub** **Description** Specify IP address range **Type:** string **Format:** ipv4-address **ip-mask-sub** **Description** Specify IP/mask format (Specify IP address mask) **Type:** string **Format:** ipv4-netmask-brief **ip-sub** **Description** Specify IP information **Type:** string **Format:** ipv4-address .. _1812_policy-list_geo-location-list_ipv6-multiple-fields: policy-list_geo-location-list_ipv6-multiple-fields ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-addr2-sub** **Description** Specify IPv6 address range **Type:** string **Format:** ipv6-address **ipv6-mask-sub** **Description** Specify IPv6/mask format (Specify IP address mask) **Type:** number **Range:** 0-128 **ipv6-sub** **Description** Specify IPv6 information **Type:** string **Format:** ipv6-address .. _1812_policy-list_connection-load: policy-list_connection-load ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **connection-load-enable** **Description** Enable connection-load **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connection-load-fail-break** **Description** Break when exceed limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connection-load-interval** **Description** Interval between two samples, Unit: second (Interval value,default is 5) **Type:** number **Range:** 1-60 **Default:** 5 **connection-load-limit** **Description** The value of the connection-load limit, default is unlimited **Type:** number **Range:** 1-999999999 **connection-load-samples** **Description** Specify samples for connection-load (Number of samples used to calculate the connection load, default is 5) **Type:** number **Range:** 1-8 **Default:** 5 **limit** **Description** Limit of maxinum connection load, default is unlimited **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 .. _1812_geoloc: geoloc ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_site-list: site-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **active-rdt** **Description:** active-rdt is a **JSON Block**. Please see below for :ref:`1812_site-list_active-rdt` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/active-rdt ` **auto-map** **Description** Enable DNS Auto Mapping **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **bw-cost** **Description** Specify cost of band-width **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **controller** **Description** Specify the local controller for the GSLB site (Specify the hostname of the local controller) **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **disable** **Description** Disable all servers in the GSLB site **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **easy-rdt** **Description:** easy-rdt is a **JSON Block**. Please see below for :ref:`1812_site-list_easy-rdt` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/easy-rdt ` **ip-server-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/ip-server/{ip-server-name} ` **limit** **Description** Specify the limit for bandwidth, default is unlimited **Type:** number **Range:** 0-2147483647 **multiple-geo-locations** **Type:** List **proto-aging-fast** **Description** Fast GSLB Protocol aging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **proto-aging-time** **Description** Specify GSLB Protocol aging time **Type:** number **Range:** 0-65535 **Default:** 0 **site-name** **Description** Specify GSLB site name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **slb-dev-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name} ` **template** **Description** Specify template to collect site information (Specify GSLB SNMP template name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/gslb/template/snmp ` **threshold** **Description** Specify the threshold for limit **Type:** number **Range:** 0-100 **Default:** 0 **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **weight** **Description** Specify a weight for the GSLB site (Weight, default is 1) **Type:** number **Range:** 1-100 **Default:** 1 .. _1812_site-list_ip-server-list: site-list_ip-server-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-server-name** **Description** Specify the real server name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_site-list_slb-dev-list: site-list_slb-dev-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **admin-preference** **Description** Specify administrative preference (Specify admin-preference value,default is 100) **Type:** number **Range:** 0-255 **Default:** 100 **auto-detect** **Description** 'ip': Service IP only; 'port': Service Port only; 'ip-and-port': Both service IP and service port; 'disabled': disable auto-detect; **Type:** string **Supported Values:** ip, port, ip-and-port, disabled **Default:** ip-and-port **auto-map** **Description** Enable DNS Auto Mapping **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **client-ip** **Description** Specify client IP address **Type:** string **Format:** ipv4-address **dev-resolve-as** **Description** 'resolve-to-ipv4': Use A Query only to resolve FQDN (Default Query type); 'resolve-to-ipv6': Use AAAA Query only to resolve FQDN; 'resolve-to-ipv4-and-ipv6': Use A as well as AAAA Query to resolve FQDN; **Type:** string **Supported Values:** resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6 **Default:** resolve-to-ipv4 **device-name** **Description** Specify SLB device name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **domain** **Description** Device hostname **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** domain, ip-address, and ipv6-address are mutually exclusive **gateway-ip-addr** **Description** IP address **Type:** string **Format:** ipv4-address **health-check-action** **Description** 'health-check': Enable health Check; 'health-check-disable': Disable health check; **Type:** string **Supported Values:** health-check, health-check-disable **Default:** health-check **ip-address** **Description** IP address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ip-address and domain are mutually exclusive **ipv6-address** **Description** IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ipv6-address and domain are mutually exclusive **max-client** **Description** Specify maximum number of clients, default is 32768 **Type:** number **Range:** 1-2147483647 **Default:** 32768 **msg-format-acos-2x** **Description** Run GSLB Protocol in compatible mode with a ACOS 2.x GSLB peer **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **probe-timer** **Description** **Type:** number **Range:** 1-255 **proto-aging-fast** **Description** Fast GSLB Protocol aging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **proto-aging-time** **Description** Specify GSLB Protocol aging time, default is 60 **Type:** number **Range:** 1-65535 **Default:** 60 **proto-compatible** **Description** Run GSLB Protocol in compatible mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rdt-type** **Description** 'rdt': rdt; 'site-rdt': site-rdt; **Type:** string **Supported Values:** rdt, site-rdt **rdt-value** **Description** Specify Round-delay-time **Type:** number **Range:** 1-65535 **session-number** **Description** **Type:** number **Range:** 0-16777214 **session-utilization** **Description** **Type:** number **Range:** 1-100 **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 **vip-server** **Description:** vip-server is a **JSON Block**. Please see below for :ref:`1812_site-list_slb-dev-list_vip-server` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server ` .. _1812_site-list_slb-dev-list_vip-server: site-list_slb-dev-list_vip-server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **vip-server-name-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-name/{vip-name} ` **vip-server-v4-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-v4/{ipv4} ` **vip-server-v6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-v6/{ipv6} ` .. _1812_site-list_slb-dev-list_vip-server_vip-server-v4-list: site-list_slb-dev-list_vip-server_vip-server-v4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4** **Description** Specify IP address **Type:** string **Format:** ipv4-address **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_site-list_slb-dev-list_vip-server_vip-server-v4-list_sampling-enable: site-list_slb-dev-list_vip-server_vip-server-v4-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'dev_vip_hits': Number of times the service-ip was selected; **Type:** string **Supported Values:** all, dev_vip_hits, dev_vip_recent .. _1812_site-list_slb-dev-list_vip-server_vip-server-v6-list: site-list_slb-dev-list_vip-server_vip-server-v6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6** **Description** Specify IP address (IPv6 address) **Type:** string **Format:** ipv6-address **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_site-list_slb-dev-list_vip-server_vip-server-v6-list_sampling-enable: site-list_slb-dev-list_vip-server_vip-server-v6-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'dev_vip_hits': Number of times the service-ip was selected; **Type:** string **Supported Values:** all, dev_vip_hits, dev_vip_recent .. _1812_site-list_slb-dev-list_vip-server_vip-server-name-list: site-list_slb-dev-list_vip-server_vip-server-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-name** **Description** Specify a VIP name for the SLB device **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/gslb/service-ip ` .. _1812_site-list_slb-dev-list_vip-server_vip-server-name-list_sampling-enable: site-list_slb-dev-list_vip-server_vip-server-name-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'dev_vip_hits': Number of times the service-ip was selected; **Type:** string **Supported Values:** all, dev_vip_hits, dev_vip_recent .. _1812_site-list_multiple-geo-locations: site-list_multiple-geo-locations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **geo-location** **Description** Specify the geographic location of the GSLB site (Specify geo-location for this site) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _1812_site-list_easy-rdt: site-list_easy-rdt ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **aging-time** **Description** Aging Time, Unit: min, default is 10 **Type:** number **Range:** 1-15360 **Default:** 10 **bind-geoloc** **Description** Bind RDT to geo-location **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ignore-count** **Description** Ignore count if RDT is out of range, default is 5 **Type:** number **Range:** 0-15 **Default:** 5 **ipv6-mask** **Description** Client IPv6 subnet mask, default is 128 **Type:** number **Range:** 1-128 **Default:** 128 **limit** **Description** Limit of valid RDT, default is 16383 (Limit, unit: millisecond) **Type:** number **Range:** 1-16383 **Default:** 16383 **mask** **Description** Client IP subnet mask, default is 32 **Type:** string **Format:** ipv4-netmask-brief **Default:** /32 **overlap** **Description** Enable overlap for geo-location to do longest match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **range-factor** **Description** Factor of RDT Range, default is 25 (Range Factor of Smooth RDT) **Type:** number **Range:** 0-1000 **Default:** 25 **smooth-factor** **Description** Factor of Smooth RDT, default is 10 **Type:** number **Range:** 0-100 **Default:** 10 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_site-list_active-rdt: site-list_active-rdt ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **aging-time** **Description** Aging Time, Unit: min, default is 10 **Type:** number **Range:** 1-15360 **Default:** 10 **bind-geoloc** **Description** Bind RDT to geo-location **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ignore-count** **Description** Ignore count if RDT is out of range, default is 5 **Type:** number **Range:** 0-15 **Default:** 5 **ipv6-mask** **Description** Client IPv6 subnet mask, default is 128 **Type:** number **Range:** 1-128 **Default:** 128 **limit** **Description** Limit of valid RDT, default is 16383 (Limit, unit: millisecond) **Type:** number **Range:** 1-16383 **Default:** 16383 **mask** **Description** Client IP subnet mask, default is 32 **Type:** string **Format:** ipv4-netmask-brief **Default:** /32 **overlap** **Description** Enable overlap for geo-location to do longest match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **range-factor** **Description** Factor of RDT Range, default is 25 (Range Factor of Smooth RDT) **Type:** number **Range:** 0-1000 **Default:** 25 **smooth-factor** **Description** Factor of Smooth RDT, default is 10 **Type:** number **Range:** 0-100 **Default:** 10 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_ip-list-list: ip-list-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **gslb-ip-list-addr-list** **Type:** List **gslb-ip-list-filename** **Description** Load IP List file (IP List filename) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **gslb-ip-list-obj-name** **Description** Specify IP List name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_ip-list-list_gslb-ip-list-addr-list: ip-list-list_gslb-ip-list-addr-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **id** **Description** ID Number **Type:** number **Range:** 0-31 **ip** **Description** Specify IP address **Type:** string **Format:** ipv4-address **ip-mask** **Description** IP mask **Type:** string **Format:** ipv4-netmask .. _1812_dns: dns ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'none': No action (default); 'drop': Drop query; 'reject': Send refuse response; 'ignore': Send empty response; **Type:** string **Supported Values:** none, drop, reject, ignore **Default:** none **logging** **Description** 'none': No logging (default); 'query': DNS Query; 'response': DNS Response; 'both': Both DNS Query and Response; **Type:** string **Supported Values:** none, query, response, both **Default:** none **sampling-enable** **Type:** List **template** **Description** Logging template (Logging Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/logging ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_dns_sampling-enable: dns_sampling-enable ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'total-query': Total number of DNS queries received; 'total-response': Total number of DNS replies sent to clients; 'bad-packet-query': Number of queries with incorrect data length; 'bad-packet-response': Number of replies with incorrect data length; 'bad-header-query': Number of queries with incorrect header; 'bad-header-response': Number of replies with incorrect header; 'bad-format-query': Number of queries with incorrect format; 'bad-format-response': Number of replies with incorrect format; 'bad-service-query': Number of queries with unknown service; 'bad-service-response': Number of replies with unknown service; 'bad-class-query': Number of queries with incorrect class; 'bad-class-response': Number of replies with incorrect class; 'bad-type-query': Number of queries with incorrect type; 'bad-type-response': Number of replies with incorrect type; 'no_answer': Number of replies with unknown server IP; 'metric_health_check': Metric Health Check Hit; 'metric_weighted_ip': Metric Weighted IP Hit; 'metric_weighted_site': Metric Weighted Site Hit; 'metric_capacity': Metric Capacity Hit; 'metric_active_server': Metric Active Server Hit; 'metric_easy_rdt': Metric Easy RDT Hit; 'metric_active_rdt': Metric Active RDT Hit; 'metric_geographic': Metric Geographic Hit; 'metric_connection_load': Metric Connection Load Hit; 'metric_number_of_sessions': Metric Number of Sessions Hit; 'metric_active_weight': Metric Active Weight Hit; 'metric_admin_preference': Metric Admin Preference Hit; 'metric_bandwidth_quality': Metric Bandwidth Quality Hit; 'metric_bandwidth_cost': Metric Bandwidth Cost Hit; 'metric_user': Metric User Hit; 'metric_least_reponse': Metric Least Reponse Hit; 'metric_admin_ip': Metric Admin IP Hit; 'metric_round_robin': Metric Round Robin Hit; **Type:** string **Supported Values:** all, total-query, total-response, bad-packet-query, bad-packet-response, bad-header-query, bad-header-response, bad-format-query, bad-format-response, bad-service-query, bad-service-response, bad-class-query, bad-class-response, bad-type-query, bad-type-response, no_answer, metric_health_check, metric_weighted_ip, metric_weighted_site, metric_capacity, metric_active_server, metric_easy_rdt, metric_active_rdt, metric_geographic, metric_connection_load, metric_number_of_sessions, metric_active_weight, metric_admin_preference, metric_bandwidth_quality, metric_bandwidth_cost, metric_user, metric_least_reponse, metric_admin_ip, metric_round_robin .. _1812_geolocation-file: geolocation-file ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_group-list: group-list ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **auto-map-learn** **Description** IP Address learned from other controller **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **auto-map-primary** **Description** Primary Controller's IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **auto-map-smart** **Description** Choose Best IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **config-anywhere** **Description** Every member can do config **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **config-merge** **Description** Merge old master's config when new one take over **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **config-save** **Description** Accept config-save message from master **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **data-interface** **Description** Data Interface IP Address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **dns-discover** **Description** Discover member via DNS Protocol **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **enable** **Description** Join GSLB Group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **learn** **Description** Learn neighbour information from other controllers **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **mgmt-interface** **Description** Management Interface IP Address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **name** **Description** Specify Group domain name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** default **primary-ipv6-list** **Type:** List **primary-list** **Type:** List **priority** **Description** Specify Local Priority, default is 100 **Type:** number **Range:** 1-255 **Default:** 100 **resolve-as** **Description** 'resolve-to-ipv4': Use A Query only to resolve FQDN (Default Query type); 'resolve-to-ipv6': Use AAAA Query only to resolve FQDN; 'resolve-to-ipv4-and-ipv6': Use A as well as AAAA Query to resolve FQDN; **Type:** string **Supported Values:** resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6 **Default:** resolve-to-ipv4 **standalone** **Description** Run GSLB Group in standalone mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **suffix** **Description** Set DNS Suffix (Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_group-list_primary-ipv6-list: group-list_primary-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **primary-ipv6** **Description** Specify Primary controller's IP address **Type:** string **Format:** ipv6-address .. _1812_group-list_primary-list: group-list_primary-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **primary** **Description** Specify Primary controller's IP address **Type:** string **Format:** ipv4-address .. _1812_zone-list: zone-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **disable** **Description** Disable all services in the GSLB zone **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-caa-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-caa-record/{critical-flag}+{property-tag}+{rdata} ` **dns-mx-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name} ` **dns-ns-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-ns-record/{ns-name} ` **dns-soa-record** **Description:** dns-soa-record is a **JSON Block**. Please see below for :ref:`1812_zone-list_dns-soa-record` **Type:** Object **name** **Description** Specify the name for the DNS zone **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **policy** **Description** Specify the policy for this zone (Specify policy name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** default **sampling-enable** **Type:** List **service-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name} ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1812_zone-list_template` **Type:** Object **ttl** **Description** Specify the zone ttl value (TTL value, unit: second, default is 10) **Type:** number **Range:** 0-1000000000 **Default:** 10 **Mutual Exclusion:** ttl and use-server-ttl are mutually exclusive **use-server-ttl** **Description** Use DNS Server Response TTL value in GSLB Proxy mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-server-ttl and ttl are mutually exclusive **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_dns-ns-record-list: zone-list_dns-ns-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ns-name** **Description** Specify Domain Name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_dns-ns-record-list_sampling-enable: zone-list_dns-ns-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the record has been used; **Type:** string **Supported Values:** all, hits .. _1812_zone-list_dns-caa-record-list: zone-list_dns-caa-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **critical-flag** **Description** Issuer Critical Flag **Type:** number **Range:** 0-255 **property-tag** **Description** Specify other property tags, only allowed lowercase alphanumeric **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **rdata** **Description** Specify the Issuer Domain Name or a URL **Type:** string **Format:** string-rlx **Maximum Length:** 1000 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_dns-caa-record-list_sampling-enable: zone-list_dns-caa-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the record has been used; **Type:** string **Supported Values:** all, hits .. _1812_zone-list_dns-mx-record-list: zone-list_dns-mx-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **mx-name** **Description** Specify Domain Name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **priority** **Description** Specify Priority **Type:** number **Range:** 0-65535 **sampling-enable** **Type:** List **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_dns-mx-record-list_sampling-enable: zone-list_dns-mx-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the record has been used; **Type:** string **Supported Values:** all, hits .. _1812_zone-list_sampling-enable: zone-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'received-query': Total Number of DNS queries received for the zone; 'sent-response': Total Number of DNS replies sent to clients for the zone; 'proxy-mode-response': Total Number of DNS replies sent to clients by the ACOS device as a DNS proxy for the zone; 'cache-mode-response': Total Number of cached DNS replies sent to clients by the ACOS device for the zone. (This statistic applies only if the DNS cac; 'server-mode-response': Total Number of DNS replies sent to clients by the ACOS device as a DNS server for the zone. (This statistic applies only if th; 'sticky-mode-response': Total Number of DNS replies sent to clients by the ACOS device to keep the clients on the same site. (This statistic applies on; 'backup-mode-response': Total Number of DNS replies sent to clients by the ACOS device in backup mode; **Type:** string **Supported Values:** all, received-query, sent-response, proxy-mode-response, cache-mode-response, server-mode-response, sticky-mode-response, backup-mode-response .. _1812_zone-list_template: zone-list_template ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dnssec** **Description** Specify DNSSEC template (Specify template name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _1812_zone-list_dns-soa-record: zone-list_dns-soa-record ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ex-expire** **Description** Specify Expire Time Interval, default is 1209600 **Type:** number **Range:** 0-2147483647 **Default:** 1209600 **ex-mail** **Description** Mailbox **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **ex-refresh** **Description** Specify Refresh Time Interval, default is 3600 **Type:** number **Range:** 0-2147483647 **Default:** 3600 **ex-retry** **Description** Specify Retry Time Interval, default is 900 **Type:** number **Range:** 0-2147483647 **Default:** 900 **ex-serial** **Description** Specify Serial Number, default is Current Time (Time Interval) **Type:** number **Range:** 0-2147483647 **ex-soa-ttl** **Description** Specify Negative caching TTL, default is Zone TTL **Type:** number **Range:** 0-2147483647 **expire** **Description** Specify Expire Time Interval, default is 1209600 **Type:** number **Range:** 0-2147483647 **Default:** 1209600 **external** **Description** Specify External SOA Record (DNS Server Name) **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **mail** **Description** Mailbox **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **refresh** **Description** Specify Refresh Time Interval, default is 3600 **Type:** number **Range:** 0-2147483647 **Default:** 3600 **retry** **Description** Specify Retry Time Interval, default is 900 **Type:** number **Range:** 0-2147483647 **Default:** 900 **serial** **Description** Specify Serial Number, default is Current Time (Time Interval) **Type:** number **Range:** 0-2147483647 **soa-name** **Description** DNS Server Name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **soa-ttl** **Description** Specify Negative caching TTL, default is Zone TTL **Type:** number **Range:** 0-2147483647 .. _1812_zone-list_service-list: zone-list_service-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'drop': Drop query; 'forward': Forward packet; 'ignore': Send empty response; 'reject': Send refuse response; **Type:** string **Supported Values:** drop, forward, ignore, reject **disable** **Description** Disable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-a-record** **Description:** dns-a-record is a **JSON Block**. Please see below for :ref:`1812_zone-list_service-list_dns-a-record` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record ` **dns-caa-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-caa-record/{critical-flag}+{property-tag}+{rdata} ` **dns-cname-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-cname-record/{alias-name} ` **dns-mx-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-mx-record/{mx-name} ` **dns-naptr-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-naptr-record/{naptr-target}+{service-proto}+{flag} ` **dns-ns-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-ns-record/{ns-name} ` **dns-ptr-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-ptr-record/{ptr-name} ` **dns-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-record/{type} ` **dns-srv-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-srv-record/{srv-name}+{port} ` **dns-txt-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-txt-record/{record-name} ` **forward-type** **Description** 'both': Forward both query and response; 'query': Forward query; 'response': Forward response; **Type:** string **Supported Values:** both, query, response **geo-location-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/geo-location/{geo-name} ` **health-check-gateway** **Description** 'enable': Enable Gateway Status Check; 'disable': Disable Gateway Status Check; **Type:** string **Supported Values:** enable, disable **Default:** enable **health-check-port** **Type:** List **policy** **Description** Specify policy for this service (Specify policy name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **service-name** **Description** Specify the service name for the zone, * for wildcard **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** **service-port** **Description** Port number of the service **Type:** number **Range:** 0-65534 **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-ptr-record-list: zone-list_service-list_dns-ptr-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ptr-name** **Description** Specify Domain Name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-ptr-record-list_sampling-enable: zone-list_service-list_dns-ptr-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the record has been used; **Type:** string **Supported Values:** all, hits .. _1812_zone-list_service-list_geo-location-list: zone-list_service-list_geo-location-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** Action for this geo-location **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** action and policy are mutually exclusive **action-type** **Description** 'allow': Allow query from this geo-location; 'drop': Drop query from this geo-location; 'forward': Forward packet for this geo-location; 'ignore': Send empty response to this geo-location; 'reject': Send refuse response to this geo-location; **Type:** string **Supported Values:** allow, drop, forward, ignore, reject **alias** **Type:** List **forward-type** **Description** 'both': Forward both query and response; 'query': Forward query from this geo-location; 'response': Forward response to this geo-location; **Type:** string **Supported Values:** both, query, response **geo-name** **Description** Specify the geo-location **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **policy** **Description** Policy for this geo-location (Specify the policy name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** policy and action are mutually exclusive **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_geo-location-list_alias: zone-list_service-list_geo-location-list_alias ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **alias** **Description** Send CNAME response for this geo-location (Specify a CNAME record) **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-cname-record-list: zone-list_service-list_dns-cname-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **admin-preference** **Description** Specify Administrative Preference, default is 100 **Type:** number **Range:** 0-255 **Default:** 100 **alias-name** **Description** Specify the alias name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **as-backup** **Description** As backup when fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **weight** **Description** Specify Weight, default is 1 **Type:** number **Range:** 1-100 **Default:** 1 .. _1812_zone-list_service-list_dns-cname-record-list_sampling-enable: zone-list_service-list_dns-cname-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'cname-hits': Number of times the CNAME has been used; **Type:** string **Supported Values:** all, cname-hits .. _1812_zone-list_service-list_dns-txt-record-list: zone-list_service-list_dns-txt-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **record-name** **Description** Specify the Object Name for TXT Data **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **Default:** 0 **txt-data** **Description** Specify TXT Data **Type:** string **Format:** string-rlx **Maximum Length:** 1000 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-txt-record-list_sampling-enable: zone-list_service-list_dns-txt-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the record has been used; **Type:** string **Supported Values:** all, hits .. _1812_zone-list_service-list_dns-naptr-record-list: zone-list_service-list_dns-naptr-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **flag** **Description** Specify the flag (e.g., a, s). Default is empty flag **Type:** string **Maximum Length:** 1 characters **Maximum Length:** 1 characters **Default:** **naptr-target** **Description** Specify the replacement or regular expression **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **order** **Description** Specify Order **Type:** number **Range:** 0-65535 **preference** **Description** Specify Preference **Type:** number **Range:** 0-65535 **regexp** **Description** Return the regular expression **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sampling-enable** **Type:** List **service-proto** **Description** Specify Service and Protocol **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-naptr-record-list_sampling-enable: zone-list_service-list_dns-naptr-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'naptr-hits': Number of times the NAPTR has been used; **Type:** string **Supported Values:** all, naptr-hits .. _1812_zone-list_service-list_health-check-port: zone-list_service-list_health-check-port ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **health-check-port** **Description** Check Related Port Status (Port Number) **Type:** number **Range:** 0-65534 .. _1812_zone-list_service-list_dns-record-list: zone-list_service-list_dns-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **data** **Description** Specify DNS Data **Type:** string **Format:** string-rlx **Maximum Length:** 512 characters **Maximum Length:** 1 characters **type** **Description** Specify DNS Type **Type:** number **Range:** 1-65535 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-a-record: zone-list_service-list_dns-a-record ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dns-a-record-ipv4-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-ipv4/{dns-a-record-ip} ` **dns-a-record-ipv6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-ipv6/{dns-a-record-ipv6} ` **dns-a-record-srv-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-srv/{svrname} ` .. _1812_zone-list_service-list_dns-a-record_dns-a-record-ipv6-list: zone-list_service-list_dns-a-record_dns-a-record-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **admin-ip** **Description** Specify admin priority of Service-IP (Specify the priority) **Type:** number **Range:** 1-255 **as-backup** **Description** As backup when fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **as-replace** **Description** Return this Service-IP when enable ip-replace **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** Disable this Service-IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-a-record-ipv6** **Description** IPV6 address **Type:** string **Format:** ipv6-address **no-resp** **Description** Don't use this Service-IP as DNS response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **static** **Description** Return this Service-IP in DNS server mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ttl** **Description** Specify TTL for Service-IP **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **weight** **Description** Specify weight for Service-IP (Weight value) **Type:** number **Range:** 1-100 .. _1812_zone-list_service-list_dns-a-record_dns-a-record-ipv4-list: zone-list_service-list_dns-a-record_dns-a-record-ipv4-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **admin-ip** **Description** Specify admin priority of Service-IP (Specify the priority) **Type:** number **Range:** 1-255 **as-backup** **Description** As backup when fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **as-replace** **Description** Return this Service-IP when enable ip-replace **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** Disable this Service-IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-a-record-ip** **Description** Specify IP address **Type:** string **Format:** ipv4-address **no-resp** **Description** Don't use this Service-IP as DNS response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **static** **Description** Return this Service-IP in DNS server mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ttl** **Description** Specify TTL for Service-IP **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **weight** **Description** Specify weight for Service-IP (Weight value) **Type:** number **Range:** 1-100 .. _1812_zone-list_service-list_dns-a-record_dns-a-record-srv-list: zone-list_service-list_dns-a-record_dns-a-record-srv-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **admin-ip** **Description** Specify admin priority of Service-IP (Specify the priority) **Type:** number **Range:** 1-255 **as-backup** **Description** As backup when fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **as-replace** **Description** Return this Service-IP when enable ip-replace **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** Disable this Service-IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no-resp** **Description** Don't use this Service-IP as DNS response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **static** **Description** Return this Service-IP in DNS server mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **svrname** **Description** Specify name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ttl** **Description** Specify TTL for Service-IP **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **weight** **Description** Specify weight for Service-IP (Weight value) **Type:** number **Range:** 1-100 .. _1812_zone-list_service-list_dns-ns-record-list: zone-list_service-list_dns-ns-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ns-name** **Description** Specify Domain Name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-ns-record-list_sampling-enable: zone-list_service-list_dns-ns-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the record has been used; **Type:** string **Supported Values:** all, hits .. _1812_zone-list_service-list_dns-caa-record-list: zone-list_service-list_dns-caa-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **critical-flag** **Description** Issuer Critical Flag **Type:** number **Range:** 0-255 **property-tag** **Description** Specify other property tags, only allowed lowercase alphanumeric **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **rdata** **Description** Specify the Issuer Domain Name or a URL **Type:** string **Format:** string-rlx **Maximum Length:** 1000 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-caa-record-list_sampling-enable: zone-list_service-list_dns-caa-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the CAA has been used; **Type:** string **Supported Values:** all, hits .. _1812_zone-list_service-list_dns-mx-record-list: zone-list_service-list_dns-mx-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **mx-name** **Description** Specify Domain Name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **priority** **Description** Specify Priority **Type:** number **Range:** 0-65535 **sampling-enable** **Type:** List **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_zone-list_service-list_dns-mx-record-list_sampling-enable: zone-list_service-list_dns-mx-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the record has been used; **Type:** string **Supported Values:** all, hits .. _1812_zone-list_service-list_sampling-enable: zone-list_service-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'received-query': Number of DNS queries received for the service; 'sent-response': Number of DNS replies sent to clients for the service; 'proxy-mode-response': Number of DNS replies sent to clients by the ACOS device as a DNS proxy for the service; 'cache-mode-response': Number of cached DNS replies sent to clients by the ACOS device for the service. (This statistic applies only if the DNS cache; 'server-mode-response': Number of DNS replies sent to clients by the ACOS device as a DNS server for the service. (This statistic applies only if the D; 'sticky-mode-response': Number of DNS replies sent to clients by the ACOS device to keep the clients on the same site. (This statistic applies only if; 'backup-mode-response': help Number of DNS replies sent to clients by the ACOS device in backup mode; **Type:** string **Supported Values:** all, received-query, sent-response, proxy-mode-response, cache-mode-response, server-mode-response, sticky-mode-response, backup-mode-response .. _1812_zone-list_service-list_dns-srv-record-list: zone-list_service-list_dns-srv-record-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Specify Port (Port Number) **Type:** number **Range:** 0-65534 **priority** **Description** Specify Priority **Type:** number **Range:** 0-65535 **sampling-enable** **Type:** List **srv-name** **Description** Specify Domain Name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **ttl** **Description** Specify TTL **Type:** number **Range:** 0-2147483647 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **weight** **Description** Specify Weight, default is 10 **Type:** number **Range:** 0-65535 **Default:** 10 .. _1812_zone-list_service-list_dns-srv-record-list_sampling-enable: zone-list_service-list_dns-srv-record-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the record has been used; **Type:** string **Supported Values:** all, hits .. _1812_group-info: group-info ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_active-rdt: active-rdt ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **domain** **Description** Specify Query Domain (Specify Domain Name) **Type:** string **Maximum Length:** 31 characters **Maximum Length:** 1 characters **icmp** **Description** Using ICMP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **interval** **Description** Specify Query Interval, unit: second, default is 1 **Type:** number **Range:** 1-16383 **Default:** 1 **port** **Description** Specify local port to send probe packet, default is 0 (no port) **Type:** number **Range:** 0-65535 **Default:** 0 **retry** **Description** Specify Retry Count, default is 3 **Type:** number **Range:** 0-16 **Default:** 3 **sleep** **Description** Specify Sleep Time when query fail, unit: second, default is 3 **Type:** number **Range:** 1-300 **Default:** 3 **timeout** **Description** Specify Query Timeout, unit: msec, default is 3000 **Type:** number **Range:** 1-16383 **Default:** 3000 **track** **Description** Specify Tracking Time, unit: second, default is 60 **Type:** number **Range:** 3-16383 **Default:** 60 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_service-ip-list: service-ip-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': Enable this GSLB server; 'disable': Disable this GSLB server; **Type:** string **Supported Values:** enable, disable **Default:** enable **external-ip** **Description** External IP address for NAT **Type:** string **Format:** ipv4-address **health-check** **Description** Health Check Monitor (Monitor Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable Health Check Monitor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive **health-check-protocol-disable** **Description** Disable GSLB Protocol Health Monitor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-address** **Description** IP address **Type:** string **Format:** ipv4-address **ipv6** **Description** IPv6 address Mapping (Applicable only when service-ip has an IPv4 Address) **Type:** string **Format:** ipv6-address **ipv6-address** **Description** IPV6 address **Type:** string **Format:** ipv6-address **node-name** **Description** Service-IP Name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/service-ip/{node-name}/port/{port-num}+{port-proto} ` **sampling-enable** **Type:** List **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_service-ip-list_port-list: service-ip-list_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': Enable this GSLB server port; 'disable': Disable this GSLB server port; **Type:** string **Supported Values:** enable, disable **Default:** enable **follow-port-protocol** **Description** 'tcp': TCP Port; 'udp': UDP Port; **Type:** string **Supported Values:** tcp, udp **health-check** **Description** Health Check Monitor (Monitor Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check, health-check-follow-port, and health-check-disable are mutually exclusive **Reference Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable Health Check Monitor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable, health-check, and health-check-follow-port are mutually exclusive **health-check-follow-port** **Description** Specify which port to follow for health status (Port Number) **Type:** number **Range:** 1-65534 **Mutual Exclusion:** health-check-follow-port, health-check, and health-check-disable are mutually exclusive **health-check-protocol-disable** **Description** Disable GSLB Protocol Health Monitor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **port-num** **Description** Port Number **Type:** number **Range:** 0-65534 **port-proto** **Description** 'tcp': TCP Port; 'udp': UDP Port; **Type:** string **Supported Values:** tcp, udp **sampling-enable** **Type:** List **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1812_service-ip-list_port-list_sampling-enable: service-ip-list_port-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'active': Active Servers; 'current': Current Connections; **Type:** string **Supported Values:** all, active, current .. _1812_service-ip-list_sampling-enable: service-ip-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'hits': Number of times the service IP has been selected; 'recent': Recent hits; **Type:** string **Supported Values:** all, hits, recent