fmgr_system_log_settings – Log settings.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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: v6.0.0 -> 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
  • system_log_settings - Log settings. type: dict
    • FAC_custom_field1 (Alias name: FAC-custom-field1) Name of custom log field to index. type: str more...
    • FAZ_custom_field1 (Alias name: FAZ-custom-field1) Name of custom log field to index. type: str more...
    • FCH_custom_field1 (Alias name: FCH-custom-field1) Name of custom log field to index. type: str more...
    • FCT_custom_field1 (Alias name: FCT-custom-field1) Name of custom log field to index. type: str more...
    • FDD_custom_field1 (Alias name: FDD-custom-field1) Name of custom log field to index. type: str more...
    • FGT_custom_field1 (Alias name: FGT-custom-field1) Name of custom log field to index. type: str more...
    • FMG_custom_field1 (Alias name: FMG-custom-field1) Name of custom log field to index. type: str more...
    • FML_custom_field1 (Alias name: FML-custom-field1) Name of custom log field to index. type: str more...
    • FPX_custom_field1 (Alias name: FPX-custom-field1) Name of custom log field to index. type: str more...
    • FSA_custom_field1 (Alias name: FSA-custom-field1) Name of custom log field to index. type: str more...
    • FWB_custom_field1 (Alias name: FWB-custom-field1) Name of custom log field to index. type: str more...
    • browse_max_logfiles (Alias name: browse-max-logfiles) Maximum number of log files for each log browse attempt for each adom. type: int default: 10000 more...
    • dns_resolve_dstip (Alias name: dns-resolve-dstip) Enable/disable resolving destination ip by dns. type: str choices: [disable, enable] default: disable more...
    • download_max_logs (Alias name: download-max-logs) Maximum number of logs for each log download attempt. type: int default: 500000 more...
    • ha_auto_migrate (Alias name: ha-auto-migrate) Enabled/disable automatically merging ha members logs to ha cluster. type: str choices: [disable, enable] default: disable more...
    • import_max_logfiles (Alias name: import-max-logfiles) Maximum number of log files for each log import attempt. type: int default: 10000 more...
    • log_file_archive_name (Alias name: log-file-archive-name) Log file name format for archiving, such as backup, upload or download. type: str choices: [basic, extended] default: basic more...
    • rolling_analyzer (Alias name: rolling-analyzer) Rolling analyzer. type: dict more...
      • days Log files rolling schedule (days of week). type: list choices: [sun, mon, tue, wed, thu, fri, sat] more...
      • del_files (Alias name: del-files) Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...
      • directory Upload server directory, for unix server, use absolute type: str more...
      • file_size (Alias name: file-size) Roll log files when they reach this size (mb). type: int default: 200 more...
      • gzip_format (Alias name: gzip-format) Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...
      • hour Log files rolling schedule (hour). type: int default: 0 more...
      • ip Upload server ip address. type: str default: 0.0.0.0 more...
      • ip2 Upload server ip2 address. type: str default: 0.0.0.0 more...
      • ip3 Upload server ip3 address. type: str default: 0.0.0.0 more...
      • log_format (Alias name: log-format) Format of uploaded log files. type: str choices: [native, text, csv] default: native more...
      • min Log files rolling schedule (minutes). type: int default: 0 more...
      • password Upload server login password. type: list more...
      • password2 Upload server login password2. type: list more...
      • password3 Upload server login password3. type: list more...
      • server_type (Alias name: server-type) Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...
      • upload Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...
      • upload_hour (Alias name: upload-hour) Log files upload schedule (hour). type: int default: 0 more...
      • upload_mode (Alias name: upload-mode) Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...
      • upload_trigger (Alias name: upload-trigger) Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...
      • username Upload server login username. type: str more...
      • username2 Upload server login username2. type: str more...
      • username3 Upload server login username3. type: str more...
      • when Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...
      • port Upload server ip1 port number. type: int default: 0 more...
      • port2 Upload server ip2 port number. type: int default: 0 more...
      • port3 Upload server ip3 port number. type: int default: 0 more...
      • rolling_upgrade_status (Alias name: rolling-upgrade-status) Rolling upgrade status (1|0). type: int default: 0 more...
      • server Upload server fqdn/ip. type: str more...
      • server2 Upload server2 fqdn/ip. type: str more...
      • server3 Upload server3 fqdn/ip. type: str more...
    • rolling_local (Alias name: rolling-local) Rolling local. type: dict more...
      • days Log files rolling schedule (days of week). type: list choices: [sun, mon, tue, wed, thu, fri, sat] more...
      • del_files (Alias name: del-files) Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...
      • directory Upload server directory, for unix server, use absolute type: str more...
      • file_size (Alias name: file-size) Roll log files when they reach this size (mb). type: int default: 200 more...
      • gzip_format (Alias name: gzip-format) Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...
      • hour Log files rolling schedule (hour). type: int default: 0 more...
      • ip Upload server ip address. type: str default: 0.0.0.0 more...
      • ip2 Upload server ip2 address. type: str default: 0.0.0.0 more...
      • ip3 Upload server ip3 address. type: str default: 0.0.0.0 more...
      • log_format (Alias name: log-format) Format of uploaded log files. type: str choices: [native, text, csv] default: native more...
      • min Log files rolling schedule (minutes). type: int default: 0 more...
      • password Upload server login password. type: list more...
      • password2 Upload server login password2. type: list more...
      • password3 Upload server login password3. type: list more...
      • server_type (Alias name: server-type) Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...
      • upload Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...
      • upload_hour (Alias name: upload-hour) Log files upload schedule (hour). type: int default: 0 more...
      • upload_mode (Alias name: upload-mode) Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...
      • upload_trigger (Alias name: upload-trigger) Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...
      • username Upload server login username. type: str more...
      • username2 Upload server login username2. type: str more...
      • username3 Upload server login username3. type: str more...
      • when Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...
      • port Upload server ip1 port number. type: int default: 0 more...
      • port2 Upload server ip2 port number. type: int default: 0 more...
      • port3 Upload server ip3 port number. type: int default: 0 more...
      • rolling_upgrade_status (Alias name: rolling-upgrade-status) Rolling upgrade status (1|0). type: int default: 0 more...
      • server Upload server fqdn/ip. type: str more...
      • server2 Upload server2 fqdn/ip. type: str more...
      • server3 Upload server3 fqdn/ip. type: str more...
    • rolling_regular (Alias name: rolling-regular) Rolling regular. type: dict more...
      • days Log files rolling schedule (days of week). type: list choices: [sun, mon, tue, wed, thu, fri, sat] more...
      • del_files (Alias name: del-files) Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...
      • directory Upload server directory, for unix server, use absolute type: str more...
      • file_size (Alias name: file-size) Roll log files when they reach this size (mb). type: int default: 200 more...
      • gzip_format (Alias name: gzip-format) Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...
      • hour Log files rolling schedule (hour). type: int default: 0 more...
      • ip Upload server ip address. type: str default: 0.0.0.0 more...
      • ip2 Upload server ip2 address. type: str default: 0.0.0.0 more...
      • ip3 Upload server ip3 address. type: str default: 0.0.0.0 more...
      • log_format (Alias name: log-format) Format of uploaded log files. type: str choices: [native, text, csv] default: native more...
      • min Log files rolling schedule (minutes). type: int default: 0 more...
      • password Upload server login password. type: list more...
      • password2 Upload server login password2. type: list more...
      • password3 Upload server login password3. type: list more...
      • server_type (Alias name: server-type) Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...
      • upload Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...
      • upload_hour (Alias name: upload-hour) Log files upload schedule (hour). type: int default: 0 more...
      • upload_mode (Alias name: upload-mode) Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...
      • upload_trigger (Alias name: upload-trigger) Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...
      • username Upload server login username. type: str more...
      • username2 Upload server login username2. type: str more...
      • username3 Upload server login username3. type: str more...
      • when Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...
      • port Upload server ip1 port number. type: int default: 0 more...
      • port2 Upload server ip2 port number. type: int default: 0 more...
      • port3 Upload server ip3 port number. type: int default: 0 more...
      • rolling_upgrade_status (Alias name: rolling-upgrade-status) Rolling upgrade status (1|0). type: int default: 0 more...
      • server Upload server fqdn/ip. type: str more...
      • server2 Upload server2 fqdn/ip. type: str more...
      • server3 Upload server3 fqdn/ip. type: str more...
    • sync_search_timeout (Alias name: sync-search-timeout) Maximum number of seconds for running a log search session in synchronous mode. type: int default: 60 more...
    • keep_dev_logs (Alias name: keep-dev-logs) Enable/disable keeping the dev logs after the device has been deleted. type: str choices: [disable, enable] default: disable more...
    • device_auto_detect (Alias name: device-auto-detect) Enable/disable looking up device id in syslog received with no encryption. type: str choices: [disable, enable] default: enable more...
    • unencrypted_logging (Alias name: unencrypted-logging) Enable/disable receiving syslog through udp(514) or tcp(514) un-encrypted. type: str choices: [disable, enable] default: enable more...
    • log_interval_dev_no_logging (Alias name: log-interval-dev-no-logging) Interval in minute of no log received from a device when considering the device down. type: int default: 15 more...
    • log_upload_interval_dev_no_logging (Alias name: log-upload-interval-dev-no-logging) Interval in minute of no log uploaded from a device when considering the device down. type: int default: 360 more...
    • legacy_auth_mode (Alias name: legacy-auth-mode) Enable/disable legacy mode of device authentication by username/password. type: str choices: [disable, enable] default: enable more...
    • log_process_fast_mode (Alias name: log-process-fast-mode) Enable/disable log process fast mode. type: str choices: [disable, enable] default: disable more...
    • FFW_custom_field1 (Alias name: FFW-custom-field1) Ffw custom field1. type: str more...
    • unencrypted_logging_tcp (Alias name: unencrypted-logging-tcp) Unencrypted logging tcp. type: str choices: [disable, enable] default: disable more...
    • unencrypted_logging_udp (Alias name: unencrypted-logging-udp) Unencrypted logging udp. type: str choices: [disable, enable] default: disable more...
    • syslog_over_tls_port (Alias name: syslog-over-tls-port) Syslog over tls port. type: str choices: [514, 6514] default: 514 more...
    • client_cert_auth (Alias name: client-cert-auth) Client cert auth. type: dict more...
      • mode Mode. type: str choices: [basic, strict] default: basic more...
      • tls_port (Alias name: tls-port) Tls port. type: str choices: [both, 514, 6514] default: both more...
      • trusted_client (Alias name: trusted-client) Trusted client. type: list more...
        • certificate Certificate. type: list more...
        • description Description. type: str more...
        • domain Domain. type: str more...
        • id Id. type: int default: 0 more...
        • type Type. type: str choices: [certificate, domain] default: domain 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
  tasks:
    - name: Log settings.
      fortinet.fortimanager.fmgr_system_log_settings:
        # workspace_locking_adom: <global or your adom name>
        system_log_settings:
          # FAC_custom_field1: <string>
          # FAZ_custom_field1: <string>
          # FCH_custom_field1: <string>
          # FCT_custom_field1: <string>
          # FDD_custom_field1: <string>
          # FGT_custom_field1: <string>
          # FMG_custom_field1: <string>
          # FML_custom_field1: <string>
          # FPX_custom_field1: <string>
          # FSA_custom_field1: <string>
          # FWB_custom_field1: <string>
          # browse_max_logfiles: <integer>
          # dns_resolve_dstip: <value in [disable, enable]>
          # download_max_logs: <integer>
          # ha_auto_migrate: <value in [disable, enable]>
          # import_max_logfiles: <integer>
          # log_file_archive_name: <value in [basic, extended]>
          # rolling_analyzer:
          #   days: ["sun", "mon", "tue", "wed", "thu", "fri", "sat"]
          #   del_files: <value in [disable, enable]>
          #   directory: <string>
          #   file_size: <integer>
          #   gzip_format: <value in [disable, enable]>
          #   hour: <integer>
          #   ip: <string>
          #   ip2: <string>
          #   ip3: <string>
          #   log_format: <value in [native, text, csv]>
          #   min: <integer>
          #   password: <list or string>
          #   password2: <list or string>
          #   password3: <list or string>
          #   server_type: <value in [ftp, sftp, scp]>
          #   upload: <value in [disable, enable]>
          #   upload_hour: <integer>
          #   upload_mode: <value in [backup, mirror]>
          #   upload_trigger: <value in [on-roll, on-schedule]>
          #   username: <string>
          #   username2: <string>
          #   username3: <string>
          #   when: <value in [none, daily, weekly]>
          #   port: <integer>
          #   port2: <integer>
          #   port3: <integer>
          #   rolling_upgrade_status: <integer>
          #   server: <string>
          #   server2: <string>
          #   server3: <string>
          # rolling_local:
          #   days: ["sun", "mon", "tue", "wed", "thu", "fri", "sat"]
          #   del_files: <value in [disable, enable]>
          #   directory: <string>
          #   file_size: <integer>
          #   gzip_format: <value in [disable, enable]>
          #   hour: <integer>
          #   ip: <string>
          #   ip2: <string>
          #   ip3: <string>
          #   log_format: <value in [native, text, csv]>
          #   min: <integer>
          #   password: <list or string>
          #   password2: <list or string>
          #   password3: <list or string>
          #   server_type: <value in [ftp, sftp, scp]>
          #   upload: <value in [disable, enable]>
          #   upload_hour: <integer>
          #   upload_mode: <value in [backup, mirror]>
          #   upload_trigger: <value in [on-roll, on-schedule]>
          #   username: <string>
          #   username2: <string>
          #   username3: <string>
          #   when: <value in [none, daily, weekly]>
          #   port: <integer>
          #   port2: <integer>
          #   port3: <integer>
          #   rolling_upgrade_status: <integer>
          #   server: <string>
          #   server2: <string>
          #   server3: <string>
          # rolling_regular:
          #   days: ["sun", "mon", "tue", "wed", "thu", "fri", "sat"]
          #   del_files: <value in [disable, enable]>
          #   directory: <string>
          #   file_size: <integer>
          #   gzip_format: <value in [disable, enable]>
          #   hour: <integer>
          #   ip: <string>
          #   ip2: <string>
          #   ip3: <string>
          #   log_format: <value in [native, text, csv]>
          #   min: <integer>
          #   password: <list or string>
          #   password2: <list or string>
          #   password3: <list or string>
          #   server_type: <value in [ftp, sftp, scp]>
          #   upload: <value in [disable, enable]>
          #   upload_hour: <integer>
          #   upload_mode: <value in [backup, mirror]>
          #   upload_trigger: <value in [on-roll, on-schedule]>
          #   username: <string>
          #   username2: <string>
          #   username3: <string>
          #   when: <value in [none, daily, weekly]>
          #   port: <integer>
          #   port2: <integer>
          #   port3: <integer>
          #   rolling_upgrade_status: <integer>
          #   server: <string>
          #   server2: <string>
          #   server3: <string>
          # sync_search_timeout: <integer>
          # keep_dev_logs: <value in [disable, enable]>
          # device_auto_detect: <value in [disable, enable]>
          # unencrypted_logging: <value in [disable, enable]>
          # log_interval_dev_no_logging: <integer>
          # log_upload_interval_dev_no_logging: <integer>
          # legacy_auth_mode: <value in [disable, enable]>
          # log_process_fast_mode: <value in [disable, enable]>
          # FFW_custom_field1: <string>
          # unencrypted_logging_tcp: <value in [disable, enable]>
          # unencrypted_logging_udp: <value in [disable, enable]>
          # syslog_over_tls_port: <value in [514, 6514]>
          # client_cert_auth:
          #   mode: <value in [basic, strict]>
          #   tls_port: <value in [both, 514, 6514]>
          #   trusted_client:
          #     - certificate: <list or string>
          #       description: <string>
          #       domain: <string>
          #       id: <integer>
          #       type: <value in [certificate, domain]>

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)