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

Note

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

Note

The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.

DEPRECATED

Removed in:

version 6.0.0

Why:

This collection and all content in it is unmaintained and deprecated.

Alternative:

Unknown.

Synopsis

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

Aliases: network.ftd.ftd_file_download

Parameters

Parameter

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

Description

msg

string

The error message describing why the module failed.

Returned: error

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Cisco Systems, Inc. (@annikulin)