cisco.dnac.user_enrichment_details – Manage UserEnrichmentDetails objects of Users

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to.

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
headers
dictionary / required
Adds the header parameters.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.user_enrichment_details

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

UserEnrichmentDetails reference

Complete reference of the UserEnrichmentDetails object model.

UserEnrichmentDetails reference

SDK reference.

Examples

- name: get_user_enrichment_details
  cisco.dnac.user_enrichment_details:
    state: query  # required
    headers:  # required
  register: nm_get_user_enrichment_details

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:
users.get_user_enrichment_details


Authors

  • Rafael Campos (@racampos)