fortios_log_syslogd4_setting – Global settings for remote syslog server in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


  • 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


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.

FortiOS Version Compatibility

Supported Version Ranges
fortios_log_syslogd4_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_syslogd4_setting - Global settings for remote syslog server. type: dict more...
    • certificate - Certificate used to communicate with Syslog server. Source type: str more...
    • custom_field_name - Custom field name for CEF format logging. type: list member_path: custom_field_name:id more...
      • custom - Field custom name [A-Za-z0-9_]. type: str more...
      • id - Entry ID. see Notes. type: int required: true more...
      • name - Field name [A-Za-z0-9_]. type: str more...
    • enc_algorithm - Enable/disable reliable syslogging with TLS encryption. type: str choices: high-medium, high, low, disable more...
    • 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...
    • format - Log format. type: str choices: default, csv, cef, rfc5424, json more...
    • interface - Specify outgoing interface to reach server. Source type: str more...
    • interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
    • max_log_rate - Syslog maximum log rate in MBps (0 = unlimited). type: int more...
    • mode - Remote syslog logging over UDP/Reliable TCP. type: str choices: udp, legacy-reliable, reliable more...
    • port - Server listen port. type: int more...
    • priority - Set log transmission priority. type: str choices: default, low more...
    • server - Address of remote syslog server. type: str more...
    • source_ip - Source IP address of syslog. type: str more...
    • 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...
    • status - Enable/disable remote syslog logging. type: str choices: enable, disable more...
    • syslog_type - Hidden setting index of Syslog. type: int more...



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


- name: Global settings for remote syslog server.
      vdom: "{{ vdom }}"
          certificate: "<your_own_value> (source"
                  custom: "<your_own_value>"
                  id: "6"
                  name: "default_name_7"
          enc_algorithm: "high-medium"
          facility: "kernel"
          format: "default"
          interface: "<your_own_value> (source"
          interface_select_method: "auto"
          max_log_rate: "0"
          mode: "udp"
          port: "514"
          priority: "default"
          server: ""
          source_ip: ""
          ssl_min_proto_version: "default"
          status: "enable"
          syslog_type: "2147483647"

Return Values

Common return values are documented:, 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:
  • 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)


If you notice any issues in this documentation, you can create a pull request to improve it.