Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Mandatory parameters are denoted by an * (asterisk).

header

type

description

required

encoding

sample

object_headers

key

string

The primary identifier of an individual object. For DNS View, name of the view is used as key.

TRUE

string

name*

string

Name of view.

TRUE

string

comment

string

Comment for view.

FALSE

string

disabled

boolean

Whether to disable an object or not.
A disabled object is effectively non-existent when generating configuration.

FALSE

string

query_acl

array

Clients must match this ACL to make authoritative queries.
Also used for recursive queries if that ACL is unset.

FALSE

nios

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

minimal_responses

boolean

When enabled, the DNS server will only add records to the authority and additional data sections when they are required

FALSE

string

transfer_acl

array

Clients must match this ACL to receive zone transfers.

FALSE

nios

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

recursion_enabled

boolean

If set true it allows recursive DNS queries.

FALSE

string

recursion_acl

array

Clients must match this ACL to make recursive queries.
If this ACL is empty, then the query_acl will be used instead.

FALSE

nios

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

lame_ttl

integer

Unused in the current on-prem DNS server implementation.Unsigned integer, min 0 max 3600 (1h).

FALSE

string

max_cache_ttl

integer

Seconds to cache positive responses.Unsigned integer, min 1 max 604800 (7d).

FALSE

string

max_negative_ttl

integer

Seconds to cache negative responses.
Unsigned integer, min 1 max 604800 (7d).
Defaults to 10800 (3h).

FALSE

string

custom_root_ns_enabled

boolean

Whether to use custom root nameservers instead of the default ones or not.
The custom_root_ns is validated when enabled.
Defaults to false.

FALSE

string

custom_root_ns

array

List of custom root nameservers. The order does not matter.Error if empty while custom_root_ns_enabled is true. Error if there are duplicate items in the list.

FALSE

nios

root_ns_address

root_ns_fqdn

forwarders

array

List of forwarders.
Error if empty while forwarders_only or use_root_forwarders_for_local_resolution_with_b1td is true.
Error if there are items in the list with duplicate addresses.

FALSE

nios

forwarder_address

forwarder_fqdn

forwarders_only

boolean

Set to true to only forward.
Defaults to false.

FALSE

string

use_forwarders_for_subzones

boolean

Use default forwarders to resolve queries for subzones.

FALSE

string

refresh

integer

ZoneAuthority refresh.

FALSE

string

retry

integer

ZoneAuthority retry.

FALSE

string

expire

integer

ZoneAuthority expire time in seconds.

FALSE

string

default_ttl

integer

ZoneAuthority default ttl for resource records in zone (value in seconds).

FALSE

string

negative_ttl

integer

ZoneAuthority negative caching (minimum) ttl in seconds.

FALSE

string

rname

string

ZoneAuthority rname.

FALSE

string

mname

string

ZoneAuthority master name server in punycode.

FALSE

string

use_default_mname

boolean

Use default value for master name server.

FALSE

string

update_acl

array

Specifies which hosts are allowed to issue.
Dynamic DNS updates for authoritative zones of primary_type cloud.

FALSE

nios

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

ecs_enabled

boolean

Use to enable EDNS client subnet for recursive queries.
Other ecs_*_ fields are ignored if this field is not enabled.

FALSE

string

ecs_forwarding

boolean

Use to enable ECS options in outbound queries. This functionality has additional overhead so it is disabled by default.

FALSE

string

ecs_prefix_v4

integer

Maximum scope length for v4 ECS. Unsigned integer, min 1 max 24.

FALSE

string

ecs_prefix_v6

integer

Maximum scope length for v6 ECS. Unsigned integer, min 1 max 56.

FALSE

string

ecs_zones

array

List of zones where ECS queries may be sent.
Error if empty while ecs_enabled is true.
Error if there are duplicate FQDNs in the list.

FALSE

nios

ecs_zone_fqdn

ecs_zone_access

dnssec_enabled

boolean

Master toggle for all DNSSEC processing.Other dnssec_*_ configuration is unused if this is disabled.

FALSE

string

dnssec_enable_validation

boolean

Set to perform DNSSEC validation.Ignored if dnssec_enabled is false.Defaults to true.

FALSE

string

dnssec_validate_expiry

boolean

Set to reject expired DNSSEC keys.Ignored if either dnssec_enabled or dnssec_enable_validation is false.
Defaults to true.

FALSE

string

dnssec_trust_anchors

array

DNSSEC trust anchors.Error if there are list items with duplicate (zone, sep, algorithm) combinations.

