.. Document meta
:orphan:
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
.. role:: ansible-attribute-support-label
.. role:: ansible-attribute-support-property
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. role:: ansible-option-type
.. role:: ansible-option-elements
.. role:: ansible-option-required
.. role:: ansible-option-versionadded
.. role:: ansible-option-aliases
.. role:: ansible-option-choices
.. role:: ansible-option-choices-entry
.. role:: ansible-option-default
.. role:: ansible-option-default-bold
.. role:: ansible-option-configuration
.. role:: ansible-option-returned-bold
.. role:: ansible-option-sample-bold
.. Anchors
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.client_enrichment_details_info module -- Information module for Client Enrichment Details
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This module is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 5.0.0).
You might already have this collection installed if you are using the ``ansible`` package.
It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
To install it, use: :code:`ansible-galaxy collection install cisco.dnac`.
To use it in a playbook, specify: :code:`cisco.dnac.client_enrichment_details_info`.
.. version_added
.. versionadded:: 3.1.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Get all Client Enrichment Details.
- Enriches a given network End User context a network user-id or end user's device Mac Address with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by.
.. 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 == 2.4.5
- python >= 3.5
.. Options
Parameters
----------
.. rst-class:: ansible-option-table
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - Parameter
- Comments
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-dnac_debug:
.. rst-class:: ansible-option-title
**dnac_debug**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_debug" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Flag for Cisco DNA Center SDK to enable debugging.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-default-bold:`no` :ansible-option-default:`← (default)`
- :ansible-option-choices-entry:`yes`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_host"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-dnac_host:
.. rst-class:: ansible-option-title
**dnac_host**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_host" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The Cisco DNA Center hostname.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_password"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-dnac_password:
.. rst-class:: ansible-option-title
**dnac_password**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_password" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The Cisco DNA Center password to authenticate.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_port"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-dnac_port:
.. rst-class:: ansible-option-title
**dnac_port**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_port" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The Cisco DNA Center port.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`443`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_username"></div>
<div class="ansibleOptionAnchor" id="parameter-user"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-dnac_username:
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-user:
.. rst-class:: ansible-option-title
**dnac_username**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_username" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-aliases:`aliases: user`
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The Cisco DNA Center username to authenticate.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-dnac_verify:
.. rst-class:: ansible-option-title
**dnac_verify**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_verify" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Flag to enable or disable SSL certificate verification.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`no`
- :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_version"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-dnac_version:
.. rst-class:: ansible-option-title
**dnac_version**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_version" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Informs the SDK which version of Cisco DNA Center to use.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-headers"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-headers:
.. rst-class:: ansible-option-title
**headers**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-headers" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Additional headers.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__parameter-validate_response_schema:
.. rst-class:: ansible-option-title
**validate_response_schema**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`no`
- :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
.. raw:: html
</div>
.. Attributes
.. Notes
Notes
-----
.. note::
- SDK Method used are clients.Clients.get_client_enrichment_details,
- Paths used are get /dna/intent/api/v1/client-enrichment-details,
- Supports \ :literal:`check\_mode`\
- The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
- The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
.. Seealso
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Get all Client Enrichment Details
cisco.dnac.client_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}}"
headers:
custom: value
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:
.. rst-class:: ansible-option-table
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - Key
- Description
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
.. _ansible_collections.cisco.dnac.client_enrichment_details_info_module__return-dnac_response:
.. rst-class:: ansible-option-title
**dnac_response**
.. raw:: html
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
A dictionary or list with the response returned by the Cisco DNAC Python SDK
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` always
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` "[\\n {\\n \\"userDetails\\": {\\n \\"id\\": \\"string\\",\\n \\"connectionStatus\\": \\"string\\",\\n \\"hostType\\": \\"string\\",\\n \\"userId\\": \\"string\\",\\n \\"hostName\\": {},\\n \\"hostOs\\": {},\\n \\"hostVersion\\": {},\\n \\"subType\\": {},\\n \\"lastUpdated\\": 0,\\n \\"healthScore\\": [\\n {\\n \\"healthType\\": \\"string\\",\\n \\"reason\\": \\"string\\",\\n \\"score\\": 0\\n }\\n ],\\n \\"hostMac\\": \\"string\\",\\n \\"hostIpV4\\": \\"string\\",\\n \\"hostIpV6\\": [\\n {}\\n ],\\n \\"authType\\": {},\\n \\"vlanId\\": \\"string\\",\\n \\"ssid\\": {},\\n \\"location\\": {},\\n \\"clientConnection\\": \\"string\\",\\n \\"connectedDevice\\": [\\n {}\\n ],\\n \\"issueCount\\": 0,\\n \\"rssi\\": {},\\n \\"snr\\": {},\\n \\"dataRate\\": {},\\n \\"port\\": {}\\n },\\n \\"connectedDevice\\": [\\n {\\n \\"deviceDetails\\": {\\n \\"family\\": \\"string\\",\\n \\"type\\": \\"string\\",\\n \\"location\\": {},\\n \\"errorCode\\": \\"string\\",\\n \\"macAddress\\": \\"string\\",\\n \\"role\\": \\"string\\",\\n \\"apManagerInterfaceIp\\": \\"string\\",\\n \\"associatedWlcIp\\": \\"string\\",\\n \\"bootDateTime\\": {},\\n \\"collectionStatus\\": \\"string\\",\\n \\"interfaceCount\\": {},\\n \\"lineCardCount\\": {},\\n \\"lineCardId\\": {},\\n \\"managementIpAddress\\": \\"string\\",\\n \\"memorySize\\": \\"string\\",\\n \\"platformId\\": \\"string\\",\\n \\"reachabilityFailureReason\\": \\"string\\",\\n \\"reachabilityStatus\\": \\"string\\",\\n \\"snmpContact\\": \\"string\\",\\n \\"snmpLocation\\": \\"string\\",\\n \\"tunnelUdpPort\\": \\"string\\",\\n \\"waasDeviceMode\\": {},\\n \\"series\\": \\"string\\",\\n \\"inventoryStatusDetail\\": \\"string\\",\\n \\"collectionInterval\\": \\"string\\",\\n \\"serialNumber\\": \\"string\\",\\n \\"softwareVersion\\": \\"string\\",\\n \\"roleSource\\": \\"string\\",\\n \\"hostname\\": \\"string\\",\\n \\"upTime\\": \\"string\\",\\n \\"lastUpdateTime\\": 0,\\n \\"errorDescription\\": {},\\n \\"locationName\\": {},\\n \\"tagCount\\": \\"string\\",\\n \\"lastUpdated\\": \\"string\\",\\n \\"instanceUuid\\": \\"string\\",\\n \\"id\\": \\"string\\",\\n \\"neighborTopology\\": [\\n {\\n \\"nodes\\": [\\n {\\n \\"role\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"id\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"deviceType\\": {},\\n \\"platformId\\": {},\\n \\"family\\": {},\\n \\"ip\\": {},\\n \\"softwareVersion\\": {},\\n \\"userId\\": {},\\n \\"nodeType\\": {},\\n \\"radioFrequency\\": {},\\n \\"clients\\": 0,\\n \\"count\\": {},\\n \\"healthScore\\": {},\\n \\"level\\": 0,\\n \\"fabricGroup\\": {}\\n }\\n ],\\n \\"links\\": [\\n {\\n \\"source\\": \\"string\\",\\n \\"linkStatus\\": \\"string\\",\\n \\"label\\": [\\n {}\\n ],\\n \\"target\\": \\"string\\",\\n \\"id\\": {},\\n \\"portUtilization\\": {}\\n }\\n ]\\n }\\n ],\\n \\"cisco360view\\": \\"string\\"\\n }\\n }\\n ],\\n \\"issueDetails\\": {\\n \\"issue\\": [\\n {\\n \\"issueId\\": \\"string\\",\\n \\"issueSource\\": \\"string\\",\\n \\"issueCategory\\": \\"string\\",\\n \\"issueName\\": \\"string\\",\\n \\"issueDescription\\": \\"string\\",\\n \\"issueEntity\\": \\"string\\",\\n \\"issueEntityValue\\": \\"string\\",\\n \\"issueSeverity\\": \\"string\\",\\n \\"issuePriority\\": \\"string\\",\\n \\"issueSummary\\": \\"string\\",\\n \\"issueTimestamp\\": 0,\\n \\"suggestedActions\\": [\\n {\\n \\"message\\": \\"string\\",\\n \\"steps\\": [\\n {}\\n ]\\n }\\n ],\\n \\"impactedHosts\\": [\\n {\\n \\"hostType\\": \\"string\\",\\n \\"hostName\\": \\"string\\",\\n \\"hostOs\\": \\"string\\",\\n \\"ssid\\": \\"string\\",\\n \\"connectedInterface\\": \\"string\\",\\n \\"macAddress\\": \\"string\\",\\n \\"failedAttempts\\": 0,\\n \\"location\\": {\\n \\"siteId\\": \\"string\\",\\n \\"siteType\\": \\"string\\",\\n \\"area\\": \\"string\\",\\n \\"building\\": \\"string\\",\\n \\"floor\\": {},\\n \\"apsImpacted\\": [\\n {}\\n ]\\n },\\n \\"timestamp\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n }\\n]\\n"
.. raw:: html
</div>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors