source: | fortios_log_syslogd2_setting.py |
---|---|
orphan: |
fortios_log_syslogd2_setting -- Global settings for remote syslog server in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd2 feature and setting 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_log_syslogd2_setting | v6.0.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
- log_syslogd2_setting - Global settings for remote syslog server. type: dict
more...
Supported Version Ranges log_syslogd2_setting v6.0.0 -> latest
- certificate - Certificate used to communicate with Syslog server. Source certificate.local.name. type: str
more...
Supported Version Ranges certificate v6.0.0 -> latest
- custom_field_name - Custom field name for CEF format logging. type: list member_path: custom_field_name:id
more...
Supported Version Ranges custom_field_name v6.0.0 -> latest
- custom - Field custom name [A-Za-z0-9_]. type: str
more...
Supported Version Ranges custom v6.0.0 -> latest
- id - Entry ID. see Notes. type: int required: true
more...
Supported Version Ranges id v6.0.0 -> latest
- name - Field name [A-Za-z0-9_]. type: str
more...
Supported Version Ranges name v6.0.0 -> latest
- enc_algorithm - Enable/disable reliable syslogging with TLS encryption. type: str choices: high-medium, high, low, disable
more...
Supported Version Ranges enc_algorithm v6.0.0 -> latest
[high-medium] v6.0.0 -> latest
[high] v6.0.0 -> latest
[low] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- 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
more...
Supported Version Ranges facility v6.0.0 -> latest
[kernel] v6.0.0 -> latest
[user] v6.0.0 -> latest
[mail] v6.0.0 -> latest
[daemon] v6.0.0 -> latest
[auth] v6.0.0 -> latest
[syslog] v6.0.0 -> latest
[lpr] v6.0.0 -> latest
[news] v6.0.0 -> latest
[uucp] v6.0.0 -> latest
[cron] v6.0.0 -> latest
[authpriv] v6.0.0 -> latest
[ftp] v6.0.0 -> latest
[ntp] v6.0.0 -> latest
[audit] v6.0.0 -> latest
[alert] v6.0.0 -> latest
[clock] v6.0.0 -> latest
[local0] v6.0.0 -> latest
[local1] v6.0.0 -> latest
[local2] v6.0.0 -> latest
[local3] v6.0.0 -> latest
[local4] v6.0.0 -> latest
[local5] v6.0.0 -> latest
[local6] v6.0.0 -> latest
[local7] v6.0.0 -> latest
- format - Log format. type: str choices: default, csv, cef, rfc5424, json
more...
Supported Version Ranges format v6.0.0 -> latest
[default] v6.0.0 -> latest
[csv] v6.0.0 -> latest
[cef] v6.0.0 -> latest
[rfc5424] v7.0.0 -> latest
[json] v7.4.1 -> latest
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str
more...
Supported Version Ranges interface v6.2.7 -> v6.4.0
v6.4.4 -> latest
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify
more...
Supported Version Ranges interface_select_method v6.2.7 -> v6.4.0
v6.4.4 -> latest
[auto] v6.0.0 -> latest
[sdwan] v6.0.0 -> latest
[specify] v6.0.0 -> latest
- max_log_rate - Syslog maximum log rate in MBps (0 = unlimited). type: int
more...
Supported Version Ranges max_log_rate v6.2.0 -> latest
- mode - Remote syslog logging over UDP/Reliable TCP. type: str choices: udp, legacy-reliable, reliable
more...
Supported Version Ranges mode v6.0.0 -> latest
[udp] v6.0.0 -> latest
[legacy-reliable] v6.0.0 -> latest
[reliable] v6.0.0 -> latest
- port - Server listen port. type: int
more...
Supported Version Ranges port v6.0.0 -> latest
- priority - Set log transmission priority. type: str choices: default, low
more...
Supported Version Ranges priority v6.2.0 -> latest
[default] v6.0.0 -> latest
[low] v6.0.0 -> latest
- server - Address of remote syslog server. type: str
more...
Supported Version Ranges server v6.0.0 -> latest
- source_ip - Source IP address of syslog. type: str
more...
Supported Version Ranges source_ip v6.0.0 -> latest
- ssl_min_proto_version - Minimum supported protocol version for SSL/TLS connections . type: str choices: default, SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3
more...
Supported Version Ranges ssl_min_proto_version v6.0.0 -> latest
[default] v6.0.0 -> latest
[SSLv3] v6.0.0 -> latest
[TLSv1] v6.0.0 -> latest
[TLSv1-1] v6.0.0 -> latest
[TLSv1-2] v6.0.0 -> latest
[TLSv1-3] v7.4.1 -> latest
- status - Enable/disable remote syslog logging. type: str choices: enable, disable
more...
Supported Version Ranges status v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- syslog_type - Hidden setting index of Syslog. type: int
more...
Supported Version Ranges syslog_type v6.2.3 -> v6.2.3
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Global settings for remote syslog server.
fortinet.fortios.fortios_log_syslogd2_setting:
vdom: "{{ vdom }}"
log_syslogd2_setting:
certificate: "<your_own_value> (source certificate.local.name)"
custom_field_name:
-
custom: "<your_own_value>"
id: "6"
name: "default_name_7"
enc_algorithm: "high-medium"
facility: "kernel"
format: "default"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
max_log_rate: "0"
mode: "udp"
port: "514"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "2147483647"
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.