cisco.dnac.device_detail – Manage DeviceDetail 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.device_detail.

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time.

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
identifier string / required		One of keywords macAddress or uuid or nwDeviceName.
search_by string / required		MAC Address or Device Name value or UUID of the network device.
timestamp integer		Epoch time(in milliseconds) when the device data is required.

Examples ¶

- name: get_device_detail
  cisco.dnac.device_detail:
    state: query  # required
    identifier: SomeValue  # string, required
    search_by: SomeValue  # string, required
    timestamp: 1  #  integer
  register: nm_get_device_detail

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

Authors¶

Rafael Campos (@racampos)

cisco.dnac.device_detail – Manage DeviceDetail objects of Devices¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