fortios_system_dns_database – Configure DNS databases in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_dns_database - Configure DNS databases. type: dict more...
- allow_transfer - DNS zone transfer IP address list. type: list
- authoritative - Enable/disable authoritative zone. type: str choices: enable, disable more...
- contact - 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. type: str more...
- dns_entry - DNS entry. type: list member_path: dns_entry:id more...
- canonical_name - Canonical name of the host. type: str more...
- hostname - Name of the host. type: str more...
- id - DNS entry ID. see Notes. type: int required: true more...
- ip - IPv4 address of the host. type: str more...
- ipv6 - IPv6 address of the host. type: str more...
- preference - DNS entry preference (0 - 65535, highest preference = 0). type: int more...
- status - Enable/disable resource record status. type: str choices: enable, disable more...
- ttl - Time-to-live for this entry (0 to 2147483647 sec). type: int more...
- type - Resource record type. type: str choices: A, NS, CNAME, MX, AAAA, PTR, PTR_V6 more...
- domain - Domain name. type: str more...
- forwarder - DNS zone forwarder IP address list. type: list
- forwarder6 - Forwarder IPv6 address. type: str more...
- ip_master - IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone. type: str more...
- ip_primary - IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone. type: str more...
- name - Zone name. type: str required: true more...
- primary_name - Domain name of the default DNS server for this zone. type: str more...
- rr_max - Maximum number of resource records (10 - 65536, 0 means infinite). type: int more...
- source_ip - Source IP for forwarding to DNS server. type: str more...
- source_ip6 - IPv6 source IP address for forwarding to DNS server. type: str more...
- status - Enable/disable this DNS zone. type: str choices: enable, disable more...
- ttl - Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec). type: int more...
- type - Zone type (primary to manage entries directly, secondary to import entries from other zones). type: str choices: primary, secondary, master, slave more...
- view - Zone view (public to serve public clients, shadow to serve internal clients). type: str choices: shadow, public, shadow-ztna, proxy more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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_ip6: "<your_own_value>"
status: "enable"
ttl: "86400"
type: "primary"
view: "shadow"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.