fortios_system_dns – Configure DNS in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- system_dns - Configure DNS. type: dict more...
- alt_primary - Alternate primary DNS server. This is not used as a failover DNS server. type: str more...
- alt_secondary - Alternate secondary DNS server. This is not used as a failover DNS server. type: str more...
- cache_notfound_responses - Enable/disable response from the DNS server when a record is not in cache. type: str choices: disable, enable more...
- dns_cache_limit - Maximum number of records in the DNS cache. type: int more...
- dns_cache_ttl - Duration in seconds that the DNS cache retains information. type: int more...
- dns_over_tls - Enable/disable/enforce DNS over TLS. type: str choices: disable, enable, enforce more...
- domain - Search suffix list for hostname lookup. type: list member_path: domain:domain more...
- domain - DNS search domain list separated by space (maximum 8 domains). type: str required: true more...
- fqdn_cache_ttl - FQDN cache time to live in seconds (0 - 86400). type: int more...
- fqdn_max_refresh - FQDN cache maximum refresh time in seconds (3600 - 86400). type: int more...
- fqdn_min_refresh - FQDN cache minimum refresh time in seconds (10 - 3600). type: int more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- ip6_primary - Primary DNS server IPv6 address. type: str more...
- ip6_secondary - Secondary DNS server IPv6 address. type: str more...
- log - Local DNS log setting. type: str choices: disable, error, all more...
- primary - Primary DNS server IP address. type: str more...
- protocol - DNS transport protocols. type: list choices: cleartext, dot, doh more...
- retry - Number of times to retry (0 - 5). type: int more...
- secondary - Secondary DNS server IP address. type: str more...
- server_hostname - DNS server host name list. type: list member_path: server_hostname:hostname more...
- hostname - DNS server host name list separated by space (maximum 4 domains). type: str required: true more...
- server_select_method - Specify how configured servers are prioritized. type: str choices: least-rtt, failover more...
- source_ip - IP address used by the DNS server as its source IP. type: str more...
- ssl_certificate - Name of local certificate for SSL connections. Source certificate.local.name. type: str more...
- timeout - DNS query timeout interval in seconds (1 - 10). type: int more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure DNS.
fortinet.fortios.fortios_system_dns:
vdom: "{{ vdom }}"
system_dns:
alt_primary: "<your_own_value>"
alt_secondary: "<your_own_value>"
cache_notfound_responses: "disable"
dns_cache_limit: "5000"
dns_cache_ttl: "1800"
dns_over_tls: "disable"
domain:
-
domain: "<your_own_value>"
fqdn_cache_ttl: "0"
fqdn_max_refresh: "3600"
fqdn_min_refresh: "60"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ip6_primary: "<your_own_value>"
ip6_secondary: "<your_own_value>"
log: "disable"
primary: "<your_own_value>"
protocol: "cleartext"
retry: "2"
secondary: "<your_own_value>"
server_hostname:
-
hostname: "myhostname"
server_select_method: "least-rtt"
source_ip: "84.230.14.43"
ssl_certificate: "<your_own_value> (source certificate.local.name)"
timeout: "5"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.