fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_ips_sensor Configure IPS sensor. | "added in version" 1.0.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_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 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"
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 ips_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: Entries. elements: dict suboptions: action: choices: - pass - block - reset - default description: Action taken with traffic in which signatures are detected. type: str application: description: (list) Applications to be protected. type: raw cve: description: (list) List of CVE IDs of the signatures to add to the sensor type: raw default-action: choices: - block - pass - all - drop description: Deprecated, please rename it to default_action. Signature default action filter. type: str default-status: choices: - disable - enable - all description: Deprecated, please rename it to default_status. Signature default status filter. type: str exempt-ip: description: Deprecated, please rename it to exempt_ip. 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 last-modified: description: (list or str) Deprecated, please rename it to last_modified. Filter by signature last modified date. type: raw location: description: (list) Protect client or server traffic. 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) Operating systems to be protected. type: raw position: choices: - header - footer description: No description. type: str protocol: description: (list) Protocols to be examined. 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: (list) Identifies the predefined or custom IPS signatures to add to the sensor. type: raw severity: description: (list) Relative severity of the signature, from info to critical. type: raw status: choices: - disable - enable - default description: Status of the signatures included in filter. type: str tags: description: (list) No description. type: raw vuln-type: description: (list) Deprecated, please rename it to vuln_type. type: raw 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 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 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