cisco.dnac.user_enrichment_details_info (6.13.3) — module

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all User 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 and devices that the user is connected to.

Requirements

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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: "{{my_headers | from_json}}"
  register: result

Inputs

    
headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  returned: always
  sample: "[\n  {\n    \"userDetails\": {\n      \"id\": \"string\",\n      \"connectionStatus\"\
    : \"string\",\n      \"hostType\": \"string\",\n      \"userId\": {},\n      \"\
    hostName\": {},\n      \"hostOs\": {},\n      \"hostVersion\": {},\n      \"subType\"\
    : \"string\",\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\
    \      \"frequency\": {},\n      \"channel\": {},\n      \"apGroup\": {},\n  \
    \    \"location\": {},\n      \"clientConnection\": \"string\",\n      \"connectedDevice\"\
    : [\n        {}\n      ],\n      \"issueCount\": 0,\n      \"rssi\": {},\n   \
    \   \"avgRssi\": {},\n      \"snr\": {},\n      \"avgSnr\": {},\n      \"dataRate\"\
    : {},\n      \"txBytes\": {},\n      \"rxBytes\": {},\n      \"dnsSuccess\": {},\n\
    \      \"dnsFailure\": {},\n      \"onboarding\": {\n        \"averageRunDuration\"\
    : {},\n        \"maxRunDuration\": {},\n        \"averageAssocDuration\": {},\n\
    \        \"maxAssocDuration\": {},\n        \"averageAuthDuration\": {},\n   \
    \     \"maxAuthDuration\": {},\n        \"averageDhcpDuration\": {},\n       \
    \ \"maxDhcpDuration\": {},\n        \"aaaServerIp\": {},\n        \"dhcpServerIp\"\
    : {}\n      },\n      \"onboardingTime\": {},\n      \"port\": {}\n    },\n  \
    \  \"connectedDevice\": [\n      {\n        \"deviceDetails\": {\n          \"\
    family\": \"string\",\n          \"type\": \"string\",\n          \"location\"\
    : {},\n          \"errorCode\": {},\n          \"macAddress\": \"string\",\n \
    \         \"role\": \"string\",\n          \"apManagerInterfaceIp\": \"string\"\
    ,\n          \"associatedWlcIp\": \"string\",\n          \"bootDateTime\": \"\
    string\",\n          \"collectionStatus\": \"string\",\n          \"interfaceCount\"\
    : \"string\",\n          \"lineCardCount\": \"string\",\n          \"lineCardId\"\
    : \"string\",\n          \"managementIpAddress\": \"string\",\n          \"memorySize\"\
    : \"string\",\n          \"platformId\": \"string\",\n          \"reachabilityFailureReason\"\
    : \"string\",\n          \"reachabilityStatus\": \"string\",\n          \"snmpContact\"\
    : \"string\",\n          \"snmpLocation\": \"string\",\n          \"tunnelUdpPort\"\
    : {},\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              \"errorCode\": 0,\n\
    \              \"message\": \"string\",\n              \"detail\": \"string\"\n\
    \            }\n          ]\n        }\n      }\n    ]\n  }\n]\n"
  type: list

See also

• Cisco DNA Center documentation for Users GetUserEnrichmentDetails: Complete reference of the GetUserEnrichmentDetails API. link