fortinet.fortios.fortios_configuration_fact – Retrieve Facts of FortiOS Configurable Objects.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.
To use it in a playbook, specify: fortinet.fortios.fortios_configuration_fact.
New in version 2.10: of fortinet.fortios
Synopsis
- Collects facts from network devices running the fortios operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. 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 | Choices/Defaults | Comments |
|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
| filters
list / elements=string
|
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.
|
|
| formatters
list / elements=string
|
A list of fields to display for returned results.
|
|
| params
dictionary
|
the parameter for each selector, see definition in above list.
|
|
| selector
string / required
|
|
selector of the retrieved fortigate facts
|
| selectors
list / elements=string
|
A list of selectors. if parameter selector not specified, the module will use selectors.
|
|
| sorters
list / elements=string
|
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.
|
|
| 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.
|
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.
- If params is empty a non-unique object, the whole object list is returned.
- This module has support for all configuration API, excluding any monitor API.
- The result of API request is stored in results as a list.
Examples
- hosts: fortigateslab
connection: httpapi
collections:
- fortinet.fortios
vars:
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
vdom: "root"
tasks:
- name: Get multiple selectors info concurrently
fortios_configuration_fact:
selectors:
- selector: firewall_address
params:
name: "gmail.com"
- selector: system_interface
- selector: log_eventfilter
params: {}
- name: fact gathering
fortios_configuration_fact:
vdom: ""
filters:
- name==port1
- vlanid==0
sorters:
- name,vlanid
- management-ip
formatters:
- name
- management-ip
- vlanid
selector: 'system_interface'
- name: get all
fortios_configuration_fact:
vdom: ""
access_token: ""
selector: log_custom-field
- name: get single
fortios_configuration_fact:
vdom: ""
access_token: ""
selector: log_custom-field
#optionally list or single get
params:
id: "3"
- name: fetch one firewall address
fortios_configuration_fact:
selector: firewall_address
params:
name: "login.microsoft.com"
- name: fetch all firewall addresses
fortios_configuration_fact:
selector: firewall_address
Return Values
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:
GET
|
| name
string
|
always |
Name of the table used to fulfill the request
Sample:
firmware
|
| path
string
|
always |
Path of the table used to fulfill the request
Sample:
system
|
| 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
|
Authors
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@fshen01)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_configuration_fact_module.html