.. Document meta

:orphan:

.. Anchors

.. _ansible_collections.cisco.dnac.user_enrichment_details_info_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

cisco.dnac.user_enrichment_details_info -- Information module for User Enrichment Details
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 3.0.0).

    To install it use: :code:`ansible-galaxy collection install cisco.dnac`.

    To use it in a playbook, specify: :code:`cisco.dnac.user_enrichment_details_info`.

.. version_added

.. versionadded:: 1.0.0 of cisco.dnac

.. contents::
   :local:
   :depth: 1

.. Deprecated


Synopsis
--------

.. Description

- Get all User Enrichment Details.

.. note::
    This module has a corresponding :ref:`action plugin <action_plugins>`.

.. Aliases


.. Requirements

Requirements
------------
The below requirements are needed on the host that executes this module.

- dnacentersdk


.. Options


.. Notes


.. Seealso

See Also
--------

.. seealso::

   `User Enrichment Details reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
       Complete reference of the User Enrichment Details object model.

.. Examples

Examples
--------

.. code-block:: yaml+jinja

    
    - name: Get all User Enrichment Details
      cisco.dnac.user_enrichment_details_info:
        dnac_host: "{{dnac_host}}"
        dnac_username: "{{dnac_username}}"
        dnac_password: "{{dnac_password}}"
        dnac_verify: "{{dnac_verify}}"
        dnac_port: "{{dnac_port}}"
        dnac_version: "{{dnac_version}}"
        dnac_debug: "{{dnac_debug}}"
      register: result





.. Facts


.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. raw:: html

    <table border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="1">Key</th>
            <th>Returned</th>
            <th width="100%">Description</th>
        </tr>
                    <tr>
                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-dnac_response"></div>
                    <b>dnac_response</b>
                    <a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">list</span>
                       / <span style="color: purple">elements=dictionary</span>                    </div>
                                    </td>
                <td>always</td>
                <td>
                                            <div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
                                        <br/>
                                            <div style="font-size: smaller"><b>Sample:</b></div>
                                                <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[
      {
        &quot;userDetails&quot;: {
          &quot;id&quot;: &quot;string&quot;,
          &quot;connectionStatus&quot;: &quot;string&quot;,
          &quot;hostType&quot;: &quot;string&quot;,
          &quot;userId&quot;: {},
          &quot;hostName&quot;: {},
          &quot;hostOs&quot;: {},
          &quot;hostVersion&quot;: {},
          &quot;subType&quot;: &quot;string&quot;,
          &quot;lastUpdated&quot;: 0,
          &quot;healthScore&quot;: [
            {
              &quot;healthType&quot;: &quot;string&quot;,
              &quot;reason&quot;: &quot;string&quot;,
              &quot;score&quot;: 0
            }
          ],
          &quot;hostMac&quot;: &quot;string&quot;,
          &quot;hostIpV4&quot;: &quot;string&quot;,
          &quot;hostIpV6&quot;: [
            {}
          ],
          &quot;authType&quot;: {},
          &quot;vlanId&quot;: &quot;string&quot;,
          &quot;ssid&quot;: {},
          &quot;frequency&quot;: {},
          &quot;channel&quot;: {},
          &quot;apGroup&quot;: {},
          &quot;location&quot;: {},
          &quot;clientConnection&quot;: &quot;string&quot;,
          &quot;connectedDevice&quot;: [
            {}
          ],
          &quot;issueCount&quot;: 0,
          &quot;rssi&quot;: {},
          &quot;avgRssi&quot;: {},
          &quot;snr&quot;: {},
          &quot;avgSnr&quot;: {},
          &quot;dataRate&quot;: {},
          &quot;txBytes&quot;: {},
          &quot;rxBytes&quot;: {},
          &quot;dnsSuccess&quot;: {},
          &quot;dnsFailure&quot;: {},
          &quot;onboarding&quot;: {
            &quot;averageRunDuration&quot;: {},
            &quot;maxRunDuration&quot;: {},
            &quot;averageAssocDuration&quot;: {},
            &quot;maxAssocDuration&quot;: {},
            &quot;averageAuthDuration&quot;: {},
            &quot;maxAuthDuration&quot;: {},
            &quot;averageDhcpDuration&quot;: {},
            &quot;maxDhcpDuration&quot;: {},
            &quot;aaaServerIp&quot;: {},
            &quot;dhcpServerIp&quot;: {}
          },
          &quot;onboardingTime&quot;: {},
          &quot;port&quot;: {}
        },
        &quot;connectedDevice&quot;: [
          {
            &quot;deviceDetails&quot;: {
              &quot;family&quot;: &quot;string&quot;,
              &quot;type&quot;: &quot;string&quot;,
              &quot;location&quot;: {},
              &quot;errorCode&quot;: {},
              &quot;macAddress&quot;: &quot;string&quot;,
              &quot;role&quot;: &quot;string&quot;,
              &quot;apManagerInterfaceIp&quot;: &quot;string&quot;,
              &quot;associatedWlcIp&quot;: &quot;string&quot;,
              &quot;bootDateTime&quot;: &quot;string&quot;,
              &quot;collectionStatus&quot;: &quot;string&quot;,
              &quot;interfaceCount&quot;: &quot;string&quot;,
              &quot;lineCardCount&quot;: &quot;string&quot;,
              &quot;lineCardId&quot;: &quot;string&quot;,
              &quot;managementIpAddress&quot;: &quot;string&quot;,
              &quot;memorySize&quot;: &quot;string&quot;,
              &quot;platformId&quot;: &quot;string&quot;,
              &quot;reachabilityFailureReason&quot;: &quot;string&quot;,
              &quot;reachabilityStatus&quot;: &quot;string&quot;,
              &quot;snmpContact&quot;: &quot;string&quot;,
              &quot;snmpLocation&quot;: &quot;string&quot;,
              &quot;tunnelUdpPort&quot;: {},
              &quot;waasDeviceMode&quot;: {},
              &quot;series&quot;: &quot;string&quot;,
              &quot;inventoryStatusDetail&quot;: &quot;string&quot;,
              &quot;collectionInterval&quot;: &quot;string&quot;,
              &quot;serialNumber&quot;: &quot;string&quot;,
              &quot;softwareVersion&quot;: &quot;string&quot;,
              &quot;roleSource&quot;: &quot;string&quot;,
              &quot;hostname&quot;: &quot;string&quot;,
              &quot;upTime&quot;: &quot;string&quot;,
              &quot;lastUpdateTime&quot;: 0,
              &quot;errorDescription&quot;: {},
              &quot;locationName&quot;: {},
              &quot;tagCount&quot;: &quot;string&quot;,
              &quot;lastUpdated&quot;: &quot;string&quot;,
              &quot;instanceUuid&quot;: &quot;string&quot;,
              &quot;id&quot;: &quot;string&quot;,
              &quot;neighborTopology&quot;: [
                {
                  &quot;errorCode&quot;: 0,
                  &quot;message&quot;: &quot;string&quot;,
                  &quot;detail&quot;: &quot;string&quot;
                }
              ]
            }
          }
        ]
      }
    ]</div>
                                    </td>
            </tr>
                        </table>
    <br/><br/>

..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Rafael Campos (@racampos)



.. Parsing errors