fortinet.fortios.fortios_system_vdom_dns – Configure DNS servers for a non-management VDOM in Fortinet’s FortiOS and FortiGate.

Note

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

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

New in version 2.10: of fortinet.fortios

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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

system_vdom_dns

dictionary

Configure DNS servers for a non-management VDOM.

alt_primary

string

Alternate primary DNS server. (This is not used as a failover DNS server.)

alt_secondary

string

Alternate secondary DNS server. (This is not used as a failover DNS server.)

dns_over_tls

string

Enable/disable/enforce DNS over TLS.

Choices:

  • disable

  • enable

  • enforce

interface

string

Specify outgoing interface to reach server. Source system.interface.name.

interface_select_method

string

Specify how to select outgoing interface to reach server.

Choices:

  • auto

  • sdwan

  • specify

ip6_primary

string

Primary IPv6 DNS server IP address for the VDOM.

ip6_secondary

string

Secondary IPv6 DNS server IP address for the VDOM.

primary

string

Primary DNS server IP address for the VDOM.

protocol

list / elements=string

DNS protocols.

Choices:

  • cleartext

  • dot

  • doh

secondary

string

Secondary DNS server IP address for the VDOM.

server_hostname

list / elements=string

DNS server host name list.

hostname

string / required

DNS server host name list separated by space (maximum 4 domains).

server_select_method

string

Specify how configured servers are prioritized.

Choices:

  • least-rtt

  • failover

source_ip

string

Source IP for communications with the DNS server.

ssl_certificate

string

Name of local certificate for SSL connections. Source certificate.local.name.

vdom_dns

string

Enable/disable configuring DNS servers for the current VDOM.

Choices:

  • enable

  • disable

vdom

string

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: “root”

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_system_vdom_dns
    fortios_system_vdom_dns:
      vdom: root
      system_vdom_dns:
        dns_over_tls: disable
        interface_select_method: auto
        ip6_primary: '::'
        ip6_secondary: '::'
        primary: 0.0.0.0
        secondary: 0.0.0.0
        source_ip: 0.0.0.0
        ssl_certificate: Fortinet_Factory
        vdom_dns: disable

Return Values

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

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

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)