fortiswitch_system_dns_database – Dns-database in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify system feature and dns_database category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

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

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_system_dns_database yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • 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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_dns_database - Dns-database. type: dict
    • allow_transfer - Dns zone transfer ip address list. type: str
    • authoritative - Authoritative zone. type: str choices: enable, disable
    • contact - Email address of the administrator for this zone you can specify only the username (e.g. admin)or full email address (e.g. admin .ca@test.com) when using simple username, the domain of the email will be this zone. type: str
    • dns_entry - Dns entry. type: list member_path: dns_entry:id
      • canonical_name - Canonical name. type: str
      • hostname - Hostname. type: str
      • id - Dns entry id. type: int required: true
      • ip - IPv4 address. type: str
      • ipv6 - IPv6 address. type: str
      • preference - 0 for the highest preference, range 0 to 65535. type: int
      • status - Resource record status. type: str choices: enable, disable
      • ttl - Time-to-live value in units of seconds for this entry, range 0 to 2147483647. type: int
      • type - Resource record type. type: str choices: A, NS, CNAME, MX, AAAA, PTR, PTR_V6
    • domain - Domain name. type: str
    • forwarder - Dns zone forwarder ip address list. type: str
    • ip_master - IP address of master DNS server to import entries of this zone. type: str
    • name - Zone name. type: str required: true
    • primary_name - Domain name of the default DNS server for this zone. type: str
    • source_ip - Source IP for forwarding to DNS server. type: str
    • status - Dns zone status. type: str choices: enable, disable
    • ttl - Default time-to-live value in units of seconds for the entries of this zone, range 0 to 2147483647. type: int
    • type - Zone type ("master" to manage entries directly, "slave" to import entries from outside). type: str choices: master, slave
    • view - Zone view ("public" to server public clients, "shadow" to serve internal clients). type: str choices: shadow, public

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Dns-database.
    fortiswitch_system_dns_database:
      state: "present"
      system_dns_database:
        allow_transfer: "<your_own_value>"
        authoritative: "enable"
        contact: "<your_own_value>"
        dns_entry:
         -
            canonical_name: "<your_own_value>"
            hostname: "myhostname"
            id:  "9"
            ip: "<your_own_value>"
            ipv6: "<your_own_value>"
            preference: "12"
            status: "enable"
            ttl: "14"
            type: "A"
        domain: "<your_own_value>"
        forwarder: "<your_own_value>"
        ip_master: "<your_own_value>"
        name: "default_name_19"
        primary_name: "<your_own_value>"
        source_ip: "84.230.14.43"
        status: "enable"
        ttl: "23"
        type: "master"
        view: "shadow"

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 fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch 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
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.