fortios_system_ntp.rst

source:	fortios_system_ntp.py
orphan:

fortios_system_ntp -- Configure system NTP information in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_system_ntp	v6.0.0 -> latest

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: 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
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• system_ntp - Configure system NTP information. type: dict more...

  	Supported Version Ranges
  system_ntp	v6.0.0 -> latest

• authentication - Enable/disable authentication. type: str choices: enable, disable more...

  	Supported Version Ranges
  authentication	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• interface - FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. type: list member_path: interface:interface_name more...

  	Supported Version Ranges
  interface	v6.0.0 -> latest

• interface_name - Interface name. Source system.interface.name. type: str required: true more...

  	Supported Version Ranges
  interface_name	v6.0.0 -> latest

• key - Key for authentication. type: str more...

  	Supported Version Ranges
  key	v6.2.0 -> latest

• key_id - Key ID for authentication. type: int more...

  	Supported Version Ranges
  key_id	v6.2.0 -> latest

• key_type - Key type for authentication (MD5, SHA1). type: str choices: MD5, SHA1 more...

  	Supported Version Ranges
  key_type	v6.2.0 -> latest
  [MD5]	v6.0.0 -> latest
  [SHA1]	v6.0.0 -> latest

• ntpserver - Configure the FortiGate to connect to any available third-party NTP server. type: list member_path: ntpserver:id more...

  	Supported Version Ranges
  ntpserver	v6.0.0 -> latest

• authentication - Enable/disable MD5(NTPv3)/SHA1(NTPv4) authentication. type: str choices: enable, disable more...

  	Supported Version Ranges
  authentication	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• id - NTP server ID. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...

  	Supported Version Ranges
  interface	v6.2.0 -> v6.2.0	v6.2.5 -> v6.4.0	v6.4.4 -> latest

• interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...

  	Supported Version Ranges
  interface_select_method	v6.2.0 -> v6.2.0	v6.2.5 -> v6.4.0	v6.4.4 -> latest
  [auto]	v6.0.0 -> latest
  [sdwan]	v6.0.0 -> latest
  [specify]	v6.0.0 -> latest

• key - Key for MD5(NTPv3)/SHA1(NTPv4) authentication. type: str more...

  	Supported Version Ranges
  key	v6.0.0 -> latest

• key_id - Key ID for authentication. type: int more...

  	Supported Version Ranges
  key_id	v6.0.0 -> latest

• ntpv3 - Enable to use NTPv3 instead of NTPv4. type: str choices: enable, disable more...

  	Supported Version Ranges
  ntpv3	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• server - IP address or hostname of the NTP Server. type: str more...

  	Supported Version Ranges
  server	v6.0.0 -> latest

• ntpsync - Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. type: str choices: enable, disable more...

  	Supported Version Ranges
  ntpsync	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 more...

  	Supported Version Ranges
  server_mode	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• source_ip - Source IP address for communication to the NTP server. type: str more...

  	Supported Version Ranges
  source_ip	v6.0.0 -> latest

• source_ip6 - Source IPv6 address for communication to the NTP server. type: str more...

  	Supported Version Ranges
  source_ip6	v6.0.0 -> latest

• syncinterval - NTP synchronization interval (1 - 1440 min). type: int more...

  	Supported Version Ranges
  syncinterval	v6.0.0 -> latest

• type - Use the FortiGuard NTP server or any other available NTP Server. type: str choices: fortiguard, custom more...

  	Supported Version Ranges
  type	v6.0.0 -> latest
  [fortiguard]	v6.0.0 -> latest
  [custom]	v6.0.0 -> latest

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"
                  key: "<your_own_value>"
                  key_id: "0"
                  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: 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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.