/ home / cisco / cisco.dnac / 2.0.7 / module / file

cisco.dnac.file (2.0.7) — module

Manage File objects of File

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Downloads a File specified by FileId.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
dirpath:
    description:
    - Directory absolute path. Defaults to current working directory.
    type: str

file_id:
    description:
    - File Identification number.
    required: true
    type: str

save_file:
    description:
    - Enable or disable automatic File creation of raw response.
    type: bool

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: file.download_a_file_by_fileid
  type: str