fortios_system_dns_database – Configure DNS databases in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- system_dns_database - Configure DNS databases. type: dict
- allow_transfer - DNS zone transfer IP address list. type: str
- authoritative - Enable/disable authoritative zone. type: str choices: enable, disable
- contact - 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. type: str
- dns_entry - DNS entry. type: list
- canonical_name - Canonical name of the host. type: str
- hostname - Name of the host. type: str
- id - DNS entry ID. type: int required: True
- ip - IPv4 address of the host. type: str
- ipv6 - IPv6 address of the host. type: str
- preference - DNS entry preference, 0 is the highest preference (0 - 65535) type: int
- status - Enable/disable resource record status. type: str choices: enable, disable
- ttl - Time-to-live for this entry (0 to 2147483647 sec). type: int
- type - Resource record type. type: str choices: A, NS, CNAME, MX, AAAA, PTR, PTR_V6
- domain - Domain name. type: str
- forwarder - DNS zone forwarder IP address list. type: str
- ip_master - IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone. type: str
- name - Zone name. type: str required: True
- primary_name - Domain name of the default DNS server for this zone. type: str
- source_ip - Source IP for forwarding to DNS server. type: str
- status - Enable/disable this DNS zone. type: str choices: enable, disable
- ttl - Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec). type: int
- type - Zone type (master to manage entries directly, slave to import entries from other zones). type: str choices: master, slave
- view - Zone view (public to serve public clients, shadow to serve internal clients). type: str choices: shadow, public
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>"
name: "default_name_19"
primary_name: "<your_own_value>"
source_ip: "84.230.14.43"
status: "enable"
ttl: "23"
type: "master"
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