.. _slb_template_dns: slb template dns ================ DNS template dns Specification ----------------- ===================================== ================================================================ **Parameter** **Value** ===================================== ================================================================ **Type** *Collection* **Object Key(s)** *name* **Collection Name** :ref:`2986_dns_list` **Collection URI** /axapi/v3/slb/template/dns **Element Name** dns **Element URI** /axapi/v3/slb/template/dns/{name} **Element Attributes** dns_attributes **Partition Visibility** shared **Schema** :download:`dns schema ` ===================================== ================================================================ **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/slb/template/dns .. raw:: html :ref:`2986_dns_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/slb/template/dns .. raw:: html :ref:`2986_dns_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/slb/template/dns/{name} .. raw:: html :ref:`2986_dns_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/slb/template/dns .. raw:: html :ref:`2986_dns_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/slb/template/dns/{name} .. raw:: html :ref:`2986_dns_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/slb/template/dns/{name} .. raw:: html :ref:`2986_dns_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/slb/template/dns .. raw:: html :ref:`2986_dns_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/slb/template/dns/{name} .. raw:: html :ref:`2986_dns_attributes` .. raw:: html
.. _2986_dns_list: dns-list -------- dns-list is **JSON List** of :ref:`2986_dns_attributes` dns-list : [ { :ref:`2986_dns_attributes` }, { :ref:`2986_dns_attributes` }, ... ] .. _2986_dns_attributes: dns attributes -------------- **add-padding-to-client** **Description** 'block-length': Block-Length Padding; 'random-block-length': Random-Block-Length Padding; **Type:** string **Supported Values:** block-length, random-block-length **cache-record-serving-policy** **Description** 'global': Follow global cofiguration (Default); 'no-change': No change in record order; 'round-robin': Round-robin; **Type:** string **Supported Values:** global, no-change, round-robin **cache-ttl-adjustment-enable** **Description** enable the ttl adjustment for dns cache response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **class-list** **Description:** class-list is a **JSON Block**. Please see below for :ref:`2986_class-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/class-list ` **default-policy** **Description** 'nocache': Cache disable; 'cache': Cache enable; **Type:** string **Supported Values:** nocache, cache **Default:** nocache **disable-dns-template** **Description** Disable DNS template **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-ra-cached-resp** **Description** Disable DNS recursive available flag in cached response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-rpz-attach-soa** **Description** Disable attaching SOA due to RPZ **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-logging** **Description** dns logging template (DNS Logging template name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/template/dns-logging ` **dns64** **Description:** dns64 is a **JSON Block**. Please see below for :ref:`2986_dns64` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/dns64 ` **dnssec-service-group** **Description** Use different service group if DNSSEC DO bit set (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **drop** **Description** Drop the malformed query **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** drop and forward are mutually exclusive **enable-cache-sharing** **Description** Enable DNS cache sharing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **forward** **Description** Forward to service group (Service group name) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** forward and drop are mutually exclusive **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **insert-ipv4** **Description** prefix-length to insert for IPv4 **Type:** number **Range:** 0-32 **insert-ipv6** **Description** prefix-length to insert for IPv6 **Type:** number **Range:** 0-128 **local-dns-resolution** **Description:** local-dns-resolution is a **JSON Block**. Please see below for :ref:`2986_local-dns-resolution` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/local-dns-resolution ` **max-cache-entry-size** **Description** Define maximum cache entry size (Maximum cache entry size per VIP (default 1024)) **Type:** number **Range:** 1-4096 **Default:** 1024 **max-cache-size** **Description** Define maximum cache size (Maximum cache entry per VIP) **Type:** number **max-query-length** **Description** Define Maximum DNS Query Length, default is unlimited (Specify Maximum Length) **Type:** number **Range:** 1-4095 **name** **Description** DNS Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **negative-dns-cache** **Description:** negative-dns-cache is a **JSON Block**. Please see below for :ref:`2986_negative-dns-cache` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/negative-dns-cache ` **period** **Description** Period in minutes **Type:** number **Range:** 1-10000 **query-class-filter** **Description:** query-class-filter is a **JSON Block**. Please see below for :ref:`2986_query-class-filter` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/query-class-filter ` **query-id-switch** **Description** Use DNS query ID to create sesion **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **query-type-filter** **Description:** query-type-filter is a **JSON Block**. Please see below for :ref:`2986_query-type-filter` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/query-type-filter ` **recursive-dns-resolution** **Description:** recursive-dns-resolution is a **JSON Block**. Please see below for :ref:`2986_recursive-dns-resolution` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution ` **redirect-to-tcp-port** **Description** Direct the client to retry with TCP for DNS UDP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **remove-aa-flag** **Description** Make answers created from cache non-authoritative **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **remove-csubnet** **Description** Remove EDNS(0) client subnet from client queries **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **remove-padding-to-server** **Description** Remove EDNS(0) padding to server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **response-rate-limiting** **Description:** response-rate-limiting is a **JSON Block**. Please see below for :ref:`2986_response-rate-limiting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/response-rate-limiting ` **rpz-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/rpz/{seq-id} ` **udp-retransmit** **Description:** udp-retransmit is a **JSON Block**. Please see below for :ref:`2986_udp-retransmit` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/udp-retransmit ` **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_response-rate-limiting: response-rate-limiting ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **TC-rate** **Description** Every n'th response that would be rate-limited will respond with TC bit **Type:** number **Range:** 2-10 **Mutual Exclusion:** TC-rate and slip-rate are mutually exclusive **action** **Description** 'log-only': Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; 'rate-limit': Rate-Limit based on configuration (Default); 'whitelist': Whitelist, disable rate-limiting; **Type:** string **Supported Values:** log-only, rate-limit, whitelist **Default:** rate-limit **enable-log** **Description** Enable logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **filter-response-rate** **Description** Maximum allowed request rate for the filter. This should match average traffic. (default 10 per seconds) **Type:** number **Range:** 1-1000 **Default:** 10 **match-subnet** **Description** IP subnet mask (response rate by IP subnet mask) **Type:** string **Format:** ipv4-netmask **Default:** 255.255.255.255 **match-subnet-v6** **Description** IPV6 subnet mask (response rate by IPv6 subnet mask) **Type:** number **Range:** 1-128 **Default:** 128 **response-rate** **Description** Responses exceeding this rate within the window will be dropped (default 5 per second) **Type:** number **Range:** 1-1000 **Default:** 5 **rrl-class-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name} ` **slip-rate** **Description** Every n'th response that would be rate-limited will be let through instead **Type:** number **Range:** 2-10 **Mutual Exclusion:** slip-rate and TC-rate are mutually exclusive **src-ip-only** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **window** **Description** Rate-Limiting Interval in Seconds (default is one) **Type:** number **Range:** 1-60 **Default:** 1 .. _2986_response-rate-limiting_rrl-class-list-list: response-rate-limiting_rrl-class-list-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **lid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name}/lid/{lidnum} ` **name** **Description** Class-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_response-rate-limiting_rrl-class-list-list_lid-list: response-rate-limiting_rrl-class-list-list_lid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **lid-action** **Description** 'log-only': Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; 'rate-limit': Rate-Limit based on configuration (Default); 'whitelist': Whitelist, disable rate-limiting; **Type:** string **Supported Values:** log-only, rate-limit, whitelist **Default:** rate-limit **lid-enable-log** **Description** Enable logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **lid-match-subnet** **Description** IP subnet mask (response rate by IP subnet mask) **Type:** string **Format:** ipv4-netmask **Default:** 255.255.255.255 **lid-match-subnet-v6** **Description** IPV6 subnet mask (response rate by IPv6 subnet mask) **Type:** number **Range:** 1-128 **Default:** 128 **lid-response-rate** **Description** Responses exceeding this rate within the window will be dropped (default 5 per second) **Type:** number **Range:** 1-1000 **Default:** 5 **lid-slip-rate** **Description** Every n'th response that would be rate-limited will be let through instead **Type:** number **Range:** 2-10 **Mutual Exclusion:** lid-slip-rate and lid-tc-rate are mutually exclusive **lid-src-ip-only** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **lid-tc-rate** **Description** Every n'th response that would be rate-limited will respond with TC bit **Type:** number **Range:** 2-10 **Mutual Exclusion:** lid-tc-rate and lid-slip-rate are mutually exclusive **lid-window** **Description** Rate-Limiting Interval in Seconds (default is one) **Type:** number **Range:** 1-60 **Default:** 1 **lidnum** **Description** Specify a limit ID **Type:** number **Range:** 1-1023 **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_rpz-list: rpz-list ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **logging** **Description:** logging is a **JSON Block**. Please see below for :ref:`2986_rpz-list_logging` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/rpz/{seq-id}/logging ` **name** **Description** Specify a Response Policy Zone name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **seq-id** **Description** sequential id of RPZ **Type:** number **Range:** 1-8 **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_rpz-list_logging: rpz-list_logging ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Log RPZ triggered action **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rpz-action** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_rpz-list_logging_rpz-action: rpz-list_logging_rpz-action ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **str-rpz-action** **Description** 'drop': Log RPZ due to drop action; 'pass-thru': Log RPZ due to pass-thru action; 'nxdomain': Log RPZ due to nxdomain action; 'nodata': Log RPZ due to nodata action; 'tcp-only': Log RPZ due to tcp-only action; 'local-data': Log RPZ due to local-data action; **Type:** string **Supported Values:** drop, pass-thru, nxdomain, nodata, tcp-only, local-data .. _2986_recursive-dns-resolution: recursive-dns-resolution ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **csubnet-retry** **Description** retry when server REFUSED AX inserted EDNS(0) subnet, works only when insert-client-subnet is configured **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **default-recursive** **Description** Default recursive mode, forward query to bound service-group if hostnames matched **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dnssec-validation** **Description** 'enabled': Enable DNSSEC validation; 'disabled': Disable DNSSEC validation; **Type:** string **Supported Values:** enabled, disabled **Default:** disabled **fast-ns-selection** **Description** 'enabled': Enable fast NS selection; 'disabled': Disable fast NS selection; **Type:** string **Supported Values:** enabled, disabled **Default:** enabled **force-cname-resolution** **Description** 'enabled': Force CNAME resolution always; 'disabled': Use answer record in CNAME response if it exists, else resolve; **Type:** string **Supported Values:** enabled, disabled **Default:** enabled **full-response** **Description** Serve all records (authority and additional) when applicable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **gateway-health-check** **Description:** gateway-health-check is a **JSON Block**. Please see below for :ref:`2986_recursive-dns-resolution_gateway-health-check` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check ` **host-list-cfg** **Type:** List **ipv4-nat-pool** **Description** IPv4 Source NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/ip/nat/pool ` **ipv6-nat-pool** **Description** IPv6 Source NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool ` **lookup-order** **Description:** lookup-order is a **JSON Block**. Please see below for :ref:`2986_recursive-dns-resolution_lookup-order` **Type:** Object **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/lookup-order ` **max-trials** **Description** Total number of times to try DNS query to server before closing client connection, default 255 **Type:** number **Range:** 1-255 **Default:** 255 **ns-cache-lookup** **Description** 'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; **Type:** string **Supported Values:** disabled, enabled **Default:** enabled **request-for-pending-resolution** **Description** 'drop': Drop of the request during ongoing; 'respond-with-servfail': Respond with SERVFAIL of the request during ongoing; 'start-new-resolution': Start new resolution of the request during ongoing; **Type:** string **Supported Values:** drop, respond-with-servfail, start-new-resolution **Default:** respond-with-servfail **retries-per-level** **Description** Number of DNS query retries at each server level before closing client connection, default 6 **Type:** number **Range:** 1-6 **Default:** 6 **udp-initial-interval** **Description** UDP DNS Retry Interval value 1-6, default is 5 sec (1-6, default is 5sec) **Type:** number **Range:** 1-6 **Default:** 5 **udp-retry-interval** **Description** UDP DNS Retry Interval value 1-6, default is 1 sec (1-6 , default is 1 sec) **Type:** number **Range:** 1-6 **Default:** 1 **use-client-qid** **Description** Use client side query id for recursive query **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-service-group-response** **Description** 'disabled': Start Recursive Resolver if Server response doesnt have final answer; 'enabled': Forward Backend Server response to client and dont start recursive resolver; **Type:** string **Supported Values:** disabled, enabled **Default:** enabled **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_recursive-dns-resolution_lookup-order: recursive-dns-resolution_lookup-order ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **query-type** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_recursive-dns-resolution_lookup-order_query-type: recursive-dns-resolution_lookup-order_query-type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **num-query-type** **Description** Other query type value **Type:** number **Range:** 1-65535 **order** **Description** 'ipv4-precede-ipv6': Recursive lookup via IPv4 then IPv6; 'ipv6-precede-ipv4': Recursive lookup via IPv6 then IPv4; **Type:** string **Supported Values:** ipv4-precede-ipv6, ipv6-precede-ipv4 **str-query-type** **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 'ANY': All cached record; **Type:** string **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT, ANY .. _2986_recursive-dns-resolution_gateway-health-check: recursive-dns-resolution_gateway-health-check ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **gwhc-ns-cache-lookup** **Description** 'disabled': Disable NS Cache Lookup; 'enabled': Enable NS Cache Lookup; **Type:** string **Supported Values:** disabled, enabled **Default:** disabled **interval** **Description** Specify the health check interval, default is 10 sec (Interval value, in seconds (default 10)) **Type:** number **Range:** 1-300 **Default:** 10 **num-query-type** **Description** Other record type value **Type:** number **Range:** 1-65535 **Mutual Exclusion:** num-query-type and str-query-type are mutually exclusive **query-name** **Description** Specify the query name used in probe queries, default "a10networks.com" **Type:** string **Maximum Length:** 255 characters **Maximum Length:** 1 characters **Default:** a10networks.com **retry** **Description** Maximum number of DNS query retries at each server level before health check fails, default 6 (Retry count (default 6)) **Type:** number **Range:** 1-6 **Default:** 6 **retry-multi** **Description** Specify number of times that health check consecutively fails before declaring gateway DOWN, default 1 (retry-multi count (default 1)) **Type:** number **Range:** 1-10 **Default:** 1 **str-query-type** **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; **Type:** string **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT **Default:** A **Mutual Exclusion:** str-query-type and num-query-type are mutually exclusive **timeout** **Description** Specify the health check timeout before retrying or finish, default is 5 sec (Timeout value, in seconds (default 5)) **Type:** number **Range:** 1-6 **Default:** 5 **up-retry** **Description** Specify number of times that health check consecutively passes before declaring gateway UP, default 1 (up-retry count (default 1)) **Type:** number **Range:** 1-10 **Default:** 1 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_recursive-dns-resolution_host-list-cfg: recursive-dns-resolution_host-list-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hostnames** **Description** Hostnames class-list name (dns type), perform resolution while query name matched **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _2986_class-list: class-list ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **lid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/slb/template/dns/{name}/class-list/lid/{lidnum} ` **name** **Description** Specify a class list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_class-list_lid-list: class-list_lid-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action-value** **Description** 'dns-cache-disable': Disable DNS cache when it exceeds limit; 'dns-cache-enable': Enable DNS cache when it exceeds limit; 'forward': Forward the traffic even it exceeds limit; **Type:** string **Supported Values:** dns-cache-disable, dns-cache-enable, forward **conn-rate-limit** **Description** Connection rate limit **Type:** number **Range:** 1-2147483647 **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`2986_class-list_lid-list_dns` **Type:** Object **lidnum** **Description** Specify a limit ID **Type:** number **Range:** 1-1023 **lockout** **Description** Don't accept any new connection for certain time (Lockout duration in minutes) **Type:** number **Range:** 1-1023 **log** **Description** Log a message **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-interval** **Description** Log interval (minute, by default system will log every over limit instance) **Type:** number **Range:** 1-255 **over-limit-action** **Description** Action when exceeds limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **per** **Description** Per (Number of 100ms) **Type:** number **Range:** 1-65535 **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_class-list_lid-list_dns: class-list_lid-list_dns ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cache-action** **Description** 'cache-disable': Disable dns cache; 'cache-enable': Enable dns cache; **Type:** string **Supported Values:** cache-disable, cache-enable **Default:** cache-disable **honor-server-response-ttl** **Description** Honor the server reponse TTL **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ttl** **Description** TTL for cache entry (TTL in seconds) **Type:** number **Range:** 1-65535 **weight** **Description** Weight for cache entry **Type:** number **Range:** 1-7 .. _2986_dns64: dns64 ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cache** **Description** Use a cached A-query response to provide AAAA query responses for the same hostname **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **change-query** **Description** Always change incoming AAAA DNS Query to A **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enable DNS64 (Need to config this option before config any other dns64 options) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **parallel-query** **Description** Forward AAAA Query & generate A Query in parallel **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **retry** **Description** Retry count, default is 3 (Retry Number) **Type:** number **Range:** 0-15 **Default:** 3 **single-response-disable** **Description** Disable Single Response which is used to avoid ambiguity **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timeout** **Description** Timeout to send additional Queries, unit: second, default is 1 **Type:** number **Range:** 0-15 **Default:** 1 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_udp-retransmit: udp-retransmit ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **max-trials** **Description** Total number of times to try DNS query to server before closing client connection, default 3 **Type:** number **Range:** 1-5 **Default:** 3 **retry-interval** **Description** DNS Retry Interval value 1 - 400 in units of 100ms, default is 10 (default is 1000ms) (1 - 400 in units of 100ms, default is 10 (1000ms/1sec)) **Type:** number **Range:** 1-400 **Default:** 10 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_query-class-filter: query-class-filter ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **query-class** **Type:** List **query-class-action** **Description** 'allow': Allow only certain DNS query classes; 'deny': Deny only certain DNS query classes; **Type:** string **Supported Values:** allow, deny **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_query-class-filter_query-class: query-class-filter_query-class ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **num-query-class** **Description** Other query class value **Type:** number **Range:** 1-65535 **str-query-class** **Description** 'INTERNET': INTERNET query class; 'CHAOS': CHAOS query class; 'HESIOD': HESIOD query class; 'NONE': NONE query class; 'ANY': ANY query class; **Type:** string **Supported Values:** INTERNET, CHAOS, HESIOD, NONE, ANY .. _2986_local-dns-resolution: local-dns-resolution ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **host-list-cfg** **Type:** List **local-resolver-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_local-dns-resolution_host-list-cfg: local-dns-resolution_host-list-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hostnames** **Description** Hostnames class-list name (dns type) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` .. _2986_local-dns-resolution_local-resolver-cfg: local-dns-resolution_local-resolver-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **local-resolver** **Description** Local dns servers (address) **Type:** string **Format:** ipv4-address .. _2986_negative-dns-cache: negative-dns-cache ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bypass-query-threshold** **Description** the threshold bypass the query, default is 100 **Type:** number **Range:** 1-65535 **Default:** 100 **enable-negative-dns-cache** **Description** Enable DNS negative cache (Need to turn-on the dns-cache for this feature) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-negative-cache-ttl** **Description** Max negative cache ttl, default is 2 hours **Type:** number **Range:** 0-604800 **Default:** 7200 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_query-type-filter: query-type-filter ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **query-type** **Type:** List **query-type-action** **Description** 'allow': Allow only certain DNS query types; 'deny': Deny only certain DNS query types; **Type:** string **Supported Values:** allow, deny **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2986_query-type-filter_query-type: query-type-filter_query-type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **num-query-type** **Description** Other record type value **Type:** number **Range:** 1-65535 **str-query-type** **Description** 'A': Address record; 'AAAA': IPv6 Address record; 'CNAME': Canonical name record; 'MX': Mail exchange record; 'NS': Name server record; 'SRV': Service locator; 'PTR': PTR resource record; 'SOA': Start of authority record; 'TXT': Text record; 'ANY': All cached record; **Type:** string **Supported Values:** A, AAAA, CNAME, MX, NS, SRV, PTR, SOA, TXT, ANY