fortinet.fortimanager.fmgr_system_dnsdatabase module – Configure DNS databases.

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_system_dnsdatabase.

New in fortinet.fortimanager 2.12.0

Synopsis
Parameters
Notes
Examples
Return Values

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: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
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: `"update"` `"set"` `"add"`
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.
revision_note string	The change note that can be specified when an object is created or updated.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
system_dnsdatabase dictionary	The top level parameters set.
allow_transfer aliases: allow-transfer list / elements=string	DNS zone transfer IP address list.
authoritative string	Enable/disable authoritative zone. Choices: `"disable"` `"enable"`
contact string	Email address of the administrator for this zone.
dns_entry aliases: dns-entry list / elements=dictionary	Dns entry.
canonical_name aliases: canonical-name string	Canonical name of the host.
hostname string	Name of the host.
id integer	DNS entry ID.
ip string	IPv4 address of the host.
ipv6 string	IPv6 address of the host.
preference integer	DNS entry preference
status string	Enable/disable resource record status. Choices: `"disable"` `"enable"`
ttl integer	Time-to-live for this entry
type string	Resource record type. Choices: `"NS"` `"MX"` `"CNAME"` `"A"` `"AAAA"` `"PTR"` `"PTR_V6"`
domain string	Domain name.
forwarder list / elements=string	DNS zone forwarder IP address list.
forwarder6 string	Forwarder IPv6 address.
interface list / elements=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: `"auto"` `"sdwan"` `"specify"`
ip_master aliases: ip-master string	IP address of master DNS server.
ip_primary aliases: ip-primary string	IP address of primary DNS server.
name string / required	Zone name.
primary_name aliases: primary-name string	Domain name of the default DNS server for this zone.
rr_max aliases: rr-max integer	Maximum number of resource records
source_ip aliases: source-ip string	Source IP for forwarding to DNS server.
source_ip6 aliases: source-ip6 string	IPv6 source IP address for forwarding to DNS server.
source_ip_interface aliases: source-ip-interface list / elements=string	IP address of the specified interface as the source IP address.
status string	Enable/disable this DNS zone. Choices: `"disable"` `"enable"`
ttl integer	Default time-to-live value for the entries of this DNS zone
type string	Zone type Choices: `"primary"` `"secondary"` `"master"` `"slave"`
view string	Zone view Choices: `"shadow"` `"public"` `"shadow-ztna"` `"proxy"`
vrf_select aliases: vrf-select integer	VRF ID used for connection to server.
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: `300`

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
To create or update an object, use state present directive.
To delete an object, use state absent directive.

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure DNS databases.
      fortinet.fortimanager.fmgr_system_dnsdatabase:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        system_dnsdatabase:
          name: "your value" # Required variable, string
          # allow_transfer: <list or string>
          # authoritative: <value in [disable, enable]>
          # contact: <string>
          # dns_entry:
          #   - canonical_name: <string>
          #     hostname: <string>
          #     id: <integer>
          #     ip: <string>
          #     ipv6: <string>
          #     preference: <integer>
          #     status: <value in [disable, enable]>
          #     ttl: <integer>
          #     type: <value in [NS, MX, CNAME, ...]>
          # domain: <string>
          # forwarder: <list or string>
          # forwarder6: <string>
          # ip_primary: <string>
          # primary_name: <string>
          # rr_max: <integer>
          # source_ip: <string>
          # source_ip6: <string>
          # status: <value in [disable, enable]>
          # ttl: <integer>
          # type: <value in [primary, secondary, master, ...]>
          # view: <value in [shadow, public, shadow-ztna, ...]>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # interface: <list or string>
          # source_ip_interface: <list or string>
          # vrf_select: <integer>
          # ip_master: <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: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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_system_dnsdatabase_module.html