fortinet.fortios.fortios_system_ptp module – Configure system PTP information in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.1.6).

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

New in version 2.0.0: 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 ptp 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

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

system_ptp

dictionary

Configure system PTP information.

delay_mechanism

string

End to end delay detection or peer to peer delay detection.

Choices:

  • E2E

  • P2P

interface

string

PTP client will reply through this interface. Source system.interface.name.

mode

string

Multicast transmission or hybrid transmission.

Choices:

  • multicast

  • hybrid

request_interval

integer

The delay request value is the logarithmic mean interval in seconds between the delay request messages sent by the slave to the master.

server_interface

list / elements=dictionary

FortiGate interface(s) with PTP server mode enabled. Devices on your network can contact these interfaces for PTP services.

delay_mechanism

string

End to end delay detection or peer to peer delay detection.

Choices:

  • E2E

  • P2P

id

integer / required

ID.

server_interface_name

string

Interface name. Source system.interface.name.

server_mode

string

Enable/disable FortiGate PTP server mode. Your FortiGate becomes an PTP server for other devices on your network.

Choices:

  • enable

  • disable

status

string

Enable/disable setting the FortiGate system time by synchronizing with an PTP Server.

Choices:

  • enable

  • disable

vdom

string

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.

Default: “root”

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 PTP information.
    fortios_system_ptp:
      vdom:  "{{ vdom }}"
      system_ptp:
        delay_mechanism: "E2E"
        interface: "<your_own_value> (source system.interface.name)"
        mode: "multicast"
        request_interval: "6"
        server_interface:
         -
            delay_mechanism: "E2E"
            id:  "9"
            server_interface_name: "<your_own_value> (source system.interface.name)"
        server_mode: "enable"
        status: "enable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

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)