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.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- system_alarm - Configure alarm. type: dict
- audible - Enable/disable audible alarm. type: str choices: enable, disable
- groups - Alarm groups. type: list
- admin_auth_failure_threshold - Admin authentication failure threshold. type: int
- admin_auth_lockout_threshold - Admin authentication lockout threshold. type: int
- decryption_failure_threshold - Decryption failure threshold. type: int
- encryption_failure_threshold - Encryption failure threshold. type: int
- fw_policy_id - Firewall policy ID. type: int
- fw_policy_id_threshold - Firewall policy ID threshold. type: int
- fw_policy_violations - Firewall policy violations. type: list
- dst_ip - Destination IP (0=all). type: str
- dst_port - Destination port (0=all). type: int
- id - Firewall policy violations ID. type: int required: True
- src_ip - Source IP (0=all). type: str
- src_port - Source port (0=all). type: int
- threshold - Firewall policy violation threshold. type: int
- id - Group ID. type: int required: True
- log_full_warning_threshold - Log full warning threshold. type: int
- period - Time period in seconds (0 = from start up). type: int
- replay_attempt_threshold - Replay attempt threshold. type: int
- self_test_failure_threshold - Self-test failure threshold. type: int
- user_auth_failure_threshold - User authentication failure threshold. type: int
- user_auth_lockout_threshold - User authentication lockout threshold. type: int
- status - Enable/disable alarm. type: str choices: enable, disable
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: "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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3