community.network.ftd_file_download – Downloads files from Cisco FTD devices over HTTP(S)

Note

This plugin is part of the community.network collection (version 3.0.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 community.network.

To use it in a playbook, specify: community.network.ftd_file_download.

Synopsis
Parameters
Examples
Return Values

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 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.

Examples

- name: Download pending changes
  community.network.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.

Authors

Cisco Systems, Inc. (@annikulin)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ftd_file_download_module.html