fortios_system_ddns.rst

source:	fortios_system_ddns.py
orphan:

fortios_system_ddns -- Configure DDNS in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

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

Requirements

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

• ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_system_ddns	v6.0.0 -> latest

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - 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 default: root
• 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_ddns - Configure DDNS. type: dict more...

  	Supported Version Ranges
  system_ddns	v6.0.0 -> latest

• addr_type - Address type of interface address in DDNS update. type: str choices: ipv4, ipv6 more...

  	Supported Version Ranges
  addr_type	v7.0.0 -> latest
  [ipv4]	v6.0.0 -> latest
  [ipv6]	v6.0.0 -> latest

• bound_ip - Bound IP address. type: str more...

  	Supported Version Ranges
  bound_ip	v6.0.0 -> v7.0.5	v7.2.0 -> v7.2.0

• clear_text - Enable/disable use of clear text connections. type: str choices: disable, enable more...

  	Supported Version Ranges
  clear_text	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• ddns_auth - Enable/disable TSIG authentication for your DDNS server. type: str choices: disable, tsig more...

  	Supported Version Ranges
  ddns_auth	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [tsig]	v6.0.0 -> latest

• ddns_domain - Your fully qualified domain name. For example, yourname.ddns.com. type: str more...

  	Supported Version Ranges
  ddns_domain	v6.0.0 -> latest

• ddns_key - DDNS update key (base 64 encoding). type: str more...

  	Supported Version Ranges
  ddns_key	v6.0.0 -> latest

• ddns_keyname - DDNS update key name. type: str more...

  	Supported Version Ranges
  ddns_keyname	v6.0.0 -> latest

• ddns_password - DDNS password. type: str more...

  	Supported Version Ranges
  ddns_password	v6.0.0 -> latest

• ddns_server - Select a DDNS service provider. type: str choices: dyndns.org, dyns.net, tzo.com, vavic.com, dipdns.net, now.net.cn, dhs.org, easydns.com, genericDDNS, FortiGuardDDNS, noip.com more...

  	Supported Version Ranges
  ddns_server	v6.0.0 -> latest
  [dyndns.org]	v6.0.0 -> latest
  [dyns.net]	v6.0.0 -> latest
  [tzo.com]	v6.0.0 -> latest
  [vavic.com]	v6.0.0 -> latest
  [dipdns.net]	v6.0.0 -> latest
  [now.net.cn]	v6.0.0 -> latest
  [dhs.org]	v6.0.0 -> latest
  [easydns.com]	v6.0.0 -> latest
  [genericDDNS]	v6.0.0 -> latest
  [FortiGuardDDNS]	v6.0.0 -> latest
  [noip.com]	v6.0.0 -> latest

• ddns_server_addr - Generic DDNS server IP/FQDN list. type: list member_path: ddns_server_addr:addr more...

  	Supported Version Ranges
  ddns_server_addr	v7.0.0 -> latest

• addr - IP address or FQDN of the server. type: str required: true more...

  	Supported Version Ranges
  addr	v7.0.0 -> latest

• ddns_server_ip - Generic DDNS server IP. type: str more...

  	Supported Version Ranges
  ddns_server_ip	v6.0.0 -> v6.4.4

• ddns_sn - DDNS Serial Number. type: str more...

  	Supported Version Ranges
  ddns_sn	v6.0.0 -> latest

• ddns_ttl - Time-to-live for DDNS packets. type: int more...

  	Supported Version Ranges
  ddns_ttl	v6.0.0 -> latest

• ddns_username - DDNS user name. type: str more...

  	Supported Version Ranges
  ddns_username	v6.0.0 -> latest

• ddns_zone - Zone of your domain name (for example, DDNS.com). type: str more...

  	Supported Version Ranges
  ddns_zone	v6.0.0 -> latest

• ddnsid - DDNS ID. see Notes. type: int required: true more...

  	Supported Version Ranges
  ddnsid	v6.0.0 -> latest

• monitor_interface - Monitored interface. type: list member_path: monitor_interface:interface_name more...

  	Supported Version Ranges
  monitor_interface	v6.0.0 -> latest

• interface_name - Interface name. Source system.interface.name. type: str required: true more...

  	Supported Version Ranges
  interface_name	v6.0.0 -> latest

• server_type - Address type of the DDNS server. type: str choices: ipv4, ipv6 more...

  	Supported Version Ranges
  server_type	v7.0.0 -> latest
  [ipv4]	v6.0.0 -> latest
  [ipv6]	v6.0.0 -> latest

• ssl_certificate - Name of local certificate for SSL connections. Source certificate.local.name. type: str more...

  	Supported Version Ranges
  ssl_certificate	v6.0.0 -> latest

• update_interval - DDNS update interval (60 - 2592000 sec, 0 means default). type: int more...

  	Supported Version Ranges
  update_interval	v6.0.0 -> latest

• use_public_ip - Enable/disable use of public IP address. type: str choices: disable, enable more...

  	Supported Version Ranges
  use_public_ip	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

Notes

Note

• We highly recommend using your own value as the ddnsid instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure DDNS.
  fortinet.fortios.fortios_system_ddns:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_ddns:
          addr_type: "ipv4"
          bound_ip: "<your_own_value>"
          clear_text: "disable"
          ddns_auth: "disable"
          ddns_domain: "<your_own_value>"
          ddns_key: "<your_own_value>"
          ddns_keyname: "<your_own_value>"
          ddns_password: "<your_own_value>"
          ddns_server: "dyndns.org"
          ddns_server_addr:
              -
                  addr: "<your_own_value>"
          ddns_server_ip: "<your_own_value>"
          ddns_sn: "<your_own_value>"
          ddns_ttl: "300"
          ddns_username: "<your_own_value>"
          ddns_zone: "<your_own_value>"
          ddnsid: "<you_own_value>"
          monitor_interface:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          server_type: "ipv4"
          ssl_certificate: "<your_own_value> (source certificate.local.name)"
          update_interval: "300"
          use_public_ip: "disable"

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 fortigate image returned: always type: str sample: 1547
• http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
• http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
• mkey - Master key (id) used in the last call to FortiGate 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
• revision - Internal revision number returned: always type: str sample: 17.0.2.10658
• serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
• status - Indication of the operation's result returned: always type: str sample: success
• vdom - Virtual domain used returned: always type: str sample: root
• version - Version of the FortiGate returned: always type: str sample: v5.6.3

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)
• Nicolas Thomas (@thomnico)

Hint

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