slb template dns recursive-dns-resolution gateway-health-check¶

Enable health check to recursive gateway based on current configuration

gateway-health-check Specification¶

Parameter Value

Type Configuration Resource

Element Name gateway-health-check

Element URI /axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check

Element Attributes gateway-health-check_attributes

Partition Visibility shared

Schema gateway-health-check schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check	gateway-health-check attributes
POST /axapi/v3/slb/template/dns/a/recursive-dns-resolution/gateway-health-check Payload: { "gateway-health-check": { "query-name": "a" } }
Get Object	GET	/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check	gateway-health-check attributes
GET /axapi/v3/slb/template/dns/a/recursive-dns-resolution/gateway-health-check Reponse: { "gateway-health-check": { "query-name": "a", "retry": 6, "timeout": 5, "interval": 10, "up-retry": 1, "retry-multi": 1, "gwhc-ns-cache-lookup": "disabled", "str-query-type": "A", "uuid": "61029792-5073-11ee-98ee-fbe362803b33", "a10-url": "/axapi/v3/slb/template/dns/a/recursive-dns-resolution/gateway-health-check" } }
Modify Object	POST	/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check	gateway-health-check attributes
Replace Object	PUT	/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check	gateway-health-check attributes
PUT /axapi/v3/slb/template/dns/a/recursive-dns-resolution/gateway-health-check Payload: { "gateway-health-check": { "query-name": "abcd" } }
Delete Object	DELETE	/axapi/v3/slb/template/dns/{name}/recursive-dns-resolution/gateway-health-check	gateway-health-check attributes
DELETE /axapi/v3/slb/template/dns/a/recursive-dns-resolution/gateway-health-check Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

gateway-health-check attributes¶

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