FALSE

nios

trust_anchor_zone

trust_anchor_sep

trust_anchor_algorithm

trust_anchor_public_key

match_clients_acl

array

Specifies which clients have access to the view.

FALSE

nios

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

match_destinations_acl

array

Specifies which destination addresses have access to the view.

FALSE

nios

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

match_recursive_only

boolean

If true only recursive queries from matching clients access the view.

FALSE

string

query_acl_action

string

The inheritance configuration for query_acl field from View object.

FALSE

string

inherit

minimal_responses_action

string

The inheritance configuration for minimal_responses field from View object.

FALSE

string

inherit

transfer_acl_action

string

The inheritance configuration for transfer_acl field from View object.

FALSE

string

inherit

recursion_enabled_action

string

The inheritance configuration for recursion_enabled field from View object

FALSE

string

inherit

recursion_acl_action

string

The inheritance configuration for recursion_acl field from View object

FALSE

string

inherit

lame_ttl_action

string

The inheritance configuration for lame_ttl field from View object

FALSE

string

inherit

max_cache_ttl_action

string

The inheritance configuration for max_cache_ttl field from View object.

FALSE

string

inherit

max_negative_ttl_action

string

The inheritance configuration for max_negative_ttl field from View object.

FALSE

string

inherit

custom_root_ns_block_action

string

The inheritance configuration for custom_root_ns_block field from View object.

FALSE

string

inherit

forwarders_block_action

string

The inheritance configuration for forwarders_block field from View object.

FALSE

string

inherit

use_forwarders_for_subzones_action

string

The inheritance configuration for use_forwarders_for_subzones field from View object.

FALSE

string

inherit

update_acl_action

string

The inheritance configuration for update_acl field from View object.

FALSE

string

inherit

ecs_block_action

string

The inheritance configuration for ecs_block field from View object.

FALSE

string

inherit

dnssec_validation_block_action

string

The inheritance configuration for dnssec_validation_block field from View object.

FALSE

string

inherit

refresh_action

string

The inheritance configuration for refresh field from View object.

FALSE

string

inherit

retry_action

string

The inheritance configuration for retry field from View object.

FALSE

string

inherit

expire_action

string

The inheritance configuration for expire field from View object.

FALSE

string

inherit

default_ttl_action

string

The inheritance configuration for default_ttl field from View object.

FALSE

string

inherit

negative_ttl_action

string

The inheritance configuration for negative_ttl field from View object.

FALSE

string

inherit

rname_action

string

The inheritance configuration for rname field from View object.

FALSE

string

inherit

protocol_rname_action

string

The inheritance configuration for protocol_rname field from View object.

FALSE

string

inherit

mname_block_action

string

The inheritance configuration for mname_block field from View object.

FALSE

string

inherit

match_recursive_only_action

string

The inheritance configuration for match_recursive_only field from View object.

FALSE

string

inherit

edns_udp_size_action

string

The inheritance configuration for edns_udp_size field from View object.

FALSE

string

inherit

max_udp_size_action

string

The inheritance configuration for max_udp_size field from View object.

FALSE

string

inherit

notify_action

string

The inheritance configuration for notify field from View object.

FALSE

string

inherit

gss_tsig_enabled_action

string

The inheritance configuration for gss_tsig_enabled field from View object.

FALSE

string

inherit

add_edns_option_in_outgoing_query_action

string

The inheritance configuration for add_edns_option_in_outgoing_query field from View object.

FALSE

string

inherit

synthesize_address_records_from_https_action

string

The inheritance configuration for synthesize_address_records_from_https field from View object.

FALSE

string

inherit

tags

string

The tags for the DNS View in JSON format.

FALSE

expandtags

edns_udp_size

integer

It represents the edns UDP size.
The size a querying DNS server advertises to the DNS server it’s sending a query to.

FALSE

string

max_udp_size

integer

It represents maximum UDP payload size.The maximum number of bytes a responding DNS server will send to a UDP datagram.

FALSE

string

notify

boolean

Notify all external secondary DNS servers.
Defaults to false.

FALSE

string

gss_tsig_enabled

boolean

The fields enables/disables GSS-TSIG signed dynamic updates.

FALSE

string

add_edns_option_in_outgoing_query

boolean

This field adds client IP, MAC address and view name into outgoing recursive query.

FALSE

string

synthesize_address_records_from_https

boolean

This field enables/disables creation of A/AAAA records from HTTPS RR.

FALSE

string

  • No labels