fmgd_log_syslogd3_setting – Global settings for remote syslog server.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • log_syslogd3_setting - Global settings for remote syslog server. type: dict
    • certificate Certificate used to communicate with syslog server. type: list more...
    • custom_field_name (Alias name: custom-field-name) Custom field name. type: list more...
      • custom Field custom name [a-za-z0-9_]. type: str more...
      • id Entry id. type: int more...
      • name Field name [a-za-z0-9_]. type: str more...
    • enc_algorithm (Alias name: enc-algorithm) Enable/disable reliable syslogging with tls encryption. type: str choices: [high, low, disable, high-medium] 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, custom] more...
    • interface Specify outgoing interface to reach server. type: list more...
    • interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
    • max_log_rate (Alias name: 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: [low, default] more...
    • server Address of remote syslog server. type: str more...
    • source_ip (Alias name: source-ip) Source ip address of syslog. type: str more...
    • ssl_min_proto_version (Alias name: ssl-min-proto-version) Minimum supported protocol version for ssl/tls connections (default is to follow system global setting). type: str choices: [default, TLSv1-1, TLSv1-2, SSLv3, TLSv1, TLSv1-3] more...
    • status Enable/disable remote syslog logging. type: str choices: [disable, enable] more...
    • source_ip_interface (Alias name: source-ip-interface) Source interface of syslog. type: list more...
    • vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int more...
    • log_templates (Alias name: log-templates) Log templates. type: list more...
      • category Category. type: str choices: [app-ctrl, attack, dlp, event, traffic, virus, voip, webfilter, spam, anomaly, waf, dns, ssh, ssl, file-filter, icap, virtual-patch] more...
      • empty_value_indicator (Alias name: empty-value-indicator) Empty value indicator. type: str more...
      • id Id. type: int more...
      • template Template. type: str more...
    • reliable Enable/disable reliable logging (rfc3195). type: str choices: [disable, enable] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Global settings for remote syslog server.
      fortinet.fmgdevice.fmgd_log_syslogd3_setting:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        log_syslogd3_setting:
          # certificate: <list or string>
          # custom_field_name:
          #   - custom: <string>
          #     id: <integer>
          #     name: <string>
          # enc_algorithm: <value in [high, low, disable, ...]>
          # facility: <value in [kernel, user, mail, ...]>
          # format: <value in [default, csv, cef, ...]>
          # interface: <list or string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # max_log_rate: <integer>
          # mode: <value in [udp, legacy-reliable, reliable]>
          # port: <integer>
          # priority: <value in [low, default]>
          # server: <string>
          # source_ip: <string>
          # ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          # status: <value in [disable, enable]>
          # source_ip_interface: <list or string>
          # vrf_select: <integer>
          # log_templates:
          #   - category: <value in [app-ctrl, attack, dlp, ...]>
          #     empty_value_indicator: <string>
          #     id: <integer>
          #     template: <string>
          # reliable: <value in [disable, enable]>

Return Values

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)