fortinet.fortios.fortios_system_alarm module – Configure alarm in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_system_alarm.

New in fortinet.fortios 2.0.0

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.0

Requirements

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

  • ansible>=2.14

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

system_alarm

dictionary

Configure alarm.

audible

string

Enable/disable audible alarm.

Choices:

  • "enable"

  • "disable"

groups

list / elements=dictionary

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 / elements=dictionary

Firewall policy violations.

dst_ip

string

Destination IP (0=all).

dst_port

integer

Destination port (0=all).

id

integer / required

Firewall policy violations ID. see <a href=’#notes’>Notes</a>.

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. see <a href=’#notes’>Notes</a>.

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.

Choices:

  • "enable"

  • "disable"

vdom

string

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.

Default: "root"

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure alarm.
    fortios_system_alarm:
      vdom:  "{{ vdom }}"
      system_alarm:
        audible: "enable"
        groups:
         -
            admin_auth_failure_threshold: "0"
            admin_auth_lockout_threshold: "0"
            decryption_failure_threshold: "0"
            encryption_failure_threshold: "0"
            fw_policy_id: "0"
            fw_policy_id_threshold: "0"
            fw_policy_violations:
             -
                dst_ip: "<your_own_value>"
                dst_port: "0"
                id:  "14"
                src_ip: "<your_own_value>"
                src_port: "0"
                threshold: "0"
            id:  "18"
            log_full_warning_threshold: "0"
            period: "0"
            replay_attempt_threshold: "0"
            self_test_failure_threshold: "0"
            user_auth_failure_threshold: "0"
            user_auth_lockout_threshold: "0"
        status: "enable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)