fortiswitch_system_alarm – Alarm configuration in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch 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 v7.0.0

Requirements

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

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_system_alarm yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • system_alarm - Alarm configuration. type: dict
    • audible - Enable/disable audible alarm. type: str choices: enable, disable
    • groups - Alarm groups. type: list member_path: groups:id
      • 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
        • 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
    • sequence - Sequence id of alarms. type: int
    • status - Enable/disable alarm. type: str choices: enable, disable

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Alarm configuration.
    fortiswitch_system_alarm:
      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"
                src_ip: "<your_own_value>"
                src_port: "15"
                threshold: "16"
            id:  "17"
            log_full_warning_threshold: "18"
            period: "19"
            replay_attempt_threshold: "20"
            self_test_failure_threshold: "21"
            user_auth_failure_threshold: "22"
            user_auth_lockout_threshold: "23"
        sequence: "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 fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch 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
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

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