fortinet.fortios.fortios_system_vdom_dns (2.3.6) — module

Configure DNS servers for a non-management VDOM in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure DNS servers for a non-management VDOM.
  fortinet.fortios.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"

Inputs

    
vdom:
    default: root
    description:
    - 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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

system_vdom_dns:
    default: null
    description:
    - Configure DNS servers for a non-management VDOM.
    suboptions:
      alt_primary:
        description:
        - Alternate primary DNS server. This is not used as a failover DNS server.
        type: str
      alt_secondary:
        description:
        - Alternate secondary DNS server. This is not used as a failover DNS server.
        type: str
      dns_over_tls:
        choices:
        - disable
        - enable
        - enforce
        description:
        - Enable/disable/enforce DNS over TLS.
        type: str
      interface:
        description:
        - Specify outgoing interface to reach server. Source system.interface.name.
        type: str
      interface_select_method:
        choices:
        - auto
        - sdwan
        - specify
        description:
        - Specify how to select outgoing interface to reach server.
        type: str
      ip6_primary:
        description:
        - Primary IPv6 DNS server IP address for the VDOM.
        type: str
      ip6_secondary:
        description:
        - Secondary IPv6 DNS server IP address for the VDOM.
        type: str
      primary:
        description:
        - Primary DNS server IP address for the VDOM.
        type: str
      protocol:
        choices:
        - cleartext
        - dot
        - doh
        description:
        - DNS transport protocols.
        elements: str
        type: list
      secondary:
        description:
        - Secondary DNS server IP address for the VDOM.
        type: str
      server_hostname:
        description:
        - DNS server host name list.
        elements: dict
        suboptions:
          hostname:
            description:
            - DNS server host name list separated by space (maximum 4 domains).
            required: true
            type: str
        type: list
      server_select_method:
        choices:
        - least-rtt
        - failover
        description:
        - Specify how configured servers are prioritized.
        type: str
      source_ip:
        description:
        - Source IP for communications with the DNS server.
        type: str
      ssl_certificate:
        description:
        - Name of local certificate for SSL connections. Source certificate.local.name.
        type: str
      vdom_dns:
        choices:
        - enable
        - disable
        description:
        - Enable/disable configuring DNS servers for the current VDOM.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str