fortinet.fortios.fortios_system_ntp module – Configure system NTP information 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_ntp
.
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 ntp 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:
|
|
Configure system NTP information. |
|
Enable/disable authentication. Choices:
|
|
FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. |
|
Interface name. Source system.interface.name. |
|
Key for authentication. |
|
Key ID for authentication. |
|
Key type for authentication (MD5, SHA1, SHA256). Choices:
|
|
Configure the FortiGate to connect to any available third-party NTP server. |
|
Enable/disable authentication. Choices:
|
|
NTP server ID. see <a href=’#notes’>Notes</a>. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Choose to connect to IPv4 or/and IPv6 NTP server. Choices:
|
|
Key for MD5(NTPv3)/SHA1(NTPv4)/SHA256(NTPv4) authentication. |
|
Key ID for authentication. |
|
Select NTP authentication type. Choices:
|
|
Enable to use NTPv3 instead of NTPv4. Choices:
|
|
IP address or hostname of the NTP Server. |
|
Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Choices:
|
|
Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Choices:
|
|
Source IP address for communication to the NTP server. |
|
Source IPv6 address for communication to the NTP server. |
|
NTP synchronization interval (1 - 1440 min). |
|
Use the FortiGuard NTP server or any other available NTP Server. 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
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure system NTP information.
fortinet.fortios.fortios_system_ntp:
vdom: "{{ vdom }}"
system_ntp:
authentication: "enable"
interface:
-
interface_name: "<your_own_value> (source system.interface.name)"
key: "<your_own_value>"
key_id: "0"
key_type: "MD5"
ntpserver:
-
authentication: "enable"
id: "11"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ip_type: "IPv6"
key: "<your_own_value>"
key_id: "0"
key_type: "MD5"
ntpv3: "enable"
server: "192.168.100.40"
ntpsync: "enable"
server_mode: "enable"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
syncinterval: "60"
type: "fortiguard"
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: |