fmgr_ips_sensor – Configure IPS sensor.¶
New in version 1.0.0.
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.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
||||||||||||
| False | ||||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
||
| False | False | False | False | False | False | False | False | False | False | False | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
| False | False | False | False | False | False | False | False | False | False | False | False | False |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
||||
| False | False | False | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
|||||||||
| True | True | True | True | |||||||||
7.4.0 |
||||||||||||
| True |
Parameters¶
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- 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] more...
- comment - Comment. type: str more...
- entries - Entries. type: array
more...
- action - Action taken with traffic in which signatures are detected. type: str choices: [pass, block, reset, default] more...
- application - Applications to be protected. type: str more...
- cve - List of CVE IDs of the signatures to add to the sensor type: str more...
- default-action - Signature default action filter. type: str choices: [block, pass, all, drop] more...
- default-status - Signature default status filter. type: str choices: [disable, enable, all] more...
- exempt-ip - Exempt-Ip. type: array more...
- id - Rule ID in IPS database (0 - 4294967295). type: int more...
- last-modified - Filter by signature last modified date. type: str more...
- location - Protect client or server traffic. type: str more...
- log - Enable/disable logging of signatures included in filter. type: str choices: [disable, enable] more...
- log-attack-context - Enable/disable logging of attack context: URL buffer, header buffer, body buffer, packet buffer. type: str choices: [disable, enable] more...
- log-packet - Enable/disable packet logging. type: str choices: [disable, enable] more...
- os - Operating systems to be protected. type: str more...
- position - No description for the parameter type: str choices: [header, footer] more...
- protocol - Protocols to be examined. type: str more...
- quarantine - Quarantine method. type: str choices: [none, attacker, both, interface] more...
- quarantine-expiry - Duration of quarantine. type: str more...
- quarantine-log - Enable/disable quarantine logging. type: str choices: [disable, enable] more...
- rate-count - Count of the rate. type: int more...
- rate-duration - Duration (sec) of the rate. type: int more...
- rate-mode - Rate limit mode. type: str choices: [periodical, continuous] more...
- rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip, dhcp-client-mac, dns-domain] more...
- rule - Identifies the predefined or custom IPS signatures to add to the sensor. type: str more...
- severity - Relative severity of the signature, from info to critical. type: str more...
- status - Status of the signatures included in filter. type: str choices: [disable, enable, default] more...
- tags - No description for the parameter type: str more...
- vuln-type - No description for the parameter type: int more...
- extended-log - Enable/disable extended logging. type: str choices: [disable, enable] more...
- filter - No description for the parameter type: array
more...
- action - Action of selected rules. type: str choices: [pass, block, default, reset] more...
- application - No description for the parameter type: str more...
- application(real) - No description for the parameter type: str more...
- location - No description for the parameter type: str more...
- location(real) - No description for the parameter type: str more...
- log - Enable/disable logging of selected rules. type: str choices: [disable, enable, default] more...
- log-packet - Enable/disable packet logging of selected rules. type: str choices: [disable, enable, default] more...
- name - Filter name. type: str more...
- os - No description for the parameter type: str more...
- os(real) - No description for the parameter type: str more...
- protocol - No description for the parameter type: str more...
- protocol(real) - No description for the parameter type: str more...
- quarantine - Quarantine IP or interface. type: str choices: [none, attacker, both, interface] more...
- quarantine-expiry - Duration of quarantine in minute. type: int more...
- quarantine-log - Enable/disable logging of selected quarantine. type: str choices: [disable, enable] more...
- severity - No description for the parameter type: str more...
- severity(real) - No description for the parameter type: str more...
- status - Selected rules status. type: str choices: [disable, enable, default] more...
- log - No description for the parameter type: str choices: [disable, enable] more...
- name - Sensor name. type: str more...
- override - No description for the parameter type: array
more...
- action - Action of override rule. type: str choices: [pass, block, reset] more...
- exempt-ip - No description for the parameter type: array more...
- log - Enable/disable logging. type: str choices: [disable, enable] more...
- log-packet - Enable/disable packet logging. type: str choices: [disable, enable] more...
- quarantine - Quarantine IP or interface. type: str choices: [none, attacker, both, interface] more...
- quarantine-expiry - Duration of quarantine in minute. type: int more...
- quarantine-log - Enable/disable logging of selected quarantine. type: str choices: [disable, enable] more...
- rule-id - Override rule ID. type: int more...
- status - Enable/disable status of override rule. type: str choices: [disable, enable] more...
- replacemsg-group - Replacement message group. type: str more...
- scan-botnet-connections - Block or monitor connections to Botnet servers, or disable Botnet scanning. type: str choices: [disable, block, monitor] more...
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¶
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the IPS sensors
fmgr_fact:
facts:
selector: 'ips_sensor'
params:
adom: 'ansible'
sensor: 'your_value'
- hosts: fortimanager00
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
adom: ansible
state: present
ips_sensor:
block-malicious-url: disable
comment: 'ansible-comment'
name: 'ansible-test-ipssensor'
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0