fortinet.fortimanager.fmgr_ips_sensor module – Configure IPS sensor.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The top level parameters set. |
|
Baseline. |
|
Deprecated, please rename it to block_malicious_url. Enable/disable malicious URL blocking. Choices:
|
|
Comment. |
|
Entries. |
|
Action taken with traffic in which signatures are detected. Choices:
|
|
(list) Applications to be protected. |
|
(list) List of CVE IDs of the signatures to add to the sensor |
|
Deprecated, please rename it to default_action. Signature default action filter. Choices:
|
|
Deprecated, please rename it to default_status. Signature default status filter. Choices:
|
|
Deprecated, please rename it to exempt_ip. Exempt ip. |
|
Deprecated, please rename it to dst_ip. Destination IP address and netmask. |
|
Exempt IP ID. |
|
Deprecated, please rename it to src_ip. Source IP address and netmask. |
|
Rule ID in IPS database |
|
(list or str) Deprecated, please rename it to last_modified. Filter by signature last modified date. |
|
(list) Protect client or server traffic. |
|
Enable/disable logging of signatures included in filter. Choices:
|
|
Deprecated, please rename it to log_attack_context. Enable/disable logging of attack context Choices:
|
|
Deprecated, please rename it to log_packet. Enable/disable packet logging. Choices:
|
|
(list) Operating systems to be protected. |
|
(list) Protocols to be examined. |
|
Quarantine method. Choices:
|
|
Deprecated, please rename it to quarantine_expiry. Duration of quarantine. |
|
Deprecated, please rename it to quarantine_log. Enable/disable quarantine logging. Choices:
|
|
Deprecated, please rename it to rate_count. Count of the rate. |
|
Deprecated, please rename it to rate_duration. Duration |
|
Deprecated, please rename it to rate_mode. Rate limit mode. Choices:
|
|
Deprecated, please rename it to rate_track. Track the packet protocol field. Choices:
|
|
(list or str) Identifies the predefined or custom IPS signatures to add to the sensor. |
|
(list) Relative severity of the signature, from info to critical. |
|
Status of the signatures included in filter. Choices:
|
|
Assign a custom tag filter to the IPS sensor. |
|
(list) Deprecated, please rename it to vuln_type. List of signature vulnerability types to filter by. |
|
Deprecated, please rename it to extended_log. Enable/disable extended logging. Choices:
|
|
Filter. |
|
Action of selected rules. Choices:
|
|
(list) Vulnerable application filter. |
|
(list) Vulnerability location filter. |
|
Enable/disable logging of selected rules. Choices:
|
|
Deprecated, please rename it to log_packet. Enable/disable packet logging of selected rules. Choices:
|
|
Filter name. |
|
(list) Vulnerable OS filter. |
|
(list) Vulnerable protocol filter. |
|
Quarantine IP or interface. Choices:
|
|
Deprecated, please rename it to quarantine_expiry. Duration of quarantine in minute. |
|
Deprecated, please rename it to quarantine_log. Enable/disable logging of selected quarantine. Choices:
|
|
(list) Vulnerability severity filter. |
|
Selected rules status. Choices:
|
|
Sensor name. |
|
Override. |
|
Action of override rule. Choices:
|
|
Deprecated, please rename it to exempt_ip. Exempt ip. |
|
Deprecated, please rename it to dst_ip. Destination IP address and netmask. |
|
Exempt IP ID. |
|
Deprecated, please rename it to src_ip. Source IP address and netmask. |
|
Enable/disable logging. Choices:
|
|
Deprecated, please rename it to log_packet. Enable/disable packet logging. Choices:
|
|
Quarantine IP or interface. Choices:
|
|
Deprecated, please rename it to quarantine_expiry. Duration of quarantine in minute. |
|
Deprecated, please rename it to quarantine_log. Enable/disable logging of selected quarantine. Choices:
|
|
Deprecated, please rename it to rule_id. Override rule ID. |
|
Enable/disable status of override rule. Choices:
|
|
Deprecated, please rename it to replacemsg_group. Replacement message group. |
|
Deprecated, please rename it to scan_botnet_connections. Block or monitor connections to Botnet servers, or disable Botnet… Choices:
|
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |