fortinet.fortios.fortios_system_dns_database – Configure DNS databases in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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

To use it in a playbook, specify: fortinet.fortios.fortios_system_dns_database.

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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_database 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.9.0

Parameters

Parameter			Choices/Defaults	Comments
access_token string				Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task.
state string / required			Choices: present absent	Indicates whether to create or remove the object.
system_dns_database dictionary				Configure DNS databases.
	allow_transfer string			DNS zone transfer IP address list.
	authoritative string		Choices: enable disable	Enable/disable authoritative zone.
	contact string			Email address of the administrator for this zone. You can specify only the username (e.g. admin) or full email address (e.g. admin@test .com) When using a simple username, the domain of the email will be this zone.
	dns_entry list / elements=string			DNS entry.
		canonical_name string		Canonical name of the host.
		hostname string		Name of the host.
		id integer / required		DNS entry ID.
		ip string		IPv4 address of the host.
		ipv6 string		IPv6 address of the host.
		preference integer		DNS entry preference, 0 is the highest preference (0 - 65535)
		status string	Choices: enable disable	Enable/disable resource record status.
		ttl integer		Time-to-live for this entry (0 to 2147483647 sec).
		type string	Choices: A NS CNAME MX AAAA PTR PTR_V6	Resource record type.
	domain string			Domain name.
	forwarder string			DNS zone forwarder IP address list.
	ip_master string			IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
	ip_primary string			IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
	name string / required			Zone name.
	primary_name string			Domain name of the default DNS server for this zone.
	rr_max integer			Maximum number of resource records (10 - 65536, 0 means infinite).
	source_ip string			Source IP for forwarding to DNS server.
	status string		Choices: enable disable	Enable/disable this DNS zone.
	ttl integer			Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec).
	type string		Choices: master slave primary secondary	Zone type (master to manage entries directly, slave to import entries from other zones).
	view string		Choices: shadow public	Zone view (public to serve public clients, shadow to serve internal clients).
vdom string			Default: "root"	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.

Notes

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure DNS databases.
    fortios_system_dns_database:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_dns_database:
        allow_transfer: "<your_own_value>"
        authoritative: "enable"
        contact: "<your_own_value>"
        dns_entry:
         -
            canonical_name: "<your_own_value>"
            hostname: "myhostname"
            id:  "9"
            ip: "<your_own_value>"
            ipv6: "<your_own_value>"
            preference: "12"
            status: "enable"
            ttl: "14"
            type: "A"
        domain: "<your_own_value>"
        forwarder: "<your_own_value>"
        ip_master: "<your_own_value>"
        ip_primary: "<your_own_value>"
        name: "default_name_20"
        primary_name: "<your_own_value>"
        rr_max: "22"
        source_ip: "84.230.14.43"
        status: "enable"
        ttl: "25"
        type: "master"
        view: "shadow"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate Sample: v5.6.3

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_dns_database_module.html