fortiswitch_system_ntp – Ntp system info configuration in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch 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 v7.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_system_ntp yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • 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 - Ntp system info configuration. type: dict
    • allow_unsync_source - Enable/disable allowance of unsynchronized NTP server source. type: str choices: enable, disable
    • authentication - Enable/disable authentication. type: str choices: enable, disable
    • key - Key for authentication. type: str
    • key_id - Key ID for authentication. type: int
    • key_type - Key type for authentication (MD5, SHA1). type: str choices: MD5, SHA1
    • log_time_adjustments - Enable/disable logging of NTP time adjustments. type: str choices: enable, disable
    • ntpserver - NTP server. type: list member_path: ntpserver:id
      • authentication - Enable/disable MD5(NTPv3)/SHA1(NTPv4) authentication. type: str choices: enable, disable
      • id - Time server ID. type: int required: true
      • key - Key for MD5(NTPv3)/SHA1(NTPv4) 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/hostname of NTP server. type: str
    • ntpsync - Enable/disable synchronization with NTP server. type: str choices: enable, disable
    • server_mode - On Enabling, your FortiSwitch relays NTP requests to its configured NTP server. type: str choices: enable, disable
    • source_ip - Source IP for communications to NTP server. type: str
    • source_ip6 - Source IPv6 address for communication to the NTP server. type: str
    • syncinterval - NTP synchronization interval (1 - 1440) min. type: int

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Ntp system info configuration.
    fortiswitch_system_ntp:
      system_ntp:
        allow_unsync_source: "enable"
        authentication: "enable"
        key: "<your_own_value>"
        key_id: "6"
        key_type: "MD5"
        log_time_adjustments: "enable"
        ntpserver:
         -
            authentication: "enable"
            id:  "11"
            key: "<your_own_value>"
            key_id: "13"
            ntpv3: "enable"
            server: "192.168.100.40"
        ntpsync: "enable"
        server_mode: "enable"
        source_ip: "84.230.14.43"
        source_ip6: "<your_own_value>"
        syncinterval: "20"

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 fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch 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
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

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)

Hint

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