fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_ips_baseline_sensor Configure IPS sensor. | "added in version" 2.2.0 of fortinet.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 communityfortinet.fortimanager.fmgr_ips_baseline_sensor (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook (generated based on argument schema) 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_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: present # <value in [present, absent]> ips_baseline_sensor: block_malicious_url: <value in [disable, enable]> comment: <string> entries: - action: <value in [pass, block, reset, ...]> application: <list or string> cve: <list or string> exempt_ip: - dst_ip: <string> id: <integer> src_ip: <string> id: <integer> location: <list or string> log: <value in [disable, enable]> log_attack_context: <value in [disable, enable]> log_packet: <value in [disable, enable]> os: <list or string> protocol: <list or string> quarantine: <value in [none, attacker, both, ...]> quarantine_expiry: <string> quarantine_log: <value in [disable, enable]> rate_count: <integer> rate_duration: <integer> rate_mode: <value in [periodical, continuous]> rate_track: <value in [none, src-ip, dest-ip, ...]> rule: <string> severity: <list or string> status: <value in [disable, enable, default]> tags: <string> extended_log: <value in [disable, enable]> filter: - action: <value in [pass, block, default, ...]> application: <list or string> application_real): <string> location: <list or string> location_real): <string> log: <value in [disable, enable, default]> log_packet: <value in [disable, enable, default]> name: <string> os: <list or string> os_real): <string> protocol: <list or string> protocol_real): <string> quarantine: <value in [none, attacker, both, ...]> quarantine_expiry: <integer> quarantine_log: <value in [disable, enable]> severity: <list or string> severity_real): <string> status: <value in [disable, enable, default]> log: <value in [disable, enable]> name: <string> override: - action: <value in [pass, block, reset]> exempt_ip: - dst_ip: <string> id: <integer> src_ip: <string> log: <value in [disable, enable]> log_packet: <value in [disable, enable]> quarantine: <value in [none, attacker, both, ...]> quarantine_expiry: <integer> quarantine_log: <value in [disable, enable]> rule_id: <integer> status: <value in [disable, enable]> replacemsg_group: <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 type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. 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. type: bool ips_baseline_sensor: description: The top level parameters set. required: false suboptions: block-malicious-url: choices: - disable - enable description: Deprecated, please rename it to block_malicious_url. Enable/disable malicious URL blocking. type: str comment: description: Comment. type: str entries: description: No description. elements: dict suboptions: action: choices: - pass - block - reset - default description: Action taken with traffic in which signatures are detected. type: str application: description: (list) No description. type: raw cve: description: (list) No description. type: raw exempt-ip: description: Deprecated, please rename it to exempt_ip. elements: dict suboptions: dst-ip: description: Deprecated, please rename it to dst_ip. Destination IP address and netmask. type: str id: description: Exempt IP ID. type: int src-ip: description: Deprecated, please rename it to src_ip. Source IP address and netmask. type: str type: list id: description: Rule ID in IPS database type: int location: description: (list) No description. type: raw log: choices: - disable - enable description: Enable/disable logging of signatures included in filter. type: str log-attack-context: choices: - disable - enable description: Deprecated, please rename it to log_attack_context. Enable/disable logging of attack context type: str log-packet: choices: - disable - enable description: Deprecated, please rename it to log_packet. Enable/disable packet logging. type: str os: description: (list) No description. type: raw protocol: description: (list) No description. type: raw quarantine: choices: - none - attacker - both - interface description: Quarantine method. type: str quarantine-expiry: description: Deprecated, please rename it to quarantine_expiry. Duration of quarantine. type: str quarantine-log: choices: - disable - enable description: Deprecated, please rename it to quarantine_log. Enable/disable quarantine logging. type: str rate-count: description: Deprecated, please rename it to rate_count. Count of the rate. type: int rate-duration: description: Deprecated, please rename it to rate_duration. Duration type: int rate-mode: choices: - periodical - continuous description: Deprecated, please rename it to rate_mode. Rate limit mode. type: str rate-track: choices: - none - src-ip - dest-ip - dhcp-client-mac - dns-domain description: Deprecated, please rename it to rate_track. 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: (list) No description. type: raw 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: Deprecated, please rename it to extended_log. Enable/disable extended logging. type: str filter: description: No description. elements: dict suboptions: action: choices: - pass - block - default - reset description: Action of selected rules. type: str application: description: (list) No description. type: raw application(real): description: Deprecated, please rename it to application_real). type: str location: description: (list) No description. type: raw location(real): description: Deprecated, please rename it to location_real). type: str log: choices: - disable - enable - default description: Enable/disable logging of selected rules. type: str log-packet: choices: - disable - enable - default description: Deprecated, please rename it to log_packet. Enable/disable packet logging of selected rules. type: str name: description: Filter name. type: str os: description: (list) No description. type: raw os(real): description: Deprecated, please rename it to os_real). type: str protocol: description: (list) No description. type: raw protocol(real): description: Deprecated, please rename it to protocol_real). type: str quarantine: choices: - none - attacker - both - interface description: Quarantine IP or interface. type: str quarantine-expiry: description: Deprecated, please rename it to quarantine_expiry. Duration of quarantine in minute. type: int quarantine-log: choices: - disable - enable description: Deprecated, please rename it to quarantine_log. Enable/disable logging of selected quarantine. type: str severity: description: (list) No description. type: raw severity(real): description: Deprecated, please rename it to severity_real). 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. required: true type: str override: description: No description. elements: dict suboptions: action: choices: - pass - block - reset description: Action of override rule. type: str exempt-ip: description: Deprecated, please rename it to exempt_ip. elements: dict suboptions: dst-ip: description: Deprecated, please rename it to dst_ip. Destination IP address and netmask. type: str id: description: Exempt IP ID. type: int src-ip: description: Deprecated, please rename it to src_ip. 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: Deprecated, please rename it to log_packet. Enable/disable packet logging. type: str quarantine: choices: - none - attacker - both - interface description: Quarantine IP or interface. type: str quarantine-expiry: description: Deprecated, please rename it to quarantine_expiry. Duration of quarantine in minute. type: int quarantine-log: choices: - disable - enable description: Deprecated, please rename it to quarantine_log. Enable/disable logging of selected quarantine. type: str rule-id: description: Deprecated, please rename it to rule_id. Override rule ID. type: int status: choices: - disable - enable description: Enable/disable status of override rule. type: str type: list replacemsg-group: description: Deprecated, please rename it to replacemsg_group. Replacement message group. type: str scan-botnet-connections: choices: - disable - block - monitor description: Deprecated, please rename it to scan_botnet_connections. Block or monitor connections to Botnet servers, or disable Botnet... 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. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. 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