fmgr_ips_baseline_sensor – Configure IPS sensor.

Added in version 2.2.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v7.0.1 -> v7.0.2

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • ips_baseline_sensor - Configure IPS sensor. type: dict
    • block_malicious_url (Alias name: block-malicious-url) Enable/disable malicious url blocking. type: str choices: [disable, enable] more...
    • comment Comment. type: str more...
    • entries Entries. type: list more...
      • action Action taken with traffic in which signatures are detected. type: str choices: [pass, block, reset, default] more...
      • application Applications to be protected. type: list more...
      • cve List of cve ids of the signatures to add to the sensor type: list more...
      • exempt_ip (Alias name: exempt-ip) Exempt ip. type: list more...
        • dst_ip (Alias name: dst-ip) Destination ip address and netmask. type: str more...
        • id Exempt ip id. type: int more...
        • src_ip (Alias name: src-ip) Source ip address and netmask. type: str more...
      • id Rule id in ips database (0 - 4294967295). type: int more...
      • location Protect client or server traffic. type: list more...
      • log Enable/disable logging of signatures included in filter. type: str choices: [disable, enable] more...
      • log_attack_context (Alias name: log-attack-context) Enable/disable logging of attack context: url buffer, header buffer, body buffer, packet buffer. type: str choices: [disable, enable] more...
      • log_packet (Alias name: log-packet) Enable/disable packet logging. type: str choices: [disable, enable] more...
      • os Operating systems to be protected. type: list more...
      • protocol Protocols to be examined. type: list more...
      • quarantine Quarantine method. type: str choices: [none, attacker, both, interface] more...
      • quarantine_expiry (Alias name: quarantine-expiry) Duration of quarantine. type: str more...
      • quarantine_log (Alias name: quarantine-log) Enable/disable quarantine logging. type: str choices: [disable, enable] more...
      • rate_count (Alias name: rate-count) Count of the rate. type: int more...
      • rate_duration (Alias name: rate-duration) Duration (sec) of the rate. type: int more...
      • rate_mode (Alias name: rate-mode) Rate limit mode. type: str choices: [periodical, continuous] more...
      • rate_track (Alias name: rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip, dhcp-client-mac, dns-domain] more...
      • rule Identifies the predefined or custom ips signatures to add to the sensor. type: str more...
      • severity Relative severity of the signature, from info to critical. type: list more...
      • status Status of the signatures included in filter. type: str choices: [disable, enable, default] more...
      • tags Tags. type: str more...
    • extended_log (Alias name: extended-log) Enable/disable extended logging. type: str choices: [disable, enable] more...
    • filter Filter. type: list more...
      • action Action of selected rules. type: str choices: [pass, block, default, reset] more...
      • application Vulnerable application filter. type: list more...
      • application_real (Alias name: application(real)) Application(real). type: str more...
      • location Vulnerability location filter. type: list more...
      • location_real (Alias name: location(real)) Location(real). type: str more...
      • log Enable/disable logging of selected rules. type: str choices: [disable, enable, default] more...
      • log_packet (Alias name: log-packet) Enable/disable packet logging of selected rules. type: str choices: [disable, enable, default] more...
      • name Filter name. type: str more...
      • os Vulnerable os filter. type: list more...
      • os_real (Alias name: os(real)) Os(real). type: str more...
      • protocol Vulnerable protocol filter. type: list more...
      • protocol_real (Alias name: protocol(real)) Protocol(real). type: str more...
      • quarantine Quarantine ip or interface. type: str choices: [none, attacker, both, interface] more...
      • quarantine_expiry (Alias name: quarantine-expiry) Duration of quarantine in minute. type: int more...
      • quarantine_log (Alias name: quarantine-log) Enable/disable logging of selected quarantine. type: str choices: [disable, enable] more...
      • severity Vulnerability severity filter. type: list more...
      • severity_real (Alias name: severity(real)) Severity(real). type: str more...
      • status Selected rules status. type: str choices: [disable, enable, default] more...
    • log Log. type: str choices: [disable, enable] more...
    • name Sensor name. type: str more...
    • override Override. type: list more...
      • action Action of override rule. type: str choices: [pass, block, reset] more...
      • exempt_ip (Alias name: exempt-ip) Exempt ip. type: list more...
        • dst_ip (Alias name: dst-ip) Destination ip address and netmask. type: str more...
        • id Exempt ip id. type: int more...
        • src_ip (Alias name: src-ip) Source ip address and netmask. type: str more...
      • log Enable/disable logging. type: str choices: [disable, enable] more...
      • log_packet (Alias name: log-packet) Enable/disable packet logging. type: str choices: [disable, enable] more...
      • quarantine Quarantine ip or interface. type: str choices: [none, attacker, both, interface] more...
      • quarantine_expiry (Alias name: quarantine-expiry) Duration of quarantine in minute. type: int more...
      • quarantine_log (Alias name: quarantine-log) Enable/disable logging of selected quarantine. type: str choices: [disable, enable] more...
      • rule_id (Alias name: rule-id) Override rule id. type: int more...
      • status Enable/disable status of override rule. type: str choices: [disable, enable] more...
    • replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: str more...
    • scan_botnet_connections (Alias name: scan-botnet-connections) Block or monitor connections to botnet servers, or disable botnet scanning. type: str choices: [disable, block, monitor] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPS sensor.
      fortinet.fortimanager.fmgr_ips_baseline_sensor:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        ips_baseline_sensor:
          block_malicious_url: <value in [disable, enable]>
          comment: <string>
          entries:
            -
              action: <value in [pass, block, reset, ...]>
              application: <list or string>
              cve: <list or string>
              exempt_ip:
                -
                  dst_ip: <string>
                  id: <integer>
                  src_ip: <string>
              id: <integer>
              location: <list or string>
              log: <value in [disable, enable]>
              log_attack_context: <value in [disable, enable]>
              log_packet: <value in [disable, enable]>
              os: <list or string>
              protocol: <list or string>
              quarantine: <value in [none, attacker, both, ...]>
              quarantine_expiry: <string>
              quarantine_log: <value in [disable, enable]>
              rate_count: <integer>
              rate_duration: <integer>
              rate_mode: <value in [periodical, continuous]>
              rate_track: <value in [none, src-ip, dest-ip, ...]>
              rule: <string>
              severity: <list or string>
              status: <value in [disable, enable, default]>
              tags: <string>
          extended_log: <value in [disable, enable]>
          filter:
            -
              action: <value in [pass, block, default, ...]>
              application: <list or string>
              application_real: <string>
              location: <list or string>
              location_real: <string>
              log: <value in [disable, enable, default]>
              log_packet: <value in [disable, enable, default]>
              name: <string>
              os: <list or string>
              os_real: <string>
              protocol: <list or string>
              protocol_real: <string>
              quarantine: <value in [none, attacker, both, ...]>
              quarantine_expiry: <integer>
              quarantine_log: <value in [disable, enable]>
              severity: <list or string>
              severity_real: <string>
              status: <value in [disable, enable, default]>
          log: <value in [disable, enable]>
          name: <string>
          override:
            -
              action: <value in [pass, block, reset]>
              exempt_ip:
                -
                  dst_ip: <string>
                  id: <integer>
                  src_ip: <string>
              log: <value in [disable, enable]>
              log_packet: <value in [disable, enable]>
              quarantine: <value in [none, attacker, both, ...]>
              quarantine_expiry: <integer>
              quarantine_log: <value in [disable, enable]>
              rule_id: <integer>
              status: <value in [disable, enable]>
          replacemsg_group: <string>
          scan_botnet_connections: <value in [disable, block, monitor]>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)