source: | fortios_system_ptp.py |
---|---|
orphan: |
.. versionadded:: 2.0.0
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_system_ptp | v6.2.0 -> latest |
- 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_ptp - Configure system PTP information. type: dict
more...
Supported Version Ranges system_ptp v6.2.0 -> latest
- delay_mechanism - End to end delay detection or peer to peer delay detection. type: str choices: E2E, P2P
more...
Supported Version Ranges delay_mechanism v6.2.0 -> latest
[E2E] v6.0.0 -> latest
[P2P] v6.0.0 -> latest
- interface - PTP client will reply through this interface. Source system.interface.name. type: str
more...
Supported Version Ranges interface v6.2.0 -> latest
- mode - Multicast transmission or hybrid transmission. type: str choices: multicast, hybrid
more...
Supported Version Ranges mode v6.2.0 -> latest
[multicast] v6.0.0 -> latest
[hybrid] v6.0.0 -> latest
- request_interval - 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
more...
Supported Version Ranges request_interval v6.2.0 -> latest
- server_interface - FortiGate interface(s) with PTP server mode enabled. Devices on your network can contact these interfaces for PTP services. type: list member_path: server_interface:id
more...
Supported Version Ranges server_interface v7.0.1 -> latest
- delay_mechanism - End to end delay detection or peer to peer delay detection. type: str choices: E2E, P2P
more...
Supported Version Ranges delay_mechanism v7.0.1 -> latest
[E2E] v6.0.0 -> latest
[P2P] v6.0.0 -> latest
- id - ID. see Notes. type: int required: true
more...
Supported Version Ranges id v7.0.1 -> latest
- server_interface_name - Interface name. Source system.interface.name. type: str
more...
Supported Version Ranges server_interface_name v7.0.1 -> latest
- server_mode - Enable/disable FortiGate PTP server mode. Your FortiGate becomes an PTP server for other devices on your network. type: str choices: enable, disable
more...
Supported Version Ranges server_mode v7.0.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- status - Enable/disable setting the FortiGate system time by synchronizing with an PTP Server. type: str choices: enable, disable
more...
Supported Version Ranges status v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- 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"
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
- This module is not guaranteed to have a backwards compatible interface.
- 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.