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_rule
-
|
Default: null
|
Configure IPS rules.
|
||
action
-
|
|
Action.
|
||
application
-
|
Vulnerable applications.
|
|||
date
-
|
Date.
|
|||
group
-
|
Group.
|
|||
location
-
|
Vulnerable location.
|
|||
log
-
|
|
Enable/disable logging.
|
||
log-packet
-
|
|
Enable/disable packet logging.
|
||
metadata
-
|
Meta data.
|
|||
id
-
/ required
|
ID.
|
|||
metaid
-
|
Meta ID.
|
|||
valueid
-
|
Value ID.
|
|||
name
-
/ required
|
Rule name.
|
|||
os
-
|
Vulnerable operation systems.
|
|||
rev
-
|
Revision.
|
|||
rule-id
-
|
Rule ID.
|
|||
service
-
|
Vulnerable service.
|
|||
severity
-
|
Severity.
|
|||
state
-
|
|
Indicates whether to create or remove the object
|
||
status
-
|
|
Enable/disable status.
|
||
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 rules.
fortios_ips_rule:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
ips_rule:
state: "present"
action: "pass"
application: "<your_own_value>"
date: "5"
group: "<your_own_value>"
location: "<your_own_value>"
log: "disable"
log-packet: "disable"
metadata:
-
id: "11"
metaid: "12"
valueid: "13"
name: "default_name_14"
os: "<your_own_value>"
rev: "16"
rule-id: "17"
service: "<your_own_value>"
severity: "<your_own_value>"
status: "disable"
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.