Documentation

ftd_file_download - Downloads files from Cisco FTD devices over HTTP(S)

New in version 2.7.

Synopsis

  • Downloads files from Cisco FTD devices including pending changes, disk files, certificates, troubleshoot reports, and backups.

Parameters

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
str

required
The name of the operation to execute.
Only operations that return a file can be used in this module.
path_params
dict
Key-value pairs that should be sent as path parameters in a REST API call.

Examples

- name: Download pending changes
  ftd_file_download:
    operation: 'getdownload'
    path_params:
      objId: 'default'
    destination: /tmp/

Return Values

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.



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

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.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Cisco Systems, Inc.

Hint

If you notice any issues in this documentation you can edit this document to improve it.