fortinet.fortios.fortios_system_ntp (2.3.6) — module

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

| "added in version" 2.0.0 of fortinet.fortios"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
                  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"

Inputs

    
vdom:
    default: root
    description:
    - 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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

system_ntp:
    default: null
    description:
    - Configure system NTP information.
    suboptions:
      authentication:
        choices:
        - enable
        - disable
        description:
        - Enable/disable authentication.
        type: str
      interface:
        description:
        - FortiGate interface(s) with NTP server mode enabled. Devices on your network
          can contact these interfaces for NTP services.
        elements: dict
        suboptions:
          interface_name:
            description:
            - Interface name. Source system.interface.name.
            required: true
            type: str
        type: list
      key:
        description:
        - Key for authentication.
        type: str
      key_id:
        description:
        - Key ID for authentication.
        type: int
      key_type:
        choices:
        - MD5
        - SHA1
        description:
        - Key type for authentication (MD5, SHA1).
        type: str
      ntpserver:
        description:
        - Configure the FortiGate to connect to any available third-party NTP server.
        elements: dict
        suboptions:
          authentication:
            choices:
            - enable
            - disable
            description:
            - Enable/disable MD5(NTPv3)/SHA1(NTPv4) authentication.
            type: str
          id:
            description:
            - NTP server ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          interface:
            description:
            - Specify outgoing interface to reach server. Source system.interface.name.
            type: str
          interface_select_method:
            choices:
            - auto
            - sdwan
            - specify
            description:
            - Specify how to select outgoing interface to reach server.
            type: str
          ip_type:
            choices:
            - IPv6
            - IPv4
            - Both
            description:
            - Choose to connect to IPv4 or/and IPv6 NTP server.
            type: str
          key:
            description:
            - Key for MD5(NTPv3)/SHA1(NTPv4) authentication.
            type: str
          key_id:
            description:
            - Key ID for authentication.
            type: int
          ntpv3:
            choices:
            - enable
            - disable
            description:
            - Enable to use NTPv3 instead of NTPv4.
            type: str
          server:
            description:
            - IP address or hostname of the NTP Server.
            type: str
        type: list
      ntpsync:
        choices:
        - enable
        - disable
        description:
        - Enable/disable setting the FortiGate system time by synchronizing with an NTP
          Server.
        type: str
      server_mode:
        choices:
        - enable
        - disable
        description:
        - 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
      source_ip:
        description:
        - Source IP address for communication to the NTP server.
        type: str
      source_ip6:
        description:
        - Source IPv6 address for communication to the NTP server.
        type: str
      syncinterval:
        description:
        - NTP synchronization interval (1 - 1440 min).
        type: int
      type:
        choices:
        - fortiguard
        - custom
        description:
        - Use the FortiGuard NTP server or any other available NTP Server.
        type: str
    type: dict

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str