- source
fmgr_ips_sensor.py
- orphan
1.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v7.0.3 -> latest
- 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 (Alias name: block-malicious-url) Enable/disable malicious url blocking. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- comment Comment. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- entries Entries. type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- action Action taken with traffic in which signatures are detected. type: str choices: [pass, block, reset, default]
more...
Supported Version Ranges:
v7.0.3 -> latest
- application Applications to be protected. type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- cve List of cve ids of the signatures to add to the sensor type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- default_action (Alias name: default-action) Signature default action filter. type: str choices: [block, pass, all, drop]
more...
Supported Version Ranges:
v7.2.0 -> latest
- default_status (Alias name: default-status) Signature default status filter. type: str choices: [disable, enable, all]
more...
Supported Version Ranges:
v7.2.0 -> latest
- exempt_ip (Alias name: exempt-ip) Exempt-ip. type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- dst_ip (Alias name: dst-ip) Destination ip address and netmask (applies to packet matching the signature). type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- id Exempt ip id. type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- src_ip (Alias name: src-ip) Source ip address and netmask (applies to packet matching the signature). type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- dst_ip (Alias name: dst-ip) Destination ip address and netmask (applies to packet matching the signature). type: str
more...
- id Rule id in ips database (0 - 4294967295). type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- last_modified (Alias name: last-modified) Filter by signature last modified date. type: list or str
more...
Supported Version Ranges:
v7.2.0 -> latest
- location Protect client or server traffic. type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- log Enable/disable logging of signatures included in filter. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- log_attack_context (Alias name: log-attack-context) Enable/disable logging of attack context: url buffer, header buffer, body buffer, packet buffer. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- log_packet (Alias name: log-packet) Enable/disable packet logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- os Operating systems to be protected. type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- position type: str choices: [header, footer]
more...
Supported Version Ranges:
v7.0.3 -> latest
- protocol Protocols to be examined. type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine Quarantine method. type: str choices: [none, attacker, both, interface]
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine_expiry (Alias name: quarantine-expiry) Duration of quarantine. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine_log (Alias name: quarantine-log) Enable/disable quarantine logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- rate_count (Alias name: rate-count) Count of the rate. type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- rate_duration (Alias name: rate-duration) Duration (sec) of the rate. type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- rate_mode (Alias name: rate-mode) Rate limit mode. type: str choices: [periodical, continuous]
more...
Supported Version Ranges:
v7.0.3 -> latest
- rate_track (Alias name: rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip, dhcp-client-mac, dns-domain]
more...
Supported Version Ranges:
v7.0.3 -> latest
- rule Identifies the predefined or custom ips signatures to add to the sensor. type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- severity Relative severity of the signature, from info to critical. type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- status Status of the signatures included in filter. type: str choices: [disable, enable, default]
more...
Supported Version Ranges:
v7.0.3 -> latest
- tags type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- vuln_type (Alias name: vuln-type) type: list
more...
Supported Version Ranges:
v7.2.0 -> latest
- action Action taken with traffic in which signatures are detected. type: str choices: [pass, block, reset, default]
more...
- extended_log (Alias name: extended-log) Enable/disable extended logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- filter type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- action Action of selected rules. type: str choices: [pass, block, default, reset]
more...
Supported Version Ranges:
v7.0.3 -> latest
- application type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- application_real) (Alias name: application(real)) type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- location type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- location_real) (Alias name: location(real)) type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- log Enable/disable logging of selected rules. type: str choices: [disable, enable, default]
more...
Supported Version Ranges:
v7.0.3 -> latest
- log_packet (Alias name: log-packet) Enable/disable packet logging of selected rules. type: str choices: [disable, enable, default]
more...
Supported Version Ranges:
v7.0.3 -> latest
- name Filter name. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- os type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- os_real) (Alias name: os(real)) type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- protocol type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- protocol_real) (Alias name: protocol(real)) type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine Quarantine ip or interface. type: str choices: [none, attacker, both, interface]
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine_expiry (Alias name: quarantine-expiry) Duration of quarantine in minute. type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine_log (Alias name: quarantine-log) Enable/disable logging of selected quarantine. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- severity type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- severity_real) (Alias name: severity(real)) type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- status Selected rules status. type: str choices: [disable, enable, default]
more...
Supported Version Ranges:
v7.0.3 -> latest
- action Action of selected rules. type: str choices: [pass, block, default, reset]
more...
- log type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- name Sensor name. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- override type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- action Action of override rule. type: str choices: [pass, block, reset]
more...
Supported Version Ranges:
v7.0.3 -> latest
- exempt_ip (Alias name: exempt-ip) type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
- dst_ip (Alias name: dst-ip) Destination ip address and netmask. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- id Exempt ip id. type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- src_ip (Alias name: src-ip) Source ip address and netmask. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- dst_ip (Alias name: dst-ip) Destination ip address and netmask. type: str
more...
- log Enable/disable logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- log_packet (Alias name: log-packet) Enable/disable packet logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine Quarantine ip or interface. type: str choices: [none, attacker, both, interface]
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine_expiry (Alias name: quarantine-expiry) Duration of quarantine in minute. type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- quarantine_log (Alias name: quarantine-log) Enable/disable logging of selected quarantine. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- rule_id (Alias name: rule-id) Override rule id. type: int
more...
Supported Version Ranges:
v7.0.3 -> latest
- status Enable/disable status of override rule. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- action Action of override rule. type: str choices: [pass, block, reset]
more...
- replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest
- scan_botnet_connections (Alias name: scan-botnet-connections) Block or monitor connections to botnet servers, or disable botnet scanning. type: str choices: [disable, block, monitor]
more...
Supported Version Ranges:
v7.0.3 -> latest
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
- 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"
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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)