W3cubDocs

/Ansible 2.9

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

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

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

Requirements

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

fortiosapi>=0.9.8

Parameters

Parameter				Choices/Defaults	Comments
host string					FortiOS or FortiGate IP address.
https boolean				Choices: no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol.
ips_sensor dictionary				Default: null	Configure IPS sensor.
	block_malicious_url string			Choices: disable enable	Enable/disable malicious URL blocking.
	comment string				Comment.
	entries list				IPS sensor filter.
		action string		Choices: pass block reset default	Action taken with traffic in which signatures are detected.
		application string			Applications to be protected. set application ? lists available applications. all includes all applications. other includes all unlisted applications.
		exempt_ip list			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		Choices: disable enable	Enable/disable logging of signatures included in filter.
		log_attack_context string		Choices: disable enable	Enable/disable logging of attack context: URL buffer, header buffer, body buffer, packet buffer.
		log_packet string		Choices: disable enable	Enable/disable packet logging. Enable to save the packet that triggers the filter. You can download the packets in pcap format for diagnostic use.
		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		Choices: none attacker	Quarantine method.
		quarantine_expiry string			Duration of quarantine. (Format
		quarantine_log string		Choices: disable enable	Enable/disable quarantine logging.
		rate_count integer			Count of the rate.
		rate_duration integer			Duration (sec) of the rate.
		rate_mode string		Choices: periodical continuous	Rate limit mode.
		rate_track string		Choices: none src-ip dest-ip dhcp-client-mac dns-domain	Track the packet protocol field.
		rule list			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		Choices: disable enable default	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.
	extended_log string			Choices: enable disable	Enable/disable extended logging.
	filter list				IPS sensor filter.
		action string		Choices: pass block reset default	Action of selected rules.
		application string			Vulnerable application filter.
		location string			Vulnerability location filter.
		log string		Choices: disable enable	Enable/disable logging of selected rules.
		log_packet string		Choices: disable enable	Enable/disable packet logging of selected rules.
		name string / required			Filter name.
		os string			Vulnerable OS filter.
		protocol string			Vulnerable protocol filter.
		quarantine string		Choices: none attacker	Quarantine IP or interface.
		quarantine_expiry integer			Duration of quarantine in minute.
		quarantine_log string		Choices: disable enable	Enable/disable logging of selected quarantine.
		severity string			Vulnerability severity filter.
		status string		Choices: disable enable default	Selected rules status.
	name string / required				Sensor name.
	override list				IPS override rule.
		action string		Choices: pass block reset	Action of override rule.
		exempt_ip list			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		Choices: disable enable	Enable/disable logging.
		log_packet string		Choices: disable enable	Enable/disable packet logging.
		quarantine string		Choices: none attacker	Quarantine IP or interface.
		quarantine_expiry integer			Duration of quarantine in minute.
		quarantine_log string		Choices: disable enable	Enable/disable logging of selected quarantine.
		rule_id integer			Override rule ID.
		status string		Choices: disable enable	Enable/disable status of override rule.
	replacemsg_group string				Replacement message group. Source system.replacemsg-group.name.
	state string			Choices: present absent	Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
password string				Default: ""	FortiOS or FortiGate password.
ssl_verify boolean added in 2.9				Choices: no yes ←	Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9				Choices: present absent	Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
username string					FortiOS or FortiGate username.
vdom string				Default: "root"	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.

Notes

Note

Requires fortiosapi library developed by Fortinet
Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure IPS sensor.
    fortios_ips_sensor:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      ips_sensor:
        block_malicious_url: "disable"
        comment: "Comment."
        entries:
         -
            action: "pass"
            application: "<your_own_value>"
            exempt_ip:
             -
                dst_ip: "<your_own_value>"
                id:  "10"
                src_ip: "<your_own_value>"
            id:  "12"
            location: "<your_own_value>"
            log: "disable"
            log_attack_context: "disable"
            log_packet: "disable"
            os: "<your_own_value>"
            protocol: "<your_own_value>"
            quarantine: "none"
            quarantine_expiry: "<your_own_value>"
            quarantine_log: "disable"
            rate_count: "22"
            rate_duration: "23"
            rate_mode: "periodical"
            rate_track: "none"
            rule:
             -
                id:  "27"
            severity: "<your_own_value>"
            status: "disable"
        extended_log: "enable"
        filter:
         -
            action: "pass"
            application: "<your_own_value>"
            location: "<your_own_value>"
            log: "disable"
            log_packet: "disable"
            name: "default_name_37"
            os: "<your_own_value>"
            protocol: "<your_own_value>"
            quarantine: "none"
            quarantine_expiry: "41"
            quarantine_log: "disable"
            severity: "<your_own_value>"
            status: "disable"
        name: "default_name_45"
        override:
         -
            action: "pass"
            exempt_ip:
             -
                dst_ip: "<your_own_value>"
                id:  "50"
                src_ip: "<your_own_value>"
            log: "disable"
            log_packet: "disable"
            quarantine: "none"
            quarantine_expiry: "55"
            quarantine_log: "disable"
            rule_id: "57"
            status: "disable"
        replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"

Return Values

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

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

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_ips_sensor_module.html