fmgr_devprof_log_syslogd_setting – Global settings for remote syslog server.¶
New in version 2.10.
Synopsis¶
- 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}/log/syslogd/setting
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.10.0
Parameters¶
- 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] - Global settings for remote syslog server.
- option - Set fetch option for the request. type: str choices: [object member, chksum, datasrc]
- parameters for method: [set, update] - Global settings for remote syslog server.
- data - No description for the parameter type: dict
- certificate - Certificate used to communicate with Syslog server. type: str
- enc-algorithm - Enable/disable reliable syslogging with TLS encryption. type: str choices: [high, low, disable, high-medium]
- facility - Remote syslog facility. type: str choices: [kernel, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7]
- mode - Remote syslog logging over UDP/Reliable TCP. type: str choices: [udp, legacy-reliable, reliable]
- port - Server listen port. type: int
- server - Address of remote syslog server. type: str
- ssl-min-proto-version - Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). type: str choices: [default, TLSv1-1, TLSv1-2, SSLv3, TLSv1]
- status - Enable/disable remote syslog logging. type: str choices: [disable, enable]
Notes¶
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
Examples¶
- 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}/LOG/SYSLOGD/SETTING
fmgr_devprof_log_syslogd_setting:
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}/LOG/SYSLOGD/SETTING
fmgr_devprof_log_syslogd_setting:
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:
certificate: <value of string>
enc-algorithm: <value in [high, low, disable, ...]>
facility: <value in [kernel, user, mail, ...]>
mode: <value in [udp, legacy-reliable, reliable]>
port: <value of integer>
server: <value of string>
ssl-min-proto-version: <value in [default, TLSv1-1, TLSv1-2, ...]>
status: <value in [disable, enable]>
Return Values¶
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
- certificate - Certificate used to communicate with Syslog server. type: str
- enc-algorithm - Enable/disable reliable syslogging with TLS encryption. type: str
- facility - Remote syslog facility. type: str
- mode - Remote syslog logging over UDP/Reliable TCP. type: str
- port - Server listen port. type: int
- server - Address of remote syslog server. type: str
- ssl-min-proto-version - Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). type: str
- status - Enable/disable remote syslog logging. type: str
- 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}/log/syslogd/setting
- 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}/log/syslogd/setting