fortios_system_ntp – Configure system NTP information in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- system_ntp - Configure system NTP information. type: dict
- interface - FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. type: list
- interface_name - Interface name. Source system.interface.name. type: str
- ntpserver - Configure the FortiGate to connect to any available third-party NTP server. type: list
- authentication - Enable/disable MD5 authentication. type: str choices: enable, disable
- id - NTP server ID. type: int required: True
- key - Key for MD5 authentication. type: str
- key_id - Key ID for authentication. type: int
- ntpv3 - Enable to use NTPv3 instead of NTPv4. type: str choices: enable, disable
- server - IP address or hostname of the NTP Server. type: str
- ntpsync - Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. type: str choices: enable, disable
- server_mode - 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. type: str choices: enable, disable
- source_ip - Source IP for communications to the NTP server. type: str
- syncinterval - NTP synchronization interval (1 - 1440 min). type: int
- type - Use the FortiGuard NTP server or any other available NTP Server. type: str choices: fortiguard, custom
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:
interface:
-
interface_name: "<your_own_value> (source system.interface.name)"
ntpserver:
-
authentication: "enable"
id: "7"
key: "<your_own_value>"
key_id: "9"
ntpv3: "enable"
server: "192.168.100.40"
ntpsync: "enable"
server_mode: "enable"
source_ip: "84.230.14.43"
syncinterval: "15"
type: "fortiguard"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, 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: 17.0.2.10658
- 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