Note
This plugin is part of the community.network collection.
To install it use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.ftd_file_download.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| destination path / required | Absolute path of where to download the file to. If destination is a directory, the module uses a filename from 'Content-Disposition' header specified by the server. | |
| operation string / required | The name of the operation to execute. Only operations that return a file can be used in this module. | |
| path_params dictionary | Key-value pairs that should be sent as path parameters in a REST API call. |
- name: Download pending changes
community.network.ftd_file_download:
operation: 'getdownload'
path_params:
objId: 'default'
destination: /tmp/
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| msg string | error | The error message describing why the module failed. |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ftd_file_download_module.html