fortios_ips_custom – Configure IPS custom signature in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and custom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
|
fortios_ips_custom | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- enable_log - Enable/Disable logging for task. type: bool required: False default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- ips_custom - Configure IPS custom signature. type: dict more...
- action - Default action (pass or block) for this signature. type: str choices: pass, block more...
- application - Applications to be protected. Blank for all applications. type: str more...
- comment - Comment. type: str more...
- location - Protect client or server traffic. type: str more...
- log - Enable/disable logging. type: str choices: disable, enable more...
- log_packet - Enable/disable packet logging. type: str choices: disable, enable more...
- os - Operating system(s) that the signature protects. Blank for all operating systems. type: str more...
- protocol - Protocol(s) that the signature scans. Blank for all protocols. type: str more...
- rule_id - Signature ID. type: int more...
- severity - Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity. type: str more...
- sig_name - Signature name. type: str more...
- signature - Custom signature enclosed in single quotes. type: str more...
- status - Enable/disable this signature. type: str choices: disable, enable more...
- tag - Signature tag. type: str required: True more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPS custom signature.
fortios_ips_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ips_custom:
action: "pass"
application: "<your_own_value>"
comment: "Comment."
location: "<your_own_value>"
log: "disable"
log_packet: "disable"
os: "<your_own_value>"
protocol: "<your_own_value>"
rule_id: "11"
severity: "<your_own_value>"
sig_name: "<your_own_value>"
signature: "<your_own_value>"
status: "disable"
tag: "<your_own_value>"
Return Values¶
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3