cisco.dnac.user_enrichment_details_info – Information module for User Enrichment Details

Note

This plugin is part of the cisco.dnac collection (version 3.1.1).

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all User Enrichment Details.

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		Additional headers.

See Also

See also

User Enrichment Details reference

Complete reference of the User Enrichment Details object model.

Examples

- 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}}"
    headers:
      custom: value
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response list / elements=dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: [ { "userDetails": { "id": "string", "connectionStatus": "string", "hostType": "string", "userId": {}, "hostName": {}, "hostOs": {}, "hostVersion": {}, "subType": "string", "lastUpdated": 0, "healthScore": [ { "healthType": "string", "reason": "string", "score": 0 } ], "hostMac": "string", "hostIpV4": "string", "hostIpV6": [], "authType": {}, "vlanId": "string", "ssid": {}, "frequency": {}, "channel": {}, "apGroup": {}, "location": {}, "clientConnection": "string", "connectedDevice": [], "issueCount": 0, "rssi": {}, "avgRssi": {}, "snr": {}, "avgSnr": {}, "dataRate": {}, "txBytes": {}, "rxBytes": {}, "dnsSuccess": {}, "dnsFailure": {}, "onboarding": { "averageRunDuration": {}, "maxRunDuration": {}, "averageAssocDuration": {}, "maxAssocDuration": {}, "averageAuthDuration": {}, "maxAuthDuration": {}, "averageDhcpDuration": {}, "maxDhcpDuration": {}, "aaaServerIp": {}, "dhcpServerIp": {} }, "onboardingTime": {}, "port": {} }, "connectedDevice": [ { "deviceDetails": { "family": "string", "type": "string", "location": {}, "errorCode": {}, "macAddress": "string", "role": "string", "apManagerInterfaceIp": "string", "associatedWlcIp": "string", "bootDateTime": "string", "collectionStatus": "string", "interfaceCount": "string", "lineCardCount": "string", "lineCardId": "string", "managementIpAddress": "string", "memorySize": "string", "platformId": "string", "reachabilityFailureReason": "string", "reachabilityStatus": "string", "snmpContact": "string", "snmpLocation": "string", "tunnelUdpPort": {}, "waasDeviceMode": {}, "series": "string", "inventoryStatusDetail": "string", "collectionInterval": "string", "serialNumber": "string", "softwareVersion": "string", "roleSource": "string", "hostname": "string", "upTime": "string", "lastUpdateTime": 0, "errorDescription": {}, "locationName": {}, "tagCount": "string", "lastUpdated": "string", "instanceUuid": "string", "id": "string", "neighborTopology": [ { "errorCode": 0, "message": "string", "detail": "string" } ] } } ] } ]

Authors

• Rafael Campos (@racampos)