servers

string

The primary identifier of the header stating the type of object.

TRUE

string

string

The primary identifier of an individual object. For Server, name is used as key.

TRUE

string

string

The name of the DHCP Config Profile. Must contain 1 to 256 characters. Can include UTF-8.

TRUE

string

string

The description for the DHCP Config Profile. May contain 0 to 1024 characters.

FALSE

string

integer

The lease duration in seconds for IPV6 clients.

FALSE

string

array

The list of IPv6 filters assigned to a scope. A client will receive the union of all options from all filters it matches.

FALSE

stringarray

boolean

Disable to allow leases only for known IPv4 clients, those for which a fixed address is configured.

FALSE

string

array

The list of IPv4 filters assigned to a scope. A client will receive the union of all options from all filters it matches.

FALSE

stringarray

integer

The lease duration in seconds for IPv4.

FALSE

string

boolean

Enable to ignore the client UID when issuing a DHCP lease. Use this option to prevent assigning two IP addresses for a client which does not have a UID during one phase of PXE boot but acquires one for the other phase.

FALSE

string

array

The list of clients to ignore requests from.

FALSE

nios

ignore_item_type

ignore_item_value

boolean

Disable to allow leases only for known IPv6 clients, those for which a fixed address is configured.

FALSE

string

string

The list of DHCP options or group of options for IPv4.
An option list is ordered and may include both option groups and specific options.
Multiple occurences of the same option or group is not an error.
The last occurence of an option in the list will be used.

FALSE

expanddhcp

string

The list of DHCP options or group of options for IPv6.
An option list is ordered and may include both option groups and specific options.
Multiple occurences of the same option or group is not an error.
The last occurence of an option in the list will be used.

FALSE

expanddhcp

boolean

Indicates if DDNS updates should be performed for leases.
All other ddns_*_ configuration is ignored when this flag is unset.
At a minimum, ddns_domain and ddns_zones must be configured to enable DDNS.

FALSE

string

string

The domain suffix for DDNS updates. FQDN, may be empty.

FALSE

string

array

The DNS zones that DDNS updates can be sent to.
There is no resolver fallback. The target zone must be explicitly configured for the update to be performed.
Updates are sent to the closest enclosing zone.
Error if ddns_enabled is true and the ddns_domain does not have a corresponding entry in ddns_zones.
Error if there are items with duplicate zone in the list.

FALSE

nios

zone

fqdn

tsig_enabled

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

gss_tsig_enabled

nameservers

boolean

Indicates if DDNS needs to generate a hostname when not supplied by the client.

FALSE

string

string

Controls who does the DDNS updates.
Valid values are:

• client: DHCP server updates DNS if requested by client.

• server: DHCP server always updates DNS, overriding an update request from the client, unless the client requests no updates.

• ignore: DHCP server always updates DNS, even if the client says not to.

• over_client_update: Same as server. DHCP server always updates DNS, overriding an update request from the client, unless the client requests no updates.

• over_no_update: DHCP server updates DNS even if the client requests that no updates be done. If the client requests to do the update, DHCP server allows it.

FALSE

string

client

boolean

Indicates if client supplied hostnames will be rewritten prior to DDNS update by replacing every character that does not match hostname_rewrite_regex by hostname_rewrite_char.

FALSE

string

string

The regex bracket expression to match valid characters.
Must begin with '[' and end with ']' and be a compilable POSIX regex.

FALSE

string

[^a-zA-Z0-9_.]

string

The character to replace non-matching characters with, when hostname rewrite is enabled.
Any single ASCII character or no character if the invalid characters should be removed without replacement.

FALSE

string

-

string

The inheritance configuration for allow_unknown field from DHCPConfig object.

FALSE

string

inherit

string

The inheritance configuration for filters field from DHCPConfig object.

FALSE

string

inherit

string

The inheritance configuration for lease_time field from DHCPConfig object.

FALSE

string

inherit

string

The inheritance configuration for ignore_client_uid field from DHCPConfig object.

FALSE

string

inherit

string

The inheritance configuration for ignore_list field from DHCPConfig object.

FALSE

string

inherit

string

The inheritance configuration for allow_unknown_v6 field from DHCPConfig object.

FALSE

string

inherit

string

The inheritance configuration for lease_time_v6 field from DHCPConfig object.

FALSE

string

inherit

string

The inheritance configuration for filters_v6 field from DHCPConfig object.

FALSE

string

