cgnv6 template dns

DNS template.

dns Specification

Type Collection
Object Key(s) name
Collection Name dns-list
Collection URI /axapi/v3/cgnv6/template/dns/
Element Name dns
Element URI /axapi/v3/cgnv6/template/dns/{name}
Element Attributes dns_attributes
Schema dns schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/cgnv6/template/dns/

dns Attributes

Create List

POST

/axapi/v3/cgnv6/template/dns/

dns Attributes

Get Object

GET

/axapi/v3/cgnv6/template/dns/{name}

dns Attributes

Get List

GET

/axapi/v3/cgnv6/template/dns/

dns-list

Modify Object

POST

/axapi/v3/cgnv6/template/dns/{name}

dns Attributes

Replace Object

PUT

/axapi/v3/cgnv6/template/dns/{name}

dns Attributes

Replace List

PUT

/axapi/v3/cgnv6/template/dns/

dns-list

Delete Object

DELETE

/axapi/v3/cgnv6/template/dns/{name}

dns Attributes

dns-list

dns-list is JSON List of dns Attributes

dns-list : [

dns Attributes

class-list

Description: class-list is a JSON Block . Please see below for class-list

Type: Object

Reference Object: /axapi/v3/cgnv6/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

dns64

Description: dns64 is a JSON Block . Please see below for dns64

Type: Object

Reference Object: /axapi/v3/cgnv6/template/dns/{name}/dns64

drop

Description: Drop the malformed query

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: drop and forward are mutually exclusive

forward

Description: Forward to service group (Service group name)

Type: string

Mutual Exclusion: forward and drop are mutually exclusive

max-cache-size

Description: Define maximum cache size (Maximum cache entry per VIP)

Type: number

name

Description: DNS Template Name

Type: string

Format: string-rlx

Required: Yes

period

Description: Period in minutes

Type: number

Range: 1-10000

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

class-list

Specification
Type object

lid-list

Description: lid-list is a JSON List . Please see below for l834_lid-list

Type: List

Reference Object: /axapi/v3/cgnv6/template/dns/{name}/class-list/lid/{lidnum}

name

Description: Specify a class list name

Type: string

Format: string-rlx

Required: Yes

uuid

Description: uuid of the object

Type: string

class-list.lid-list

Specification
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 l834_dns

Type: Object

lidnum

Description: Specify a limit ID

Type: number

Range: 1-31

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

uuid

Description: uuid of the object

Type: string

class-list.lid-list.dns

Specification
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

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

dns64

Specification
Type object

answer-only-disable

Description: Disable Only translate the Answer Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

auth-data

Description: Set AA flag in DNS Response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cache

Description: Generate Response by DNS Cache

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

compress-disable

Description: Disable Always try DNS Compression

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

deep-check-rr-disable

Description: Disable Check DNS Response Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drop-cname-disable

Description: Disable Drop DNS CNAME Response

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

ignore-rcode3-disable

Description: Disable Ignore DNS error Response with rcode 3

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

max-qr-length

Description: Max Question Record Length, default is 128

Type: number

Range: 1-1023

Default: 128

parallel-query

Description: Forward AAAA Query & generate A Query in parallel

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

passive-query-disable

Description: Disable Generate A query upon empty or error Response

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

trans-ptr

Description: Translate DNS PTR Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

trans-ptr-query

Description: Translate DNS PTR Query

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description: Specify Max TTL in DNS Response, unit: second

Type: number

Range: 1-1000000000

uuid

Description: uuid of the object

Type: string