- source
fmgr_devprof_system_ntp.py
- orphan
2.10
- This module is able to configure a FortiManager device by allowing the user to [get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/devprof/{devprof}/system/ntp
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.10.0
- loose_validation - Do parameter validation in a loose way type: bool required: false default: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- devprof - the object name type: str
- parameters for method: [get] - Configure system NTP information.
- option - Set fetch option for the request. type: str choices: [object member, chksum, datasrc]
- parameters for method: [set, update] - Configure system NTP information.
- data - No description for the parameter type: dict
- ntpserver - No description for the parameter type: array
- authentication - Enable/disable MD5 authentication. type: str choices: [disable, enable]
- id - NTP server ID. type: int
- key - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- key-id - Key ID for authentication. type: int
- ntpv3 - Enable to use NTPv3 instead of NTPv4. type: str choices: [disable, enable]
- server - IP address or hostname of the NTP Server. type: str
- ntpsync - Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. type: str choices: [disable, enable]
- source-ip6 - Source IPv6 address for communication to the NTP server. type: str
- syncinterval - NTP synchronization interval (1 - 1440 min). type: int
- type - Use the FortiGuard NTP server or any other available NTP Server. type: str choices: [fortiguard, custom]
- ntpserver - No description for the parameter type: array
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/NTP
fmgr_devprof_system_ntp:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
devprof: <value of string>
params:
-
option: <value in [object member, chksum, datasrc]>
- name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/NTP
fmgr_devprof_system_ntp:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [set, update]>
url_params:
adom: <value in [none, global, custom dom]>
devprof: <value of string>
params:
-
data:
ntpserver:
-
authentication: <value in [disable, enable]>
id: <value of integer>
key:
- <value of string>
key-id: <value of integer>
ntpv3: <value in [disable, enable]>
server: <value of string>
ntpsync: <value in [disable, enable]>
source-ip6: <value of string>
syncinterval: <value of integer>
type: <value in [fortiguard, custom]>
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:
- return values for method: [get]
- data
- No description for the parameter type: dict
- ntpserver - No description for the parameter type: array
- authentication - Enable/disable MD5 authentication. type: str
- id - NTP server ID. type: int
- key - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- key-id - Key ID for authentication. type: int
- ntpv3 - Enable to use NTPv3 instead of NTPv4. type: str
- server - IP address or hostname of the NTP Server. type: str
- ntpsync - Enable/disable setting the FortiGate system time by synchronizing with an 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
- type - Use the FortiGuard NTP server or any other available NTP Server. type: str
- ntpserver - No description for the parameter type: array
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/devprof/{devprof}/system/ntp
- return values for method: [set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/devprof/{devprof}/system/ntp
- This module is not guaranteed to have a backwards compatible interface.
- Frank Shen (@fshen01)
- Link Zheng (@zhengl)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.