fortinet.fortimanager.fmgr_devprof_system_dns module – Configure DNS.
Note
This module is part of the fortinet.fortimanager collection (version 2.14.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_system_dns.
New in fortinet.fortimanager 1.0.0
Synopsis
- This module is able to configure a FortiManager device.
- Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter | Comments |
|---|---|
access_token string | The token to access FortiManager without using username and password. |
adom string / required | The parameter (adom) in requested url. |
bypass_validation boolean | Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
devprof string / required | The parameter (devprof) in requested url. |
devprof_system_dns dictionary | The top level parameters set. |
|
alt_primary aliases: alt-primary string |
Alternate primary DNS server. |
|
alt_secondary aliases: alt-secondary string |
Alternate secondary DNS server. |
|
cache_notfound_responses aliases: cache-notfound-responses string |
Enable/disable response from the DNS server when a record is not in cache. Choices:
|
|
dns_cache_limit aliases: dns-cache-limit integer |
Maximum number of records in the DNS cache. |
|
dns_cache_ttl aliases: dns-cache-ttl integer |
Duration in seconds that the DNS cache retains information. |
|
dns_over_tls aliases: dns-over-tls string |
Enable/disable/enforce DNS over TLS. Choices:
|
|
domain any |
(list or str) Domain name suffix for the IP addresses of the DNS server. |
|
fqdn_cache_ttl aliases: fqdn-cache-ttl integer |
FQDN cache time to live in seconds |
|
fqdn_max_refresh aliases: fqdn-max-refresh integer |
FQDN cache maximum refresh time in seconds |
|
fqdn_min_refresh aliases: fqdn-min-refresh integer |
FQDN cache minimum refresh time in seconds |
|
hostname_limit aliases: hostname-limit integer |
Limit of the number of hostname table entries |
|
hostname_ttl aliases: hostname-ttl integer |
TTL of hostname table entries |
|
interface string |
Specify outgoing interface to reach server. |
|
interface_select_method aliases: interface-select-method string |
Specify how to select outgoing interface to reach server. Choices:
|
|
ip6_primary aliases: ip6-primary string |
Primary DNS server IPv6 address. |
|
ip6_secondary aliases: ip6-secondary string |
Secondary DNS server IPv6 address. |
|
log string |
Local DNS log setting. Choices:
|
|
primary string |
Primary DNS server IP address. |
|
protocol list / elements=string |
DNS transport protocols. Choices:
|
|
retry integer |
Number of times to retry |
|
root_servers aliases: root-servers string |
Configure up to two preferred servers that serve the DNS root zone |
|
secondary string |
Secondary DNS server IP address. |
|
server_hostname aliases: server-hostname any |
(list) DNS server host name list. |
|
server_select_method aliases: server-select-method string |
Specify how configured servers are prioritized. Choices:
|
|
source_ip aliases: source-ip string |
IP address used by the DNS server as its source IP. |
|
source_ip_interface aliases: source-ip-interface any |
(list) IP address of the specified interface as the source IP address. |
|
ssl_certificate aliases: ssl-certificate string |
Name of local certificate for SSL connections. |
|
timeout integer |
DNS query timeout interval in seconds |
|
vrf_select aliases: vrf-select integer |
VRF ID used for connection to server. |
enable_log boolean | Enable/Disable logging for task. Choices:
|
forticloud_access_token string | Authenticate Ansible client with forticloud API access token. |
proposed_method string | The overridden method for the underlying Json RPC request. Choices:
|
rc_failed list / elements=integer | The rc codes list with which the conditions to fail will be overriden. |
rc_succeeded list / elements=integer | The rc codes list with which the conditions to succeed will be overriden. |
workspace_locking_adom string | The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
workspace_locking_timeout integer | The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
- Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure DNS.
fortinet.fortimanager.fmgr_devprof_system_dns:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
devprof: <your own value>
devprof_system_dns:
# cache_notfound_responses: <value in [disable, enable]>
# dns_cache_limit: <integer>
# dns_cache_ttl: <integer>
# domain: <list or string>
# ip6_primary: <string>
# ip6_secondary: <string>
# primary: <string>
# secondary: <string>
# dns_over_tls: <value in [disable, enable, enforce]>
# retry: <integer>
# server_hostname: <list or string>
# ssl_certificate: <string>
# timeout: <integer>
# interface: <string>
# interface_select_method: <value in [auto, sdwan, specify]>
# alt_primary: <string>
# alt_secondary: <string>
# fqdn_cache_ttl: <integer>
# fqdn_max_refresh: <integer>
# fqdn_min_refresh: <integer>
# log: <value in [disable, error, all]>
# protocol: ["cleartext", "dot", "doh"]
# server_select_method: <value in [least-rtt, failover]>
# source_ip: <string>
# vrf_select: <integer>
# source_ip_interface: <list or string>
# hostname_ttl: <integer>
# hostname_limit: <integer>
# root_servers: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
meta dictionary | The result of the request. Returned: always |
|
request_url string |
The full url requested. Returned: always Sample: |
|
response_code integer |
The status of api request. Returned: always Sample: |
|
response_data list / elements=string |
The api response. Returned: always |
|
response_message string |
The descriptive message of the api response. Returned: always Sample: |
|
system_information dictionary |
The information of the target system. Returned: always |
rc integer | The status the request. Returned: always Sample: |
version_check_warning list / elements=string | Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_devprof_system_dns_module.html
