fmgd_system_dns – Configure DNS.
Added in version 1.0.0.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- system_dns - Configure DNS. type: dict
- alt_primary (Alias name: alt-primary) Alternate primary dns server. type: str more...
- alt_secondary (Alias name: alt-secondary) Alternate secondary dns server. type: str more...
- cache_notfound_responses (Alias name: 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 (Alias name: dns-cache-limit) Maximum number of records in the dns cache. type: int more...
- dns_cache_ttl (Alias name: dns-cache-ttl) Duration in seconds that the dns cache retains information. type: int more...
- domain Search suffix list for hostname lookup. type: list more...
- fqdn_cache_ttl (Alias name: fqdn-cache-ttl) Fqdn cache time to live in seconds (0 - 86400, default = 0). type: int more...
- fqdn_max_refresh (Alias name: fqdn-max-refresh) Fqdn cache maximum refresh time in seconds (3600 - 86400, default = 3600). type: int more...
- fqdn_min_refresh (Alias name: fqdn-min-refresh) Fqdn cache minimum refresh time in seconds (10 - 3600, default = 60). type: int more...
- interface Specify outgoing interface to reach server. type: list more...
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
- ip6_primary (Alias name: ip6-primary) Primary dns server ipv6 address. type: str more...
- ip6_secondary (Alias name: 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 (Alias name: server-hostname) Dns server host name list. type: list more...
- server_select_method (Alias name: server-select-method) Specify how configured servers are prioritized. type: str choices: [least-rtt, failover] more...
- source_ip (Alias name: source-ip) Ip address used by the dns server as its source ip. type: str more...
- ssl_certificate (Alias name: ssl-certificate) Name of local certificate for ssl connections. type: list more...
- timeout Dns query timeout interval in seconds (1 - 10). type: int more...
- dns_over_tls (Alias name: dns-over-tls) Enable/disable/enforce dns over tls. type: str choices: [disable, enable, enforce] more...
- hostname_limit (Alias name: hostname-limit) Limit of the number of hostname table entries (0 - 50000). type: int more...
- hostname_ttl (Alias name: hostname-ttl) Ttl of hostname table entries (60 - 86400). type: int more...
- root_servers (Alias name: root-servers) Configure up to two preferred servers that serve the dns root zone (default uses all 13 root servers). type: str more...
- source_ip_interface (Alias name: source-ip-interface) Ip address of the specified interface as the source ip address. type: list more...
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int more...
Notes
Note
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.
To create or update an object, use state: present directive.
To delete an object, use state: absent directive
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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure DNS.
fortinet.fmgdevice.fmgd_system_dns:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
system_dns:
# alt_primary: <string>
# alt_secondary: <string>
# cache_notfound_responses: <value in [disable, enable]>
# dns_cache_limit: <integer>
# dns_cache_ttl: <integer>
# domain: <list or string>
# fqdn_cache_ttl: <integer>
# fqdn_max_refresh: <integer>
# fqdn_min_refresh: <integer>
# interface: <list or string>
# interface_select_method: <value in [auto, sdwan, specify]>
# ip6_primary: <string>
# ip6_secondary: <string>
# log: <value in [disable, error, all]>
# primary: <string>
# protocol:
# - "cleartext"
# - "dot"
# - "doh"
# retry: <integer>
# secondary: <string>
# server_hostname: <list or string>
# server_select_method: <value in [least-rtt, failover]>
# source_ip: <string>
# ssl_certificate: <list or string>
# timeout: <integer>
# dns_over_tls: <value in [disable, enable, enforce]>
# hostname_limit: <integer>
# hostname_ttl: <integer>
# root_servers: <string>
# source_ip_interface: <list or string>
# vrf_select: <integer>
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:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.