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

Note

This plugin is part of the fortinet.fortios collection (version 1.1.9).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_system_ddns.

New in version 2.9: of fortinet.fortios

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

Parameters

Parameter			Choices/Defaults	Comments
access_token string				Token-based authentication. Generated from GUI of Fortigate.
state string / required			Choices: present absent	Indicates whether to create or remove the object.
system_ddns dictionary				Configure DDNS.
	bound_ip string			Bound IP address.
	clear_text string		Choices: disable enable	Enable/disable use of clear text connections.
	ddns_auth string		Choices: disable tsig	Enable/disable TSIG authentication for your DDNS server.
	ddns_domain string			Your fully qualified domain name (for example, yourname.DDNS.com).
	ddns_key string			DDNS update key (base 64 encoding).
	ddns_keyname string			DDNS update key name.
	ddns_password string			DDNS password.
	ddns_server string		Choices: dyndns.org dyns.net tzo.com vavic.com dipdns.net now.net.cn dhs.org easydns.com genericDDNS FortiGuardDDNS noip.com	Select a DDNS service provider.
	ddns_server_ip string			Generic DDNS server IP.
	ddns_sn string			DDNS Serial Number.
	ddns_ttl integer			Time-to-live for DDNS packets.
	ddns_username string			DDNS user name.
	ddns_zone string			Zone of your domain name (for example, DDNS.com).
	ddnsid integer / required			DDNS ID.
	monitor_interface list / elements=string			Monitored interface.
		interface_name string		Interface name. Source system.interface.name.
	ssl_certificate string			Name of local certificate for SSL connections. Source certificate.local.name.
	update_interval integer			DDNS update interval (60 - 2592000 sec).
	use_public_ip string		Choices: disable enable	Enable/disable use of public IP address.
vdom string			Default: "root"	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.

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- 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 DDNS.
    fortios_system_ddns:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_ddns:
        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_ip: "<your_own_value>"
        ddns_sn: "<your_own_value>"
        ddns_ttl: "13"
        ddns_username: "<your_own_value>"
        ddns_zone: "<your_own_value>"
        ddnsid: "16"
        monitor_interface:
         -
            interface_name: "<your_own_value> (source system.interface.name)"
        ssl_certificate: "<your_own_value> (source certificate.local.name)"
        update_interval: "20"
        use_public_ip: "disable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate Sample: v5.6.3

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)