New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host string | FortiOS or FortiGate IP address. | ||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |
log_fortianalyzer_override_setting dictionary | Default: null | Override FortiAnalyzer settings. | |
__change_ip integer | Hidden attribute. | ||
certificate string | Certificate used to communicate with FortiAnalyzer. Source certificate.local.name. | ||
conn_timeout integer | FortiAnalyzer connection time-out in seconds (for status and log buffer). | ||
enc_algorithm string |
| Enable/disable sending FortiAnalyzer log data with SSL encryption. | |
faz_type integer | Hidden setting index of FortiAnalyzer. | ||
hmac_algorithm string |
| FortiAnalyzer IPsec tunnel HMAC algorithm. | |
ips_archive string |
| Enable/disable IPS packet archive logging. | |
mgmt_name string | Hidden management name of FortiAnalyzer. | ||
monitor_failure_retry_period integer | Time between FortiAnalyzer connection retries in seconds (for status and log buffer). | ||
monitor_keepalive_period integer | Time between OFTP keepalives in seconds (for status and log buffer). | ||
override string |
| Enable/disable overriding FortiAnalyzer settings or use global settings. | |
reliable string |
| Enable/disable reliable logging to FortiAnalyzer. | |
server string | The remote FortiAnalyzer. | ||
source_ip string | Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. | ||
ssl_min_proto_version string |
| Minimum supported protocol version for SSL/TLS connections . | |
status string |
| Enable/disable logging to FortiAnalyzer. | |
upload_day string | Day of week (month) to upload logs. | ||
upload_interval string |
| Frequency to upload log files to FortiAnalyzer. | |
upload_option string |
| Enable/disable logging to hard disk and then uploading to FortiAnalyzer. | |
upload_time string | Time to upload logs (hh:mm). | ||
use_management_vdom string |
| Enable/disable use of management VDOM IP address as source IP for logs sent to FortiAnalyzer. | |
password string | Default: "" | FortiOS or FortiGate password. | |
ssl_verify boolean added in 2.9 |
| Ensures FortiGate certificate must be verified by a proper CA. | |
username string | FortiOS or FortiGate username. | ||
vdom string | 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" ssl_verify: "False" tasks: - name: Override FortiAnalyzer settings. fortios_log_fortianalyzer_override_setting: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" log_fortianalyzer_override_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" override: "enable" 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>" use_management_vdom: "enable"
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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_log_fortianalyzer_override_setting_module.html