fmgr_ips_sensor – Configure IPS sensor.¶
New in version 2.10.
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 v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- ips_sensor - Configure IPS sensor. type: dict
- block-malicious-url - Enable/disable malicious URL blocking. type: str choices: [disable, enable]
- comment - Comment. type: str
- entries - No description for the parameter type: array
- action - Action taken with traffic in which signatures are detected. type: str choices: [pass, block, reset, default]
- application - No description for the parameter type: str
- exempt-ip - No description for the parameter type: array
- dst-ip - Destination IP address and netmask. type: str
- id - Exempt IP ID. type: int
- src-ip - Source IP address and netmask. type: str
- id - Rule ID in IPS database (0 - 4294967295). type: int
- location - No description for the parameter type: str
- log - Enable/disable logging of signatures included in filter. type: str choices: [disable, enable]
- log-attack-context - Enable/disable logging of attack context: URL buffer, header buffer, body buffer, packet buffer. type: str choices: [disable, enable]
- log-packet - Enable/disable packet logging. type: str choices: [disable, enable]
- os - No description for the parameter type: str
- protocol - No description for the parameter type: str
- quarantine - Quarantine method. type: str choices: [none, attacker, both, interface]
- quarantine-expiry - Duration of quarantine. type: str
- quarantine-log - Enable/disable quarantine logging. type: str choices: [disable, enable]
- rate-count - Count of the rate. type: int
- rate-duration - Duration (sec) of the rate. type: int
- rate-mode - Rate limit mode. type: str choices: [periodical, continuous]
- rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip, dhcp-client-mac, dns-domain]
- rule - Identifies the predefined or custom IPS signatures to add to the sensor. type: str
- severity - No description for the parameter type: str
- status - Status of the signatures included in filter. type: str choices: [disable, enable, default]
- extended-log - Enable/disable extended logging. type: str choices: [disable, enable]
- filter - No description for the parameter type: array
- action - Action of selected rules. type: str choices: [pass, block, default, reset]
- application - No description for the parameter type: str
- location - No description for the parameter type: str
- log - Enable/disable logging of selected rules. type: str choices: [disable, enable, default]
- log-packet - Enable/disable packet logging of selected rules. type: str choices: [disable, enable, default]
- name - Filter name. type: str
- os - No description for the parameter type: str
- protocol - No description for the parameter type: str
- quarantine - Quarantine IP or interface. type: str choices: [none, attacker, both, interface]
- quarantine-expiry - Duration of quarantine in minute. type: int
- quarantine-log - Enable/disable logging of selected quarantine. type: str choices: [disable, enable]
- severity - No description for the parameter type: str
- status - Selected rules status. type: str choices: [disable, enable, default]
- name - Sensor name. type: str
- override - No description for the parameter type: array
- action - Action of override rule. type: str choices: [pass, block, reset]
- exempt-ip - No description for the parameter type: array
- dst-ip - Destination IP address and netmask. type: str
- id - Exempt IP ID. type: int
- src-ip - Source IP address and netmask. type: str
- log - Enable/disable logging. type: str choices: [disable, enable]
- log-packet - Enable/disable packet logging. type: str choices: [disable, enable]
- quarantine - Quarantine IP or interface. type: str choices: [none, attacker, both, interface]
- quarantine-expiry - Duration of quarantine in minute. type: int
- quarantine-log - Enable/disable logging of selected quarantine. type: str choices: [disable, enable]
- rule-id - Override rule ID. type: int
- status - Enable/disable status of override rule. type: str choices: [disable, enable]
- replacemsg-group - Replacement message group. type: str
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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure IPS sensor.
fmgr_ips_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: <value in [present, absent]>
ips_sensor:
block-malicious-url: <value in [disable, enable]>
comment: <value of string>
entries:
-
action: <value in [pass, block, reset, ...]>
application: <value of string>
exempt-ip:
-
dst-ip: <value of string>
id: <value of integer>
src-ip: <value of string>
id: <value of integer>
location: <value of string>
log: <value in [disable, enable]>
log-attack-context: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
os: <value of string>
protocol: <value of string>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of string>
quarantine-log: <value in [disable, enable]>
rate-count: <value of integer>
rate-duration: <value of integer>
rate-mode: <value in [periodical, continuous]>
rate-track: <value in [none, src-ip, dest-ip, ...]>
rule: <value of string>
severity: <value of string>
status: <value in [disable, enable, default]>
extended-log: <value in [disable, enable]>
filter:
-
action: <value in [pass, block, default, ...]>
application: <value of string>
location: <value of string>
log: <value in [disable, enable, default]>
log-packet: <value in [disable, enable, default]>
name: <value of string>
os: <value of string>
protocol: <value of string>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of integer>
quarantine-log: <value in [disable, enable]>
severity: <value of string>
status: <value in [disable, enable, default]>
name: <value of string>
override:
-
action: <value in [pass, block, reset]>
exempt-ip:
-
dst-ip: <value of string>
id: <value of integer>
src-ip: <value of string>
log: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of integer>
quarantine-log: <value in [disable, enable]>
rule-id: <value of integer>
status: <value in [disable, enable]>
replacemsg-group: <value of string>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict