fortinet.fortios.fortios_log_syslogd4_setting module – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_log_syslogd4_setting
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd4 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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Global settings for remote syslog server. |
|
Certificate used to communicate with Syslog server. Source certificate.local.name. |
|
Custom field name for CEF format logging. |
|
Field custom name [A-Za-z0-9_]. |
|
Entry ID. see <a href=’#notes’>Notes</a>. |
|
Field name [A-Za-z0-9_]. |
|
Enable/disable reliable syslogging with TLS encryption. Choices:
|
|
Remote syslog facility. Choices:
|
|
Log format. Choices:
|
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Syslog maximum log rate in MBps (0 = unlimited). |
|
Remote syslog logging over UDP/Reliable TCP. Choices:
|
|
Server listen port. |
|
Set log transmission priority. Choices:
|
|
Address of remote syslog server. |
|
Source IP address of syslog. |
|
Source interface of syslog. Source system.interface.name. |
|
Minimum supported protocol version for SSL/TLS connections . Choices:
|
|
Enable/disable remote syslog logging. Choices:
|
|
Hidden setting index of Syslog. |
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Global settings for remote syslog server.
fortinet.fortios.fortios_log_syslogd4_setting:
vdom: "{{ vdom }}"
log_syslogd4_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"
source_ip_interface: "<your_own_value> (source system.interface.name)"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "2147483647"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |