New in version 2.7.
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
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.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.