You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortios.fortios_log_syslogd_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.3).

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_syslogd_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_syslogd 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	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
log_syslogd_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. Choices: high-medium high low disable
facility string	Remote syslog facility. 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
format string	Log format. Choices: default csv cef rfc5424
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. Choices: auto sdwan specify
max_log_rate integer	Syslog maximum log rate in MBps (0 = unlimited).
mode string	Remote syslog logging over UDP/Reliable TCP. Choices: udp legacy-reliable reliable
port integer	Server listen port.
priority string	Set log transmission priority. Choices: default low
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 . Choices: default SSLv3 TLSv1 TLSv1-1 TLSv1-2
status string	Enable/disable remote syslog logging. Choices: enable disable
syslog_type integer	Hidden setting index of Syslog.
member_path string	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.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
vdom string	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: “root”

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_log_syslogd_setting
    fortios_log_syslogd_setting:
      vdom: root
      log_syslogd_setting:
        enc_algorithm: disable
        facility: local7
        format: default
        interface_select_method: auto
        max_log_rate: 0
        mode: udp
        port: 514
        priority: default
        ssl_min_proto_version: default
        status: disable
        syslog_type: 1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always 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)