fortinet.fortios.fortios_system_vdom_dns (1.1.7) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

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

Requirements

• ansible>=2.9.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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:
        dns_over_tls: "disable"
        ip6_primary: "<your_own_value>"
        ip6_secondary: "<your_own_value>"
        primary: "<your_own_value>"
        secondary: "<your_own_value>"
        server_hostname:
         -
            hostname: "myhostname"
        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

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

system_vdom_dns:
    default: null
    description:
    - Configure DNS servers for a non-management VDOM.
    suboptions:
      dns_over_tls:
        choices:
        - disable
        - enable
        - enforce
        description:
        - Enable/disable/enforce DNS over TLS.
        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
      secondary:
        description:
        - Secondary DNS server IP address for the VDOM.
        type: str
      server_hostname:
        description:
        - DNS server host name list.
        suboptions:
          hostname:
            description:
            - DNS server host name list separated by space (maximum 4 domains).
            required: true
            type: str
        type: list
      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