fortinet.fortimanager.fmgr_devprof_log_syslogd_setting module – Global settings for remote syslog server.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_log_syslogd_setting
.
New in fortinet.fortimanager 1.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
The parameter (devprof) in requested url. |
|
The top level parameters set. |
|
Certificate used to communicate with Syslog server. |
|
Enable/disable CSV formatting of logs. Choices:
|
|
Deprecated, please rename it to custom_field_name. Custom field name. |
|
Field custom name. |
|
Entry ID. |
|
Field name. |
|
Deprecated, please rename it to enc_algorithm. Enable/disable reliable syslogging with TLS encryption. Choices:
|
|
Remote syslog facility. Choices:
|
|
Log format. Choices:
|
|
Specify outgoing interface to reach server. |
|
Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server. Choices:
|
|
Deprecated, please rename it to max_log_rate. Syslog maximum log rate in MBps |
|
Remote syslog logging over UDP/Reliable TCP. Choices:
|
|
Server listen port. |
|
Set log transmission priority. Choices:
|
|
Enable/disable reliable logging Choices:
|
|
Address of remote syslog server. |
|
Deprecated, please rename it to source_ip. Source IP address of syslog. |
|
(list) Deprecated, please rename it to source_ip_interface. Source interface of syslog. |
|
Deprecated, please rename it to ssl_min_proto_version. Minimum supported protocol version for SSL/TLS connections Choices:
|
|
Enable/disable remote syslog logging. Choices:
|
|
Deprecated, please rename it to syslog_type. Syslog type. |
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Global settings for remote syslog server.
fortinet.fortimanager.fmgr_devprof_log_syslogd_setting:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
devprof: <your own value>
devprof_log_syslogd_setting:
certificate: <string>
enc_algorithm: <value in [high, low, disable, ...]>
facility: <value in [kernel, user, mail, ...]>
mode: <value in [udp, legacy-reliable, reliable]>
port: <integer>
server: <string>
ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
status: <value in [disable, enable]>
reliable: <value in [disable, enable]>
csv: <value in [disable, enable]>
max_log_rate: <integer>
priority: <value in [low, default]>
interface: <string>
interface_select_method: <value in [auto, sdwan, specify]>
format: <value in [default, csv, cef, ...]>
syslog_type: <integer>
custom_field_name:
-
custom: <string>
id: <integer>
name: <string>
source_ip: <string>
source_ip_interface: <list or string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |