New in version 2.7.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| destination 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 required | The name of the operation to execute. Only operations that return a file can be used in this module. | |
| path_params | Key-value pairs that should be sent as path parameters in a REST API call. |
- name: Download pending changes
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 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as network which means that it is maintained by the Ansible Network Team. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Network Team, see here.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ftd_file_download_module.html