New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host
-
/ required
|
FortiOS or FortiGate ip adress.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
ips_custom
-
|
Default: null
|
Configure IPS custom signature.
|
|
action
-
|
|
Default action (pass or block) for this signature.
|
|
application
-
|
Applications to be protected. Blank for all applications.
|
||
comment
-
|
Comment.
|
||
location
-
|
Protect client or server traffic.
|
||
log
-
|
|
Enable/disable logging.
|
|
log-packet
-
|
|
Enable/disable packet logging.
|
|
os
-
|
Operating system(s) that the signature protects. Blank for all operating systems.
|
||
protocol
-
|
Protocol(s) that the signature scans. Blank for all protocols.
|
||
rule-id
-
|
Signature ID.
|
||
severity
-
|
Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
|
||
sig-name
-
|
Signature name.
|
||
signature
-
|
Custom signature enclosed in single quotes.
|
||
state
-
|
|
Indicates whether to create or remove the object
|
|
status
-
|
|
Enable/disable this signature.
|
|
tag
-
/ required
|
Signature tag.
|
||
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
Default: "root"
|
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.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure IPS custom signature.
fortios_ips_custom:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
ips_custom:
state: "present"
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>"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
status
string
|
always |
Indication of the operation's result
Sample:
success
|
vdom
string
|
always |
Virtual domain used
Sample:
root
|
version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.