ansible.builtin.fortios_system_alarm (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

system_alarm:
    default: null
    description:
    - Configure alarm.
    suboptions:
      audible:
        choices:
        - enable
        - disable
        description:
        - Enable/disable audible alarm.
        type: str
      groups:
        description:
        - Alarm groups.
        suboptions:
          admin_auth_failure_threshold:
            description:
            - Admin authentication failure threshold.
            type: int
          admin_auth_lockout_threshold:
            description:
            - Admin authentication lockout threshold.
            type: int
          decryption_failure_threshold:
            description:
            - Decryption failure threshold.
            type: int
          encryption_failure_threshold:
            description:
            - Encryption failure threshold.
            type: int
          fw_policy_id:
            description:
            - Firewall policy ID.
            type: int
          fw_policy_id_threshold:
            description:
            - Firewall policy ID threshold.
            type: int
          fw_policy_violations:
            description:
            - Firewall policy violations.
            suboptions:
              dst_ip:
                description:
                - Destination IP (0=all).
                type: str
              dst_port:
                description:
                - Destination port (0=all).
                type: int
              id:
                description:
                - Firewall policy violations ID.
                required: true
                type: int
              src_ip:
                description:
                - Source IP (0=all).
                type: str
              src_port:
                description:
                - Source port (0=all).
                type: int
              threshold:
                description:
                - Firewall policy violation threshold.
                type: int
            type: list
          id:
            description:
            - Group ID.
            required: true
            type: int
          log_full_warning_threshold:
            description:
            - Log full warning threshold.
            type: int
          period:
            description:
            - Time period in seconds (0 = from start up).
            type: int
          replay_attempt_threshold:
            description:
            - Replay attempt threshold.
            type: int
          self_test_failure_threshold:
            description:
            - Self-test failure threshold.
            type: int
          user_auth_failure_threshold:
            description:
            - User authentication failure threshold.
            type: int
          user_auth_lockout_threshold:
            description:
            - User authentication lockout threshold.
            type: int
        type: list
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable alarm.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str