fortinet.fortimanager.fmgr_ips_sensor module – Configure IPS sensor.

Note

This module is part of the fortinet.fortimanager collection (version 2.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_ips_sensor.

New in fortinet.fortimanager 1.0.0

Synopsis

  • This module is able to configure a FortiManager device.

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

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

ips_sensor

dictionary

The top level parameters set.

_baseline

string

Baseline.

block_malicious_url

aliases: block-malicious-url

string

Enable/disable malicious URL blocking.

Choices:

  • "disable"

  • "enable"

comment

string

Comment.

entries

list / elements=dictionary

Entries.

action

string

Action taken with traffic in which signatures are detected.

Choices:

  • "pass"

  • "block"

  • "reset"

  • "default"

application

any

(list) Applications to be protected.

cve

any

(list) List of CVE IDs of the signatures to add to the sensor

default_action

aliases: default-action

string

Signature default action filter.

Choices:

  • "block"

  • "pass"

  • "all"

  • "drop"

default_status

aliases: default-status

string

Signature default status filter.

Choices:

  • "disable"

  • "enable"

  • "all"

exempt_ip

aliases: exempt-ip

list / elements=dictionary

Exempt ip.

dst_ip

aliases: dst-ip

string

Destination IP address and netmask.

id

integer

Exempt IP ID.

src_ip

aliases: src-ip

string

Source IP address and netmask.

id

integer

Rule ID in IPS database

last_modified

aliases: last-modified

any

(list or str) Filter by signature last modified date.

location

any

(list) Protect client or server traffic.

log

string

Enable/disable logging of signatures included in filter.

Choices:

  • "disable"

  • "enable"

log_attack_context

aliases: log-attack-context

string

Enable/disable logging of attack context

Choices:

  • "disable"

  • "enable"

log_packet

aliases: log-packet

string

Enable/disable packet logging.

Choices:

  • "disable"

  • "enable"

os

any

(list) Operating systems to be protected.

protocol

any

(list) Protocols to be examined.

quarantine

string

Quarantine method.

Choices:

  • "none"

  • "attacker"

  • "both"

  • "interface"

quarantine_expiry

aliases: quarantine-expiry

string

Duration of quarantine.

quarantine_log

aliases: quarantine-log

string

Enable/disable quarantine logging.

Choices:

  • "disable"

  • "enable"

rate_count

aliases: rate-count

integer

Count of the rate.

rate_duration

aliases: rate-duration

integer

Duration

rate_mode

aliases: rate-mode

string

Rate limit mode.

Choices:

  • "periodical"

  • "continuous"

rate_track

aliases: rate-track

string

Track the packet protocol field.

Choices:

  • "none"

  • "src-ip"

  • "dest-ip"

  • "dhcp-client-mac"

  • "dns-domain"

rule

any

(list or str) Identifies the predefined or custom IPS signatures to add to the sensor.

severity

any

(list) Relative severity of the signature, from info to critical.

status

string

Status of the signatures included in filter.

Choices:

  • "disable"

  • "enable"

  • "default"

tags

string

Assign a custom tag filter to the IPS sensor.

vuln_type

aliases: vuln-type

any

(list) List of signature vulnerability types to filter by.

extended_log

aliases: extended-log

string

Enable/disable extended logging.

Choices:

  • "disable"

  • "enable"

filter

list / elements=dictionary

Filter.

action

string

Action of selected rules.

Choices:

  • "pass"

  • "block"

  • "default"

  • "reset"

application

any

(list) Vulnerable application filter.

location

any

(list) Vulnerability location filter.

log

string

Enable/disable logging of selected rules.

Choices:

  • "disable"

  • "enable"

  • "default"

log_packet

aliases: log-packet

string

Enable/disable packet logging of selected rules.

Choices:

  • "disable"

  • "enable"

  • "default"

name

string

Filter name.

os

any

(list) Vulnerable OS filter.

protocol

any

(list) Vulnerable protocol filter.

quarantine

string

Quarantine IP or interface.

Choices:

  • "none"

  • "attacker"

  • "both"

  • "interface"

quarantine_expiry

aliases: quarantine-expiry

integer

Duration of quarantine in minute.

quarantine_log

aliases: quarantine-log

string

Enable/disable logging of selected quarantine.

Choices:

  • "disable"

  • "enable"

severity

any

(list) Vulnerability severity filter.

status

string

Selected rules status.

Choices:

  • "disable"

  • "enable"

  • "default"

name

string / required

Sensor name.

override

list / elements=dictionary

Override.

action

string

Action of override rule.

Choices:

  • "pass"

  • "block"

  • "reset"

exempt_ip

aliases: exempt-ip

list / elements=dictionary

Exempt ip.

dst_ip

aliases: dst-ip

string

Destination IP address and netmask.

id

integer

Exempt IP ID.

src_ip

aliases: src-ip

string

Source IP address and netmask.

log

string

Enable/disable logging.

Choices:

  • "disable"

  • "enable"

log_packet

aliases: log-packet

string

Enable/disable packet logging.

Choices:

  • "disable"

  • "enable"

quarantine

string

Quarantine IP or interface.

Choices:

  • "none"

  • "attacker"

  • "both"

  • "interface"

quarantine_expiry

aliases: quarantine-expiry

integer

Duration of quarantine in minute.

quarantine_log

aliases: quarantine-log

string

Enable/disable logging of selected quarantine.

Choices:

  • "disable"

  • "enable"

rule_id

aliases: rule-id

integer

Override rule ID.

status

string

Enable/disable status of override rule.

Choices:

  • "disable"

  • "enable"

replacemsg_group

aliases: replacemsg-group

string

Replacement message group.

scan_botnet_connections

aliases: scan-botnet-connections

string

Block or monitor connections to Botnet servers, or disable Botnet scanning.

Choices:

  • "disable"

  • "block"

  • "monitor"

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

revision_note

string

The change note that can be specified when an object is created or updated.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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
  hosts: fortimanagers
  gather_facts: false
  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_sensor:
        bypass_validation: false
        adom: ansible
        state: present
        ips_sensor:
          block_malicious_url: disable
          comment: "ansible-comment"
          name: "ansible-test-ipssensor"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPS sensors
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "ips_sensor"
          params:
            adom: "ansible"
            sensor: "your_value"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)