Try SpotterConfigure IPS sensor.
| "added in version" 1.0.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 community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This 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: 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'
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
ips_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: Entries.
elements: dict
suboptions:
action:
choices:
- pass
- block
- reset
- default
description: Action taken with traffic in which signatures are detected.
type: str
application:
description: Applications to be protected.
type: str
cve:
description: List of CVE IDs of the signatures to add to the sensor
type: str
default-action:
choices:
- block
- pass
- all
- drop
description: Signature default action filter.
type: str
default-status:
choices:
- disable
- enable
- all
description: Signature default status filter.
type: str
exempt-ip:
description: Exempt-Ip.
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
last-modified:
description: Filter by signature last modified date.
type: str
location:
description: Protect client or server traffic.
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: Operating systems to be protected.
type: str
position:
choices:
- header
- footer
description: no description
type: str
protocol:
description: Protocols to be examined.
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: Relative severity of the signature, from info to critical.
type: str
status:
choices:
- disable
- enable
- default
description: Status of the signatures included in filter.
type: str
tags:
description: description
type: str
vuln-type:
description: description
type: int
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
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
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