faz_cli_system_alertevent – Alert events.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiAnalyzer device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

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

  • ansible>=2.9.0

FortiAnalyzer Version Compatibility


6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
cli_system_alertevent yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • 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
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • cli_system_alertevent - Alert events. type: dict
    • alert-destination - No description for the parameter type: array more...
      • from - Sender email address to use in alert emails. type: str more...
      • smtp-name - SMTP server name. type: str more...
      • snmp-name - SNMP trap name. type: str more...
      • syslog-name - Syslog server name. type: str more...
      • to - Recipient email address to use in alert emails. type: str more...
      • type - Destination type. type: str choices: [mail, snmp, syslog] default: mail more...
    • enable-generic-text - No description for the parameter type: array choices: [enable, disable] more...
    • enable-severity-filter - No description for the parameter type: array choices: [enable, disable] more...
    • event-time-period - Time period (hours). type: str choices: [0.5, 1, 3, 6, 12, 24, 72, 168] default: 0.5 more...
    • generic-text - Text that must be contained in a log to trigger alert. type: str more...
    • name - Alert name. type: str more...
    • num-events - Minimum number of events required within time period. type: str choices: [1, 5, 10, 50, 100] default: 1 more...
    • severity-filter - Required log severity to trigger alert. type: str choices: [high, medium-high, medium, medium-low, low] default: high more...
    • severity-level-comp - No description for the parameter type: array choices: [>=, =, <=] more...
    • severity-level-logs - No description for the parameter type: array choices: [no-check, information, notify, warning, error, critical, alert, emergency] more...

Notes

Note

  • 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

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_system_alertevent:
      cli_system_alertevent:
        event-time-period: 1
        generic-text: 'an event aleryed'
        name: fooevent
        num-events: 5
        severity-filter: high
        severity-level-comp:
        - '>='
        severity-level-logs:
        - no-check
      state: present
    name: Alert events.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

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