You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortios.fortios_ips_sensor – Configure IPS sensor in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_ips_sensor.

New in version 2.10: of fortinet.fortios

Synopsis

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

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
ips_sensor dictionary	Configure IPS sensor.
block_malicious_url string	Enable/disable malicious URL blocking. Choices: disable enable
comment string	Comment.
entries list / elements=string	IPS sensor filter.
action string	Action taken with traffic in which signatures are detected. Choices: pass block reset default
application string	Applications to be protected. set application ? lists available applications. all includes all applications. other includes all unlisted applications.
cve list / elements=string	List of CVE IDs of the signatures to add to the sensor
cve_entry string	CVE IDs or CVE wildcards.
exempt_ip list / elements=string	Traffic from selected source or destination IP addresses is exempt from this signature.
dst_ip string	Destination IP address and netmask.
id integer / required	Exempt IP ID.
src_ip string	Source IP address and netmask.
id integer / required	Rule ID in IPS database (0 - 4294967295).
location string	Protect client or server traffic.
log string	Enable/disable logging of signatures included in filter. Choices: disable enable
log_attack_context string	Enable/disable logging of attack context: URL buffer, header buffer, body buffer, packet buffer. Choices: disable enable
log_packet string	Enable/disable packet logging. Enable to save the packet that triggers the filter. You can download the packets in pcap format for diagnostic use. Choices: disable enable
os string	Operating systems to be protected. all includes all operating systems. other includes all unlisted operating systems.
protocol string	Protocols to be examined. set protocol ? lists available protocols. all includes all protocols. other includes all unlisted protocols.
quarantine string	Quarantine method. Choices: none attacker
quarantine_expiry string	Duration of quarantine. (Format
quarantine_log string	Enable/disable quarantine logging. Choices: disable enable
rate_count integer	Count of the rate.
rate_duration integer	Duration (sec) of the rate.
rate_mode string	Rate limit mode. Choices: periodical continuous
rate_track string	Track the packet protocol field. Choices: none src-ip dest-ip dhcp-client-mac dns-domain
rule list / elements=string	Identifies the predefined or custom IPS signatures to add to the sensor.
id integer / required	Rule IPS.
severity string	Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
status string	Status of the signatures included in filter. default enables the filter and only use filters with default status of enable. Filters with default status of disable will not be used. Choices: disable enable default
extended_log string	Enable/disable extended logging. Choices: enable disable
filter list / elements=string	IPS sensor filter.
action string	Action of selected rules. Choices: pass block reset default
application string	Vulnerable application filter.
location string	Vulnerability location filter.
log string	Enable/disable logging of selected rules. Choices: disable enable
log_packet string	Enable/disable packet logging of selected rules. Choices: disable enable
name string / required	Filter name.
os string	Vulnerable OS filter.
protocol string	Vulnerable protocol filter.
quarantine string	Quarantine IP or interface. Choices: none attacker
quarantine_expiry integer	Duration of quarantine in minute.
quarantine_log string	Enable/disable logging of selected quarantine. Choices: disable enable
severity string	Vulnerability severity filter.
status string	Selected rules status. Choices: disable enable default
name string / required	Sensor name.
override list / elements=string	IPS override rule.
action string	Action of override rule. Choices: pass block reset
exempt_ip list / elements=string	Exempted IP.
dst_ip string	Destination IP address and netmask.
id integer / required	Exempt IP ID.
src_ip string	Source IP address and netmask.
log string	Enable/disable logging. Choices: disable enable
log_packet string	Enable/disable packet logging. Choices: disable enable
quarantine string	Quarantine IP or interface. Choices: none attacker
quarantine_expiry integer	Duration of quarantine in minute.
quarantine_log string	Enable/disable logging of selected quarantine. Choices: disable enable
rule_id integer	Override rule ID.
status string	Enable/disable status of override rule. Choices: disable enable
replacemsg_group string	Replacement message group. Source system.replacemsg-group.name.
scan_botnet_connections string	Block or monitor connections to Botnet servers, or disable Botnet scanning. Choices: disable block monitor
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
vdom string	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. Default: “root”

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_ips_sensor
    fortios_ips_sensor:
      vdom: root
      state: present
      ips_sensor:
        block_malicious_url: disable
        extended_log: disable
        name: terr-test-rdmstr
        scan_botnet_connections: disable

Return Values

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

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

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)