:source: fortiswitch_system_dns_database.py

:orphan:

.. fortiswitch_system_dns_database:

fortiswitch_system_dns_database -- Dns-database in Fortinet's FortiSwitch
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 1.0.0

.. contents::
   :local:
   :depth: 1


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


FortiSwitch Version Compatibility
---------------------------------


.. raw:: html

 <br>
 <table border="1">
 <tr>
 <td></td><td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>fortiswitch_system_dns_database</td>
 <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td>
 </tr>
 </table>
 <p>



Parameters
----------


.. raw:: html

    <ul>
    <li> <span class="li-head">enable_log</span> - Enable/Disable logging for task. <span class="li-normal">type: bool</span> <span class="li-required">required: false</span> <span class="li-normal">default: False</span> </li>
    <li> <span class="li-head">member_path</span> - Member attribute path to operate on. <span class="li-normal">type: str</span> </li>
    <li> <span class="li-head">member_state</span> - Add or delete a member under specified attribute path. <span class="li-normal">type: str</span> <span class="li-normal">choices: present, absent</span> </li>
    <li> <span class="li-head">state</span> - Indicates whether to create or remove the object. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <span class="li-normal">choices: present, absent</span> </li>
    <li> <span class="li-head">system_dns_database</span> - Dns-database. <span class="li-normal">type: dict</span> </li>
        <ul class="ul-self">
        <li> <span class="li-head">allow_transfer</span> - Dns zone transfer ip address list. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">authoritative</span> - Authoritative zone. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> </li>
        <li> <span class="li-head">contact</span> - Email address of the administrator for this zone <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">dns_entry</span> - Dns entry. <span class="li-normal">type: list</span> </li>
            <ul class="ul-self">
            <li> <span class="li-head">canonical_name</span> - Canonical name. <span class="li-normal">type: str</span> </li>
            <li> <span class="li-head">hostname</span> - Hostname. <span class="li-normal">type: str</span> </li>
            <li> <span class="li-head">id</span> - Dns entry id. <span class="li-normal">type: int</span> </li>
            <li> <span class="li-head">ip</span> - IPv4 address. <span class="li-normal">type: str</span> </li>
            <li> <span class="li-head">ipv6</span> - IPv6 address. <span class="li-normal">type: str</span> </li>
            <li> <span class="li-head">preference</span> - 0 for the highest preference, range 0 to 65535. <span class="li-normal">type: int</span> </li>
            <li> <span class="li-head">status</span> - Resource record status. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> </li>
            <li> <span class="li-head">ttl</span> - Time-to-live value in units of seconds for this entry, range 0 to 2147483647. <span class="li-normal">type: int</span> </li>
            <li> <span class="li-head">type</span> - Resource record type. <span class="li-normal">type: str</span> <span class="li-normal">choices: A, NS, CNAME, MX, AAAA, PTR, PTR_V6</span> </li>
            </ul>
        <li> <span class="li-head">domain</span> - Domain name. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">forwarder</span> - Dns zone forwarder ip address list. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">ip_master</span> - IP address of master DNS server to import entries of this zone. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">name</span> - Zone name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> </li>
        <li> <span class="li-head">primary_name</span> - Domain name of the default DNS server for this zone. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">source_ip</span> - Source IP for forwarding to DNS server. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">status</span> - Dns zone status. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> </li>
        <li> <span class="li-head">ttl</span> - Default time-to-live value in units of seconds for the entries of this zone, range 0 to 2147483647. <span class="li-normal">type: int</span> </li>
        <li> <span class="li-head">type</span> - Zone type ("master" to manage entries directly, "slave" to import entries from outside). <span class="li-normal">type: str</span> <span class="li-normal">choices: master, slave</span> </li>
        <li> <span class="li-head">view</span> - Zone view ("public" to server public clients, "shadow" to serve internal clients). <span class="li-normal">type: str</span> <span class="li-normal">choices: shadow, public</span> </li>
        </ul>
    </ul>


Examples
--------

.. code-block:: yaml+jinja
    
    - name: Dns-database.
      fortinet.fortiswitch.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: "32767"
                      status: "enable"
                      ttl: "1073741823"
                      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: "<your_own_value>"
              status: "enable"
              ttl: "1073741823"
              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:

.. raw:: html

    <ul>

    <li> <span class="li-return">build</span> - Build number of the fortiSwitch image <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: 1547</span></li>
    <li> <span class="li-return">http_method</span> - Last method used to provision the content into FortiSwitch <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: PUT</span></li>
    <li> <span class="li-return">http_status</span> - Last result given by FortiSwitch on last operation applied <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: 200</span></li>
    <li> <span class="li-return">mkey</span> - Master key (id) used in the last call to FortiSwitch <span class="li-normal">returned: success</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: id</span></li>
    <li> <span class="li-return">name</span> - Name of the table used to fulfill the request <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: urlfilter</span></li>
    <li> <span class="li-return">path</span> - Path of the table used to fulfill the request <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: webfilter</span></li>
    <li> <span class="li-return">serial</span> - Serial number of the unit <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: FS1D243Z13000122</span></li>
    <li> <span class="li-return">status</span> - Indication of the operation's result <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: success</span></li>
    <li> <span class="li-return">version</span> - Version of the FortiSwitch <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: v7.0.0</span></li>
    </ul>

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, feel free to create a pull request to improve it.