cisco.dnac.file_info module – Information module for File

Note

This module is part of the cisco.dnac collection (version 3.3.2).

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Get File by id.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.3.3

• python >= 3.5

Parameters

Parameter	Comments
dirPath string	Directory absolute path. Defaults to the current working directory.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port string	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: “admin”
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.2.3”
fileId string	FileId path parameter. File Identification number.
headers dictionary	Additional headers.
saveFile boolean	Enable or disable automatic file creation of raw response. Choices: no yes
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)

Notes

Note

• Supports check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

File reference

Complete reference of the File object model.

Examples

- name: Get File by id
  cisco.dnac.file_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers:
      custom: value
    fileId: string
  register: result

Return Values

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

Key	Description
dnac_response string	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: “\”\u0027string\u0027\”\n”

Authors

• Rafael Campos (@racampos)