drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_ips_baseline_sensor Configure IPS sensor. | "added in version" 2.2.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_ips_baseline_sensor (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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_baseline_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_baseline_sensor: block-malicious-url: <value in [disable, enable]> comment: <value of string> entries: - action: <value in [pass, block, reset, ...]> application: <value of string> cve: <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]> tags: <value of string> extended-log: <value in [disable, enable]> filter: - action: <value in [pass, block, default, ...]> application: <value of string> application(real): <value of string> location: <value of string> location(real): <value of string> log: <value in [disable, enable, default]> log-packet: <value in [disable, enable, default]> name: <value of string> os: <value of string> os(real): <value of string> protocol: <value of string> protocol(real): <value of string> quarantine: <value in [none, attacker, both, ...]> quarantine-expiry: <value of integer> quarantine-log: <value in [disable, enable]> severity: <value of string> severity(real): <value of string> status: <value in [disable, enable, default]> log: <value in [disable, enable]> 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> scan-botnet-connections: <value in [disable, block, monitor]>
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool ips_baseline_sensor: description: the top level parameters set required: false suboptions: block-malicious-url: choices: - disable - enable description: Enable/disable malicious URL blocking. type: str comment: description: Comment. type: str entries: description: description elements: dict suboptions: action: choices: - pass - block - reset - default description: Action taken with traffic in which signatures are detected. type: str application: description: description type: str cve: description: description type: str exempt-ip: description: description elements: dict suboptions: dst-ip: description: Destination IP address and netmask. type: str id: description: Exempt IP ID. type: int src-ip: description: Source IP address and netmask. type: str type: list id: description: Rule ID in IPS database type: int location: description: description type: str log: choices: - disable - enable description: Enable/disable logging of signatures included in filter. type: str log-attack-context: choices: - disable - enable description: Enable/disable logging of attack context type: str log-packet: choices: - disable - enable description: Enable/disable packet logging. type: str os: description: description type: str protocol: description: description type: str quarantine: choices: - none - attacker - both - interface description: Quarantine method. type: str quarantine-expiry: description: Duration of quarantine. type: str quarantine-log: choices: - disable - enable description: Enable/disable quarantine logging. type: str rate-count: description: Count of the rate. type: int rate-duration: description: Duration type: int rate-mode: choices: - periodical - continuous description: Rate limit mode. type: str rate-track: choices: - none - src-ip - dest-ip - dhcp-client-mac - dns-domain description: Track the packet protocol field. type: str rule: description: Identifies the predefined or custom IPS signatures to add to the sensor. type: str severity: description: description type: str status: choices: - disable - enable - default description: Status of the signatures included in filter. type: str tags: description: no description type: str type: list extended-log: choices: - disable - enable description: Enable/disable extended logging. type: str filter: description: description elements: dict suboptions: action: choices: - pass - block - default - reset description: Action of selected rules. type: str application: description: description type: str application(real): description: no description type: str location: description: description type: str location(real): description: no description type: str log: choices: - disable - enable - default description: Enable/disable logging of selected rules. type: str log-packet: choices: - disable - enable - default description: Enable/disable packet logging of selected rules. type: str name: description: Filter name. type: str os: description: description type: str os(real): description: no description type: str protocol: description: description type: str protocol(real): description: no description type: str quarantine: choices: - none - attacker - both - interface description: Quarantine IP or interface. type: str quarantine-expiry: description: Duration of quarantine in minute. type: int quarantine-log: choices: - disable - enable description: Enable/disable logging of selected quarantine. type: str severity: description: description type: str severity(real): description: no description type: str status: choices: - disable - enable - default description: Selected rules status. type: str type: list log: choices: - disable - enable description: no description type: str name: description: Sensor name. type: str override: description: description elements: dict suboptions: action: choices: - pass - block - reset description: Action of override rule. type: str exempt-ip: description: description elements: dict suboptions: dst-ip: description: Destination IP address and netmask. type: str id: description: Exempt IP ID. type: int src-ip: description: Source IP address and netmask. type: str type: list log: choices: - disable - enable description: Enable/disable logging. type: str log-packet: choices: - disable - enable description: Enable/disable packet logging. type: str quarantine: choices: - none - attacker - both - interface description: Quarantine IP or interface. type: str quarantine-expiry: description: Duration of quarantine in minute. type: int quarantine-log: choices: - disable - enable description: Enable/disable logging of selected quarantine. type: str rule-id: description: Override rule ID. type: int status: choices: - disable - enable description: Enable/disable status of override rule. type: str type: list replacemsg-group: description: Replacement message group. type: str scan-botnet-connections: choices: - disable - block - monitor description: Block or monitor connections to Botnet servers, or disable Botnet scanning. type: str type: dict workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list