fortios_system_alarm – Configure alarm in Fortinet’s FortiOS and FortiGate
New in version 2.9.
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and alarm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
| Parameter | Choices/Defaults | Comments | |||
|---|---|---|---|---|---|
| host  string  | FortiOS or FortiGate IP address. | ||||
| https  boolean  | 
 | Indicates if the requests towards FortiGate must use HTTPS protocol. | |||
| password  string  | Default: "" | FortiOS or FortiGate password. | |||
| ssl_verify  boolean  | 
 | Ensures FortiGate certificate must be verified by a proper CA. | |||
| system_alarm  dictionary  | Default: null | Configure alarm. | |||
| audible  string  | 
 | Enable/disable audible alarm. | |||
| groups  list  | Alarm groups. | ||||
| admin_auth_failure_threshold  integer  | Admin authentication failure threshold. | ||||
| admin_auth_lockout_threshold  integer  | Admin authentication lockout threshold. | ||||
| decryption_failure_threshold  integer  | Decryption failure threshold. | ||||
| encryption_failure_threshold  integer  | Encryption failure threshold. | ||||
| fw_policy_id  integer  | Firewall policy ID. | ||||
| fw_policy_id_threshold  integer  | Firewall policy ID threshold. | ||||
| fw_policy_violations  list  | Firewall policy violations. | ||||
| dst_ip  string  | Destination IP (0=all). | ||||
| dst_port  integer  | Destination port (0=all). | ||||
| id  integer / required  | Firewall policy violations ID. | ||||
| src_ip  string  | Source IP (0=all). | ||||
| src_port  integer  | Source port (0=all). | ||||
| threshold  integer  | Firewall policy violation threshold. | ||||
| id  integer / required  | Group ID. | ||||
| log_full_warning_threshold  integer  | Log full warning threshold. | ||||
| period  integer  | Time period in seconds (0 = from start up). | ||||
| replay_attempt_threshold  integer  | Replay attempt threshold. | ||||
| self_test_failure_threshold  integer  | Self-test failure threshold. | ||||
| user_auth_failure_threshold  integer  | User authentication failure threshold. | ||||
| user_auth_lockout_threshold  integer  | User authentication lockout threshold. | ||||
| status  string  | 
 | Enable/disable alarm. | |||
| username  string  | FortiOS or FortiGate username. | ||||
| vdom  string  | Default: "root" | 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. | |||
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure alarm.
    fortios_system_alarm:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      system_alarm:
        audible: "enable"
        groups:
         -
            admin_auth_failure_threshold: "5"
            admin_auth_lockout_threshold: "6"
            decryption_failure_threshold: "7"
            encryption_failure_threshold: "8"
            fw_policy_id: "9"
            fw_policy_id_threshold: "10"
            fw_policy_violations:
             -
                dst_ip: "<your_own_value>"
                dst_port: "13"
                id:  "14"
                src_ip: "<your_own_value>"
                src_port: "16"
                threshold: "17"
            id:  "18"
            log_full_warning_threshold: "19"
            period: "20"
            replay_attempt_threshold: "21"
            self_test_failure_threshold: "22"
            user_auth_failure_threshold: "23"
            user_auth_lockout_threshold: "24"
        status: "enable"
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| build  string  | always | Build number of the fortigate image Sample: 1547 | 
| http_method  string  | always | Last method used to provision the content into FortiGate Sample: PUT | 
| http_status  string  | always | Last result given by FortiGate on last operation applied Sample: 200 | 
| mkey  string  | success | Master key (id) used in the last call to FortiGate Sample: id | 
| name  string  | always | Name of the table used to fulfill the request Sample: urlfilter | 
| path  string  | always | Path of the table used to fulfill the request Sample: webfilter | 
| revision  string  | always | Internal revision number Sample: 17.0.2.10658 | 
| serial  string  | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 | 
| status  string  | always | Indication of the operation's result Sample: success | 
| vdom  string  | always | Virtual domain used Sample: root | 
| version  string  | always | Version of the FortiGate Sample: v5.6.3 | 
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.9/modules/fortios_system_alarm_module.html