:source: fmgd_system_dns.py
:orphan:
.. _fmgd_system_dns:
fmgd_system_dns -- Configure DNS.
+++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
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
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- alt_secondary (Alias name: alt-secondary) Alternate secondary dns server. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dns_cache_limit (Alias name: dns-cache-limit) Maximum number of records in the dns cache. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dns_cache_ttl (Alias name: dns-cache-ttl) Duration in seconds that the dns cache retains information. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- domain Search suffix list for hostname lookup. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fqdn_cache_ttl (Alias name: fqdn-cache-ttl) Fqdn cache time to live in seconds (0 - 86400, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fqdn_max_refresh (Alias name: fqdn-max-refresh) Fqdn cache maximum refresh time in seconds (3600 - 86400, default = 3600). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- fqdn_min_refresh (Alias name: fqdn-min-refresh) Fqdn cache minimum refresh time in seconds (10 - 3600, default = 60). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- interface Specify outgoing interface to reach server. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_primary (Alias name: ip6-primary) Primary dns server ipv6 address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_secondary (Alias name: ip6-secondary) Secondary dns server ipv6 address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- log Local dns log setting. type: str choices: [disable, error, all]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- primary Primary dns server ip address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- protocol Dns transport protocols. type: list choices: [cleartext, dot, doh]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- retry Number of times to retry (0 - 5). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- secondary Secondary dns server ip address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- server_hostname (Alias name: server-hostname) Dns server host name list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- server_select_method (Alias name: server-select-method) Specify how configured servers are prioritized. type: str choices: [least-rtt, failover]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- source_ip (Alias name: source-ip) Ip address used by the dns server as its source ip. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ssl_certificate (Alias name: ssl-certificate) Name of local certificate for ssl connections. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- timeout Dns query timeout interval in seconds (1 - 10). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dns_over_tls (Alias name: dns-over-tls) Enable/disable/enforce dns over tls. type: str choices: [disable, enable, enforce]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hostname_limit (Alias name: hostname-limit) Limit of the number of hostname table entries (0 - 50000). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- hostname_ttl (Alias name: hostname-ttl) Ttl of hostname table entries (60 - 86400). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- 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...
Supported Version Ranges: v7.6.0 -> latest
- source_ip_interface (Alias name: source-ip-interface) Ip address of the specified interface as the source ip address. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.2 -> latest
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
--------
.. code-block:: yaml+jinja
- 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:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
system_dns:
# alt_primary:
# alt_secondary:
# cache_notfound_responses:
# dns_cache_limit:
# dns_cache_ttl:
# domain:
# fqdn_cache_ttl:
# fqdn_max_refresh:
# fqdn_min_refresh:
# interface:
# interface_select_method:
# ip6_primary:
# ip6_secondary:
# log:
# primary:
# protocol:
# - "cleartext"
# - "dot"
# - "doh"
# retry:
# secondary:
# server_hostname:
# server_select_method:
# source_ip:
# ssl_certificate:
# timeout:
# dns_over_tls:
# hostname_limit:
# hostname_ttl:
# root_servers:
# source_ip_interface:
# vrf_select:
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:
.. raw:: html
- 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.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)