fortinet.fortimanager.fmgr_fact – Gather fortimanager facts.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_fact
.
New in version 2.10: of fortinet.fortimanager
Synopsis
- This module is able to configure a FortiManager device.
- Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters |
facts dictionary | the top level parameters set | |
rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | |
rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | |
workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |
workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: gathering fortimanager facts
hosts: fortimanager01
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the scripts
fmgr_fact:
facts:
selector: 'dvmdb_script'
params:
adom: 'root'
script: ''
- name: retrive all the interfaces
fmgr_fact:
facts:
selector: 'system_interface'
params:
interface: ''
- name: retrieve the interface port1
fmgr_fact:
facts:
selector: 'system_interface'
params:
interface: 'port1'
- name: fetch urlfilter with name urlfilter4
fmgr_fact:
facts:
selector: 'webfilter_urlfilter'
params:
adom: 'root'
urlfilter: ''
filter:
-
- 'name'
- '=='
- 'urlfilter4'
fields:
- 'id'
- 'name'
- 'comment'
sortings:
- 'id': 1
'name': -1
- name: Retrieve device
fmgr_fact:
facts:
selector: 'dvmdb_device'
params:
adom: 'root'
device: ''
option:
- 'get meta'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
request_url string | always | The full url requested Sample: /sys/login/user |
response_code integer | always | The status of api request |
response_message string | always | The descriptive message of the api response Sample: OK. |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_fact_module.html