lix_fortinet.fortios.fortios_system_dns (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.9

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.
    fortios_system_dns:
      vdom:  "{{ vdom }}"
      system_dns:
        alt_primary: "<your_own_value>"
        alt_secondary: "<your_own_value>"
        cache_notfound_responses: "disable"
        dns_cache_limit: "5000"
        dns_cache_ttl: "1800"
        dns_over_tls: "disable"
        domain:
         -
            domain: "<your_own_value>"
        fqdn_cache_ttl: "0"
        fqdn_min_refresh: "60"
        interface: "<your_own_value> (source system.interface.name)"
        interface_select_method: "auto"
        ip6_primary: "<your_own_value>"
        ip6_secondary: "<your_own_value>"
        log: "disable"
        primary: "<your_own_value>"
        protocol: "cleartext"
        retry: "2"
        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)"
        timeout: "5"

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

system_dns:
    default: null
    description:
    - Configure DNS.
    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
      cache_notfound_responses:
        choices:
        - disable
        - enable
        description:
        - Enable/disable response from the DNS server when a record is not in cache.
        type: str
      dns_cache_limit:
        description:
        - Maximum number of records in the DNS cache.
        type: int
      dns_cache_ttl:
        description:
        - Duration in seconds that the DNS cache retains information.
        type: int
      dns_over_tls:
        choices:
        - disable
        - enable
        - enforce
        description:
        - Enable/disable/enforce DNS over TLS.
        type: str
      domain:
        description:
        - Search suffix list for hostname lookup.
        elements: dict
        suboptions:
          domain:
            description:
            - DNS search domain list separated by space (maximum 8 domains).
            type: str
        type: list
      fqdn_cache_ttl:
        description:
        - FQDN cache time to live in seconds (0 - 86400).
        type: int
      fqdn_min_refresh:
        description:
        - FQDN cache minimum refresh time in seconds (10 - 3600).
        type: int
      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 DNS server IPv6 address.
        type: str
      ip6_secondary:
        description:
        - Secondary DNS server IPv6 address.
        type: str
      log:
        choices:
        - disable
        - error
        - all
        description:
        - Local DNS log setting.
        type: str
      primary:
        description:
        - Primary DNS server IP address.
        type: str
      protocol:
        choices:
        - cleartext
        - dot
        - doh
        description:
        - DNS transport protocols.
        elements: str
        type: list
      retry:
        description:
        - Number of times to retry (0 - 5).
        type: int
      secondary:
        description:
        - Secondary DNS server IP address.
        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).
            type: str
        type: list
      server_select_method:
        choices:
        - least-rtt
        - failover
        description:
        - Specify how configured servers are prioritized.
        type: str
      source_ip:
        description:
        - IP address used by the DNS server as its source IP.
        type: str
      ssl_certificate:
        description:
        - Name of local certificate for SSL connections. Source certificate.local.name.
        type: str
      timeout:
        description:
        - DNS query timeout interval in seconds (1 - 10).
        type: int
    type: dict

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

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