Skip to content

Latest commit

 

History

History
458 lines (414 loc) · 19.5 KB

fortios_ips_rule.rst

File metadata and controls

458 lines (414 loc) · 19.5 KB
Raw
source:fortios_ips_rule.py
orphan:

fortios_ips_rule -- Configure IPS rules in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and rule 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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_ips_rule v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: 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
  • 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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • ips_rule - Configure IPS rules. type: dict more...
    Supported Version Ranges
    ips_rule v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • action - Action. type: str choices: pass, block more...
      Supported Version Ranges
      action v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      [pass] v6.0.0 -> latest
      [block] v6.0.0 -> latest
    • application - Vulnerable applications. type: str more...
      Supported Version Ranges
      application v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • date - Date. type: int more...
      Supported Version Ranges
      date v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • group - Group. type: str more...
      Supported Version Ranges
      group v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • location - Vulnerable location. type: list
    • log - Enable/disable logging. type: str choices: disable, enable more...
      Supported Version Ranges
      log v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • log_packet - Enable/disable packet logging. type: str choices: disable, enable more...
      Supported Version Ranges
      log_packet v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • metadata - Meta data. type: list member_path: metadata:id more...
      Supported Version Ranges
      metadata v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      • id - ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      • metaid - Meta ID. type: int more...
        Supported Version Ranges
        metaid v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      • valueid - Value ID. type: int more...
        Supported Version Ranges
        valueid v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • name - Rule name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • os - Vulnerable operation systems. type: str more...
      Supported Version Ranges
      os v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • rev - Revision. type: int more...
      Supported Version Ranges
      rev v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • rule_id - Rule ID. type: int more...
      Supported Version Ranges
      rule_id v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • service - Vulnerable service. type: str more...
      Supported Version Ranges
      service v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • severity - Severity. type: str more...
      Supported Version Ranges
      severity v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • status - Enable/disable status. type: str choices: disable, enable more...
      Supported Version Ranges
      status v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure IPS rules.
  fortinet.fortios.fortios_ips_rule:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ips_rule:
          action: "pass"
          application: "<your_own_value>"
          date: "0"
          group: "<your_own_value>"
          location: "<your_own_value>"
          log: "disable"
          log_packet: "disable"
          metadata:
              -
                  id: "11"
                  metaid: "0"
                  valueid: "0"
          name: "default_name_14"
          os: "<your_own_value>"
          rev: "0"
          rule_id: "0"
          service: "<your_own_value>"
          severity: "<your_own_value>"
          status: "disable"

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

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)
  • Nicolas Thomas (@thomnico)

Hint

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