fortinet.fortios.fortios_system_dns_database module – Configure DNS databases in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_dns_database
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure DNS databases. |
|
DNS zone transfer IP address list. |
|
Enable/disable authoritative zone. Choices:
|
|
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone. |
|
DNS entry. |
|
Canonical name of the host. |
|
Name of the host. |
|
DNS entry ID. see <a href=’#notes’>Notes</a>. |
|
IPv4 address of the host. |
|
IPv6 address of the host. |
|
DNS entry preference (0 - 65535, highest preference = 0). |
|
Enable/disable resource record status. Choices:
|
|
Time-to-live for this entry (0 to 2147483647 sec). |
|
Resource record type. Choices:
|
|
Domain name. |
|
DNS zone forwarder IP address list. |
|
Forwarder IPv6 address. |
|
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone. |
|
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone. |
|
Zone name. |
|
Domain name of the default DNS server for this zone. |
|
Maximum number of resource records (10 - 65536, 0 means infinite). |
|
Source IP for forwarding to DNS server. |
|
IPv6 source IP address for forwarding to DNS server. |
|
IP address of the specified interface as the source IP address. Source system.interface.name. |
|
Enable/disable this DNS zone. Choices:
|
|
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec). |
|
Zone type (primary to manage entries directly, secondary to import entries from other zones). Choices:
|
|
Zone view (public to serve public clients, shadow to serve internal clients). Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure DNS databases.
fortinet.fortios.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: "10"
status: "enable"
ttl: "0"
type: "A"
domain: "<your_own_value>"
forwarder: "<your_own_value>"
forwarder6: "<your_own_value>"
ip_master: "<your_own_value>"
ip_primary: "<your_own_value>"
name: "default_name_21"
primary_name: "<your_own_value>"
rr_max: "16384"
source_ip: "84.230.14.43"
source_ip_interface: "<your_own_value> (source system.interface.name)"
source_ip6: "<your_own_value>"
status: "enable"
ttl: "86400"
type: "primary"
view: "shadow"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |