fortinet.fortios.fortios_log_fact module – Retrieve log data of fortios log objects.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_log_fact
.
New in fortinet.fortios 2.1.0
Synopsis
Retrieve log related to disk, memory, fortianalyzer and forticloud.
Requirements
The below requirements are needed on the host that executes this module.
install galaxy collection fortinet.fortios >= 2.1.0.
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
A list of expressions to filter the returned results. The items of the list are combined as LOGICAL AND with operator ampersand. One item itself could be concatenated with a comma as LOGICAL OR. |
|
A list of fields to display for returned results. |
|
the parameter for each selector, see definition in above list. |
|
selector of the retrieved log type Choices:
|
|
A list of selectors for retrieving the log type. |
|
A list of expressions to filter the returned results. The items of the list are combined as LOGICAL AND with operator ampersand. One item itself could be concatenated with a comma as LOGICAL OR. |
|
A list of fields to display for returned results. |
|
the parameter for each selector, see definition in above list. |
|
selector of the retrieved log type Choices:
|
|
A list of expressions to sort the returned results. The items of the list are in ascending order with operator ampersand. One item itself could be in decending order with a comma inside. |
|
A list of expressions to sort the returned results. The items of the list are in ascending order with operator ampersand. One item itself could be in decending order with a comma inside. |
|
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. Default: |
Notes
Note
Different selector may have different parameters, users are expected to look up them for a specific selector.
For some selectors, the objects are global, no params are allowed to appear
Not all parameters are required for a slector.
This module is exclusivly for FortiOS Log API.
Examples
- name: get disk event user and memory event user at once.
fortinet.fortios.fortios_log_fact:
access_token: "you_own_value"
selectors:
- selector: disk_event_user
filters:
- log_id==41000
- selector: memory_event_user
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Number of rows to return Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
session id for the request Returned: always Sample: |
|
Row number for the first row to return Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Type of log that can be retrieved Returned: always Sample: |
|
Total lines returned from the result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |