fortinet.fortios.fortios_system_ddns module – Configure DDNS in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_ddns
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure DDNS. |
|
Address type of interface address in DDNS update. Choices:
|
|
Bound IP address. |
|
Enable/disable use of clear text connections. Choices:
|
|
Enable/disable TSIG authentication for your DDNS server. Choices:
|
|
Your fully qualified domain name. For example, yourname.ddns.com. |
|
DDNS update key (base 64 encoding). |
|
DDNS update key name. |
|
DDNS password. |
|
Select a DDNS service provider. Choices:
|
|
Generic DDNS server IP/FQDN list. |
|
IP address or FQDN of the server. |
|
Generic DDNS server IP. |
|
DDNS Serial Number. |
|
Time-to-live for DDNS packets. |
|
DDNS user name. |
|
Zone of your domain name (for example, DDNS.com). |
|
DDNS ID. see <a href=’#notes’>Notes</a>. |
|
Monitored interface. |
|
Interface name. Source system.interface.name. |
|
Address type of the DDNS server. Choices:
|
|
Name of local certificate for SSL connections. Source certificate.local.name. |
|
DDNS update interval (60 - 2592000 sec, 0 means default). |
|
Enable/disable use of public IP address. Choices:
|
|
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. Default: |
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
The module supports check_mode.
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 here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |