fortinet.fortios.fortios_system_ptp (2.3.6) — module

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 ptp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure system PTP information.
  fortinet.fortios.fortios_system_ptp:
      vdom: "{{ vdom }}"
      system_ptp:
          delay_mechanism: "E2E"
          interface: "<your_own_value> (source system.interface.name)"
          mode: "multicast"
          request_interval: "1"
          server_interface:
              -
                  delay_mechanism: "E2E"
                  id: "9"
                  server_interface_name: "<your_own_value> (source system.interface.name)"
          server_mode: "enable"
          status: "enable"

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_ptp:
    default: null
    description:
    - Configure system PTP information.
    suboptions:
      delay_mechanism:
        choices:
        - E2E
        - P2P
        description:
        - End to end delay detection or peer to peer delay detection.
        type: str
      interface:
        description:
        - PTP client will reply through this interface. Source system.interface.name.
        type: str
      mode:
        choices:
        - multicast
        - hybrid
        description:
        - Multicast transmission or hybrid transmission.
        type: str
      request_interval:
        description:
        - The delay request value is the logarithmic mean interval in seconds between
          the delay request messages sent by the slave to the master.
        type: int
      server_interface:
        description:
        - FortiGate interface(s) with PTP server mode enabled. Devices on your network
          can contact these interfaces for PTP services.
        elements: dict
        suboptions:
          delay_mechanism:
            choices:
            - E2E
            - P2P
            description:
            - End to end delay detection or peer to peer delay detection.
            type: str
          id:
            description:
            - ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          server_interface_name:
            description:
            - Interface name. Source system.interface.name.
            type: str
        type: list
      server_mode:
        choices:
        - enable
        - disable
        description:
        - Enable/disable FortiGate PTP server mode. Your FortiGate becomes an PTP server
          for other devices on your network.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable setting the FortiGate system time by synchronizing with an PTP
          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