fortinet.fortios.fortios_system_ntp – Configure system NTP information in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.
To use it in a playbook, specify: fortinet.fortios.fortios_system_ntp.
New in version 2.10: 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 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.9.0
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
||
| system_ntp
dictionary
|
Configure system NTP information.
|
|||
| authentication
string
|
|
Enable/disable authentication.
|
||
| interface
list / elements=string
|
FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services.
|
|||
| interface_name
string
|
Interface name. Source system.interface.name.
|
|||
| key
string
|
Key for authentication.
|
|||
| key_id
integer
|
Key ID for authentication.
|
|||
| key_type
string
|
|
Key type for authentication (MD5, SHA1).
|
||
| ntpserver
list / elements=string
|
Configure the FortiGate to connect to any available third-party NTP server.
|
|||
| authentication
string
|
|
Enable/disable MD5 authentication.
|
||
| id
integer / required
|
NTP server ID.
|
|||
| interface
string
|
Specify outgoing interface to reach server. Source system.interface.name.
|
|||
| interface_select_method
string
|
|
Specify how to select outgoing interface to reach server.
|
||
| key
string
|
Key for MD5 authentication.
|
|||
| key_id
integer
|
Key ID for authentication.
|
|||
| ntpv3
string
|
|
Enable to use NTPv3 instead of NTPv4.
|
||
| server
string
|
IP address or hostname of the NTP Server.
|
|||
| ntpsync
string
|
|
Enable/disable setting the FortiGate system time by synchronizing with an NTP Server.
|
||
| server_mode
string
|
|
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.
|
||
| source_ip
string
|
Source IP address for communication to the NTP server.
|
|||
| source_ip6
string
|
Source IPv6 address for communication to the NTP server.
|
|||
| syncinterval
integer
|
NTP synchronization interval (1 - 1440 min).
|
|||
| type
string
|
|
Use the FortiGuard NTP server or any other available NTP Server.
|
||
| 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 system NTP information.
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: "7"
key_type: "MD5"
ntpserver:
-
authentication: "enable"
id: "11"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
key: "<your_own_value>"
key_id: "15"
ntpv3: "enable"
server: "192.168.100.40"
ntpsync: "enable"
server_mode: "enable"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
syncinterval: "22"
type: "fortiguard"
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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_ntp_module.html