editDataDNSSettings

The editDataDNSSettings operation handles configuration related to DataDNSSettings model.

Description

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

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	True	string	A unique name to identify this Data DNS Setting
pollTimer	False	integer	Specifies the timer during which the threat defense queries the DNS server to resolve the FQDN. Specifies the timer in minutes. Valid values are from 1 to 65535 minutes, default 240 minutes has effect only when at least one network object group has been activated. Applicable only to active DNS Field level constraints: must be between 1 and 65535 (inclusive). (Note: Additional constraints might exist)
expiryEntryTimer	False	integer	Timer to remove the IP address of a resolved FQDN after its TTL expires. Valid values are from 1 to 65535,default 1 minute. Applicable only to active DNS Field level constraints: must be between 1 and 65535 (inclusive). (Note: Additional constraints might exist)
dnsServerGroup	False	object	DNS Server Group Object Allowed types are: [DNSServerGroup]
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 ^((?!;).)*$. (Note: Additional constraints might exist)
interfaces	False	[object]	Collection of named interfaces to lookup Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editDataDNSSettings' operation
  ftd_configuration:
    operation: "editDataDNSSettings"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        pollTimer: "{{ poll_timer }}"
        expiryEntryTimer: "{{ expiry_entry_timer }}"
        dnsServerGroup: "{{ dns_server_group }}"
        id: "{{ id }}"
        interfaces: "{{ interfaces }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"