addDNSServerGroup

The addDNSServerGroup operation handles configuration related to DNSServerGroup model. 

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter Required Type Description
name True string A unique name to identify this group.
dnsServers True [object] A list of the names of DNSServer objects that belong to this group.
Field level constraints: cannot be null, size must be between 1 and 6 (inclusive). (Note: Additional constraints might exist)
timeout False integer The number of seconds, from 1 to 30, to wait before trying the next DNS server. The default is 2 seconds. Each time the system retries the list of servers, this timeout doubles.
Field level constraints: must be between 1 and 30 (inclusive). (Note: Additional constraints might exist)
retries False integer The number of times, from 0 to 10, to retry the list of DNS servers when the system does not receive a response. The default is 2 retries.
Field level constraints: must be between 1 and 10 (inclusive). (Note: Additional constraints might exist)
searchDomain False string The search domain for this group.
Field level constraints: length must be between 0 and 255 (inclusive), must match pattern ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]).)([a-zA-Z0-9]|[a-zA-Z0-9][A-Za-z0-9-]*[A-Za-z0-9])|)$. (Note: Additional constraints might exist)
systemDefined False boolean A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that this object is a system defined object.
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addDNSServerGroup' operation
  ftd_configuration:
    operation: "addDNSServerGroup"
    data:
        name: "{{ name }}"
        dnsServers: "{{ dns_servers }}"
        timeout: "{{ timeout }}"
        retries: "{{ retries }}"
        searchDomain: "{{ search_domain }}"
        systemDefined: "{{ system_defined }}"
        type: "{{ type }}"