fortios_system_vdom_dns – Configure DNS servers for a non-management VDOM 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 vdom_dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_system_vdom_dns | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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
- system_vdom_dns - Configure DNS servers for a non-management VDOM. type: dict more...
- alt_primary - Alternate primary DNS server. This is not used as a failover DNS server. type: str more...
- alt_secondary - Alternate secondary DNS server. This is not used as a failover DNS server. type: str more...
- dns_over_tls - Enable/disable/enforce DNS over TLS. type: str choices: disable, enable, enforce more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- ip6_primary - Primary IPv6 DNS server IP address for the VDOM. type: str more...
- ip6_secondary - Secondary IPv6 DNS server IP address for the VDOM. type: str more...
- primary - Primary DNS server IP address for the VDOM. type: str more...
- protocol - DNS transport protocols. type: list choices: cleartext, dot, doh more...
- secondary - Secondary DNS server IP address for the VDOM. type: str more...
- server_hostname - DNS server host name list. type: list member_path: server_hostname:hostname more...
- hostname - DNS server host name list separated by space (maximum 4 domains). type: str required: true more...
- server_select_method - Specify how configured servers are prioritized. type: str choices: least-rtt, failover more...
- source_ip - Source IP for communications with the DNS server. type: str more...
- ssl_certificate - Name of local certificate for SSL connections. Source certificate.local.name. type: str more...
- vdom_dns - Enable/disable configuring DNS servers for the current VDOM. type: str choices: enable, disable more...
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 servers for a non-management VDOM.
fortios_system_vdom_dns:
vdom: "{{ vdom }}"
system_vdom_dns:
alt_primary: "<your_own_value>"
alt_secondary: "<your_own_value>"
dns_over_tls: "disable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ip6_primary: "<your_own_value>"
ip6_secondary: "<your_own_value>"
primary: "<your_own_value>"
protocol: "cleartext"
secondary: "<your_own_value>"
server_hostname:
-
hostname: "myhostname"
server_select_method: "least-rtt"
source_ip: "84.230.14.43"
ssl_certificate: "<your_own_value> (source certificate.local.name)"
vdom_dns: "enable"
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