inherit

array

The inheritance configuration for a field of type of OptionItem.

FALSE

nios

dhcp_options_value_action

string

The inheritance setting.
Valid values are:

• inherit: Use the inherited value.

• block: Don't use the inherited value.

Defaults to inherit.

FALSE

string

inherit

string

The inheritance setting.
Valid values are:

• inherit: Use the inherited value.

• block: Don't use the inherited value.

Defaults to inherit.

FALSE

string

inherit

array

The inheritance configuration for a field of type of OptionItem.

FALSE

nios

dhcp_options_value_action

string

The inheritance configuration for ddns_block field from Server object.

FALSE

string

inherit

string

The reference to the option space that will be encapsulated into the vendor specific option (code = 43).

FALSE

string

inherit

string

The inheritance configuration for header_option_server_address field.

FALSE

string

inherit

string

The inheritance configuration for header_option_server_name field.

FALSE

string

inherit

string

The inheritance configuration for header_option_filename field.

FALSE

string

inherit

string

The inheritance configuration for ddns_client_update field from DHCP Config Profile object.

FALSE

string

inherit

string

The inheritance configuration for hostname_rewrite_enabled, hostname_rewrite_regex, and hostname_rewrite_char fields from DHCP Config Profile object.

FALSE

string

inherit

string

The inheritance configuration for ddns_generate_name and ddns_generated_prefix fields from DHCP Config Profile object.

FALSE

string

inherit

string

The inheritance configuration for ddns_update_on_renew field from DHCP Config Profile object.

FALSE

string

inherit

string

The inheritance configuration for ddns_use_conflict_resolution field from DHCP Config Profile object.

FALSE

string

inherit

string

The inheritance configuration for ddns_conflict_resolution_mode field from DHCP Config Profile object.

FALSE

string

inherit

string

The tags for the DHCP Config Profile in JSON format.

FALSE

expandtags

{}

string

The reference to the option space that will be encapsulated into the vendor specific option (code = 43).

FALSE

string

string

The configuration for header option server address field.

FALSE

string

string

The configuration for header option server name field.

FALSE

string

string

The configuration for header option filename field.

FALSE

string

boolean

Determines if DDNS updates are enabled at the server level.

FALSE

string

string

The prefix used in the generation of an FQDN.
When generating a name, DHCP server will construct the name in the format: [ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix].
where address-text is simply the lease IP address converted to a hyphenated string.

FALSE

string

myhost

boolean

Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed.

FALSE

string

boolean

When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request.
When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients.

FALSE

string

string

The Kerberos principal name. It uses the typical Kerberos notation: <SERVICE-NAME>/<server-domain-name>@<REALM>.

FALSE

string

string

The Kerberos principal name of this DNS server that will receive updates.

FALSE

string

string

Address of Kerberos Key Distribution Center.

FALSE

string

array

_kerberos_keys contains a list of keys for GSS-TSIG signed dynamic updates.

FALSE

stringarray

integer

Lifetime (in seconds) of GSS-TSIG keys in the TKEY protocol.

FALSE

string

integer

Time interval (in seconds) the keys for each configured external DNS server are checked for rekeying, i.e. a new key is created to replace the current usable one when its age is greater than the kerberos_rekey_interval value.

FALSE

string

integer

Retry Time interval (in seconds)to create a key if any error occurred previously for any configured external DNS server.

FALSE

string

string

Determines which protocol is used to establish the security context with the external DNS servers, TCP or UDP.

FALSE

string

tcp

boolean

The behavior when GSS-TSIG should be used (a matching external DNS server is configured) but no GSS-TSIG key is available.
If configured to false (the default) this DNS server is skipped, if configured to true the DNS server is ignored and the DNS update is sent with the configured DHCP-DDNS protection e.g. TSIG key or without any protection when none was configured.

FALSE

string

string

The mode used for resolving conflicts while performing DDNS updates.
Valid values are:

• check_with_dhcid: It includes adding a DHCID record and checking that record via conflict detection as per RFC 4703.

• no_check_with_dhcid: This will ignore conflict detection but add a DHCID record when creating/updating an entry.

• check_exists_with_dhcid: This will check if there is an existing DHCID record but does not verify the value of the record matches the update. This will also update the DHCID record for the entry.

• no_check_without_dhcid: This ignores conflict detection and will not add a DHCID record when creating/updating a DDNS entry.

FALSE

string

check_with_dhcid