fortinet.fortios.fortios_monitor_fact module – Retrieve Facts of FortiOS Monitor Objects.
Note
This module is part of the fortinet.fortios collection (version 2.3.4).
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_monitor_fact
.
New in fortinet.fortios 2.0.0
Synopsis
Collects monitor facts from network devices running the fortios operating system. This facts module will only collect those facts which user specified in playbook.
Requirements
The below requirements are needed on the host that executes this module.
install galaxy collection fortinet.fortios >= 2.0.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 fortiOS facts. Choices:
|
|
A list of selectors for retrieving the fortiOS facts. |
|
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 fortiOS facts 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 monitor API.
The result of API request is stored in results.
Examples
- hosts: fortigate03
connection: httpapi
collections:
- fortinet.fortios
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Get license shizzle
fortios_monitor_fact:
vdom: ""
selectors:
- selector: license_status
- selector: system_status
- selector: firewall_security-policy
params:
policyid: '1'
- fortios_monitor_fact:
vdom: ""
formatters:
- model_name
filters:
- model_name==FortiGat
selector: 'system_status'
- name: fact gathering
fortios_monitor_fact:
vdom: ""
access_token: ""
selector: 'firewall_acl'
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: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |