fortinet.fortios.fortios_log_syslogd3_setting – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_log_syslogd3_setting
.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd3 feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
log_syslogd3_setting dictionary | Global settings for remote syslog server. | |||
certificate string | Certificate used to communicate with Syslog server. Source certificate.local.name. | |||
custom_field_name list / elements=string | Custom field name for CEF format logging. | |||
custom string | Field custom name. | |||
id integer / required | Entry ID. | |||
name string | Field name. | |||
enc_algorithm string |
| Enable/disable reliable syslogging with TLS encryption. | ||
facility string |
| Remote syslog facility. | ||
format string |
| Log format. | ||
interface string | Specify outgoing interface to reach server. Source system.interface.name. | |||
interface_select_method string |
| Specify how to select outgoing interface to reach server. | ||
max_log_rate integer | Syslog maximum log rate in MBps (0 = unlimited). | |||
mode string |
| Remote syslog logging over UDP/Reliable TCP. | ||
port integer | Server listen port. | |||
priority string |
| Set log transmission priority. | ||
server string | Address of remote syslog server. | |||
source_ip string | Source IP address of syslog. | |||
ssl_min_proto_version string |
| Minimum supported protocol version for SSL/TLS connections . | ||
status string |
| Enable/disable remote syslog logging. | ||
syslog_type integer | Hidden setting index of Syslog. | |||
vdom string | Default: "root" | 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. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Global settings for remote syslog server. fortios_log_syslogd3_setting: vdom: "{{ vdom }}" log_syslogd3_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: "13" mode: "udp" port: "15" priority: "default" server: "192.168.100.40" source_ip: "84.230.14.43" ssl_min_proto_version: "default" status: "enable" syslog_type: "21"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_log_syslogd3_setting_module.html