cisco.dnac.file_namespace – Manage FileNamespace 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_namespace.

New in version 1.0.0: of cisco.dnac

Synopsis

• Returns list of available namespaces.

• Returns list of files under a specific namespace.

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
name_space string / required		A listing of fileId's.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.file_namespace

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

FileNamespace reference

Complete reference of the FileNamespace object model.

FileNamespace reference

SDK reference.

Examples

- name: get_list_of_available_namespaces
  cisco.dnac.file_namespace:
    state: query  # required
  register: nm_get_list_of_available_namespaces

- name: get_list_of_files
  cisco.dnac.file_namespace:
    state: query  # required
    name_space: SomeValue  # string, required
  register: nm_get_list_of_files

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

Authors

• Rafael Campos (@racampos)