cisco.dnac.network_device_export_list – Manage NetworkDeviceExportList objects of Devices

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Exports the selected network device to a file.

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
deviceUuids
list / elements=string / required
ExportDeviceDTO's deviceUuids (list of strings).
id
string
ExportDeviceDTO's id.
operationEnum
string
ExportDeviceDTO's operationEnum.
Available values are 'CREDENTIALDETAILS' and 'DEVICEDETAILS'.
parameters
list / elements=string
ExportDeviceDTO's parameters (list of strings).
password
string
ExportDeviceDTO's password.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.network_device_export_list

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

NetworkDeviceExportList reference

Complete reference of the NetworkDeviceExportList object model.

NetworkDeviceExportList reference

SDK reference.

Examples

- name: export_device_list
  cisco.dnac.network_device_export_list:
    state: create  # required
    deviceUuids:  # required
    - SomeValue  # string
    id: SomeValue  # string
    operationEnum: # valid values are 'CREDENTIALDETAILS',
      # 'DEVICEDETAILS'.
      SomeValue  # string
    parameters:
    - SomeValue  # string
    password: SomeValue  # string

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:
devices.export_device_list


Authors

  • Rafael Campos (@racampos)