health monitor method dns¶
DNS type
dns Specification¶
Type Configuration Resource Element Name dns Element URI /axapi/v3/health/monitor/{name}/method/dns Element Attributes dns_attributes Schema dns schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/health/monitor/{name}/method/dns | ||
Get Object | GET | /axapi/v3/health/monitor/{name}/method/dns | ||
Modify Object | POST | /axapi/v3/health/monitor/{name}/method/dns | ||
Replace Object | PUT | /axapi/v3/health/monitor/{name}/method/dns | ||
Delete Object | DELETE | /axapi/v3/health/monitor/{name}/method/dns |
dns attributes¶
dns
Description DNS type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns-domain
Description Specify fully qualified domain name of the host
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-domain and dns-ip-key are mutually exclusive
dns-domain-expect
Description: dns-domain-expect is a JSON Block. Please see below for dns-domain-expect
Type: Object
dns-domain-port
Description Specify DNS port, default is 53 (DNS Port(default 53))
Type: number
Range: 1-65534
Default: 53
dns-domain-recurse
Description ‘enabled’: Set the recursion bit; ‘disabled’: Clear the recursion bit;
Type: string
Supported Values: enabled, disabled
Default: enabled
dns-domain-tcp
Description Configure DNS transport over TCP, default is UDP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns-domain-type
Description ‘A’: Used for storing Ipv4 address (default); ‘CNAME’: Canonical name for a DNS alias; ‘SOA’: Start of authority; ‘PTR’: Domain name pointer; ‘MX’: Mail exchanger; ‘TXT’: Text string; ‘AAAA’: Used for storing Ipv6 128-bits address;
Type: string
Supported Values: A, CNAME, SOA, PTR, MX, TXT, AAAA
Default: A
dns-ip-key
Description Reverse DNS lookup (Specify IPv4 or IPv6 address)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: dns-ip-key and dns-domain are mutually exclusive
dns-ipv4-addr
Description Specify IPv4 address
Type: string
Format: ipv4-address
Mutual Exclusion: dns-ipv4-addr and dns-ipv6-addr are mutually exclusive
dns-ipv4-expect
Description: dns-ipv4-expect is a JSON Block. Please see below for dns-ipv4-expect
Type: Object
dns-ipv4-port
Description Specify DNS port, default is 53 (DNS Port(default 53))
Type: number
Range: 1-65534
Default: 53
dns-ipv4-recurse
Description ‘enabled’: Set the recursion bit; ‘disabled’: Clear the recursion bit;
Type: string
Supported Values: enabled, disabled
Default: enabled
dns-ipv4-tcp
Description Configure DNS transport over TCP, default is UDP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns-ipv6-addr
Description Specify IPv6 address
Type: string
Format: ipv6-address
Mutual Exclusion: dns-ipv6-addr and dns-ipv4-addr are mutually exclusive
dns-ipv6-expect
Description: dns-ipv6-expect is a JSON Block. Please see below for dns-ipv6-expect
Type: Object
dns-ipv6-port
Description Specify DNS port, default is 53 (DNS Port(default 53))
Type: number
Range: 1-65534
Default: 53
dns-ipv6-recurse
Description ‘enabled’: Set the recursion bit; ‘disabled’: Clear the recursion bit;
Type: string
Supported Values: enabled, disabled
Default: enabled
dns-ipv6-tcp
Description Configure DNS transport over TCP, default is UDP
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
dns-domain-expect¶
Specification Type object dns-domain-fqdn
Description Specify fully qualified domain name expected in DNS response answer
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-domain-fqdndns-domain-response, dns-domain-ipv4 and dns-domain-ipv6 are mutually exclusive
dns-domain-ipv4
Description Specify expected resolved IPv4 address
Type: string
Format: ipv4-address
Mutual Exclusion: dns-domain-ipv4dns-domain-response, dns-domain-fqdn and dns-domain-ipv6 are mutually exclusive
dns-domain-ipv6
Description Specify expected resolved IPv6 address
Type: string
Format: ipv6-address
Mutual Exclusion: dns-domain-ipv6dns-domain-response, dns-domain-fqdn and dns-domain-ipv4 are mutually exclusive
dns-domain-response
Description Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-domain-responsedns-domain-fqdn, dns-domain-ipv4 and dns-domain-ipv6 are mutually exclusive
dns-ipv6-expect¶
Specification Type object dns-ipv6-fqdn
Description Specify fully qualified domain name expected in DNS response answer
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-ipv6-fqdn and dns-ipv6-response are mutually exclusive
dns-ipv6-response
Description Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-ipv6-response and dns-ipv6-fqdn are mutually exclusive
dns-ipv4-expect¶
Specification Type object dns-ipv4-fqdn
Description Specify fully qualified domain name expected in DNS response answer
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-ipv4-fqdn and dns-ipv4-response are mutually exclusive
dns-ipv4-response
Description Specify response code range (e.g. 0,1-5) (Format is xx,xx-xx (xx between [0,15]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: dns-ipv4-response and dns-ipv4-fqdn are mutually exclusive