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 address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
log_fortianalyzer2_setting
-
|
Default: null
|
Global FortiAnalyzer settings.
|
|
__change_ip
-
|
Hidden attribute.
|
||
certificate
-
|
Certificate used to communicate with FortiAnalyzer. Source certificate.local.name.
|
||
conn-timeout
-
|
FortiAnalyzer connection time-out in seconds (for status and log buffer).
|
||
enc-algorithm
-
|
|
Enable/disable sending FortiAnalyzer log data with SSL encryption.
|
|
faz-type
-
|
Hidden setting index of FortiAnalyzer.
|
||
hmac-algorithm
-
|
|
FortiAnalyzer IPsec tunnel HMAC algorithm.
|
|
ips-archive
-
|
|
Enable/disable IPS packet archive logging.
|
|
mgmt-name
-
|
Hidden management name of FortiAnalyzer.
|
||
monitor-failure-retry-period
-
|
Time between FortiAnalyzer connection retries in seconds (for status and log buffer).
|
||
monitor-keepalive-period
-
|
Time between OFTP keepalives in seconds (for status and log buffer).
|
||
reliable
-
|
|
Enable/disable reliable logging to FortiAnalyzer.
|
|
server
-
|
The remote FortiAnalyzer.
|
||
source-ip
-
|
Source IPv4 or IPv6 address used to communicate with FortiAnalyzer.
|
||
ssl-min-proto-version
-
|
|
Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
|
|
status
-
|
|
Enable/disable logging to FortiAnalyzer.
|
|
upload-day
-
|
Day of week (month) to upload logs.
|
||
upload-interval
-
|
|
Frequency to upload log files to FortiAnalyzer.
|
|
upload-option
-
|
|
Enable/disable logging to hard disk and then uploading to FortiAnalyzer.
|
|
upload-time
-
|
Time to upload logs (hh:mm).
|
||
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: Global FortiAnalyzer settings.
fortios_log_fortianalyzer2_setting:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
log_fortianalyzer2_setting:
__change_ip: "3"
certificate: "<your_own_value> (source certificate.local.name)"
conn-timeout: "5"
enc-algorithm: "high-medium"
faz-type: "7"
hmac-algorithm: "sha256"
ips-archive: "enable"
mgmt-name: "<your_own_value>"
monitor-failure-retry-period: "11"
monitor-keepalive-period: "12"
reliable: "enable"
server: "192.168.100.40"
source-ip: "84.230.14.43"
ssl-min-proto-version: "default"
status: "enable"
upload-day: "<your_own_value>"
upload-interval: "daily"
upload-option: "store-and-upload"
upload-time: "<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.