Note
This module is part of the fortinet.fortimanager collection (version 2.10.0).
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.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_export_playbooks.
New in fortinet.fortimanager 2.1.0
Parameter | Comments |
|---|---|
access_token string | The token to access FortiManager without using username and password. |
enable_log boolean | Enable/Disable logging for task. Choices:
|
export_playbooks dictionary / required | Export playbooks for selectors. |
|
params dictionary |
The specific parameters for each different selector. |
|
path string |
Path to store exported playbooks and log files. Default: |
|
selector list / elements=string / required |
Selector of the FortiManager object category. Choices:
|
forticloud_access_token string | Access token of FortiCloud managed API users, this option is available with FortiManager later than 6.4.0. |
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 | The maximum time in seconds to wait for other users to release workspace lock. Default: |
Note
- name: Export Playbooks
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Export Playbooks
fortinet.fortimanager.fmgr_export_playbooks:
export_playbooks:
selector:
- all
path: "./exported"
params:
all:
adom: root
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
meta dictionary | The result of the request. Returned: always |
|
request_url string |
The full url requested. Returned: always Sample: |
|
response_code integer |
The status of api request. Returned: always Sample: |
|
response_data list / elements=string |
The api response. Returned: always |
|
response_message string |
The descriptive message of the api response. Returned: always Sample: |
|
system_information dictionary |
The information of the target system. Returned: always |
rc integer | The status the request. Returned: always Sample: |
version_check_warning list / elements=string | Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_export_playbooks_module.html