cisco.dnac.file – Manage File objects of File

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.file.

New in version 1.0.0: of cisco.dnac

Synopsis

• Downloads a File specified by FileId.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
dirpath string		Directory absolute path. Defaults to current working directory.
file_id string / required		File Identification number.
save_file boolean	Choices: no yes	Enable or disable automatic File creation of raw response.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.file

The official documentation on the cisco.dnac.plugins.module_utils.definitions.file module.

File reference

Complete reference of the File object model.

File reference

SDK reference.

Examples

- name: download_a_file_by_fileid
  cisco.dnac.file:
    state: query  # required
    file_id: SomeValue  # string, required
    dirpath: SomeValue  # string
    save_file: True  # boolean
  register: nm_download_a_file_by_fileid

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: file.download_a_file_by_fileid

Authors

• Rafael Campos (@racampos)