fortios_system_ddns – Configure DDNS in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


  • 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


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

  • ansible>=2.14


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

FortiOS Version Compatibility

Supported Version Ranges
fortios_system_ddns v6.0.0 -> latest


  • 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...
    • addr_type - Address type of interface address in DDNS update. type: str choices: ipv4, ipv6 more...
    • bound_ip - Bound IP address. type: str more...
    • clear_text - Enable/disable use of clear text connections. type: str choices: disable, enable more...
    • ddns_auth - Enable/disable TSIG authentication for your DDNS server. type: str choices: disable, tsig more...
    • ddns_domain - Your fully qualified domain name. For example, type: str more...
    • ddns_key - DDNS update key (base 64 encoding). type: str more...
    • ddns_keyname - DDNS update key name. type: str more...
    • ddns_password - DDNS password. type: str more...
    • ddns_server - Select a DDNS service provider. type: str choices:,,,,,,,, genericDDNS, FortiGuardDDNS, more...
    • ddns_server_addr - Generic DDNS server IP/FQDN list. type: list member_path: ddns_server_addr:addr more...
      • addr - IP address or FQDN of the server. type: str required: true more...
    • ddns_server_ip - Generic DDNS server IP. type: str more...
    • ddns_sn - DDNS Serial Number. type: str more...
    • ddns_ttl - Time-to-live for DDNS packets. type: int more...
    • ddns_username - DDNS user name. type: str more...
    • ddns_zone - Zone of your domain name (for example, type: str more...
    • ddnsid - DDNS ID. see Notes. type: int required: true more...
    • monitor_interface - Monitored interface. type: list member_path: monitor_interface:interface_name more...
      • interface_name - Interface name. Source type: str required: true more...
    • server_type - Address type of the DDNS server. type: str choices: ipv4, ipv6 more...
    • ssl_certificate - Name of local certificate for SSL connections. Source type: str more...
    • update_interval - DDNS update interval (60 - 2592000 sec, 0 means default). type: int more...
    • use_public_ip - Enable/disable use of public IP address. type: str choices: disable, enable more...



  • 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


- name: Configure DDNS.
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
          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: ""
                  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>"
                  interface_name: "<your_own_value> (source"
          server_type: "ipv4"
          ssl_certificate: "<your_own_value> (source"
          update_interval: "300"
          use_public_ip: "disable"

Return Values

Common return values are documented:, 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:
  • 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


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


  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)


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