upsertDNSServerGroup

The upsertDNSServerGroup operation handles configuration related to DNSServerGroup model.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name	False	string	A unique name to identify this group. Field level constraints: cannot be null, length must be between 0 and 128 (inclusive), cannot have HTML, must match pattern (^[a-zA-Z0-9]$)\|(^[a-zA-Z0-9][ a-zA-Z0-9.+-]*[a-zA-Z0-9.+-]$). (Note: Additional constraints might exist)
dnsServers	False	[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 3 (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 0 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), cannot have HTML, 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.
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$, cannot have HTML. (Note: Additional constraints might exist)
type	False	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Query Parameters

Parameter	Required	Type	Description
filter	False	string	Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertDNSServerGroup' operation
  ftd_configuration:
    operation: "upsertDNSServerGroup"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        dnsServers: "{{ dns_servers }}"
        timeout: "{{ timeout }}"
        retries: "{{ retries }}"
        searchDomain: "{{ search_domain }}"
        systemDefined: "{{ system_defined }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"