cisco.dnac.client_enrichment_details_info – Information module for Client Enrichment Details

Note

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

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Client Enrichment Details.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.3.1

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
headers
dictionary
Additional headers.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

  • Supports check_mode

See Also

See also

Client Enrichment Details reference

Complete reference of the Client Enrichment Details object model.

Examples

- 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

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": "string", "hostName": {}, "hostOs": {}, "hostVersion": {}, "subType": {}, "lastUpdated": 0, "healthScore": [ { "healthType": "string", "reason": "string", "score": 0 } ], "hostMac": "string", "hostIpV4": "string", "hostIpV6": [], "authType": {}, "vlanId": "string", "ssid": {}, "location": {}, "clientConnection": "string", "connectedDevice": [], "issueCount": 0, "rssi": {}, "snr": {}, "dataRate": {}, "port": {} }, "connectedDevice": [ { "deviceDetails": { "family": "string", "type": "string", "location": {}, "errorCode": "string", "macAddress": "string", "role": "string", "apManagerInterfaceIp": "string", "associatedWlcIp": "string", "bootDateTime": {}, "collectionStatus": "string", "interfaceCount": {}, "lineCardCount": {}, "lineCardId": {}, "managementIpAddress": "string", "memorySize": "string", "platformId": "string", "reachabilityFailureReason": "string", "reachabilityStatus": "string", "snmpContact": "string", "snmpLocation": "string", "tunnelUdpPort": "string", "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": [ { "nodes": [ { "role": "string", "name": "string", "id": "string", "description": "string", "deviceType": {}, "platformId": {}, "family": {}, "ip": {}, "softwareVersion": {}, "userId": {}, "nodeType": {}, "radioFrequency": {}, "clients": 0, "count": {}, "healthScore": {}, "level": 0, "fabricGroup": {} } ], "links": [ { "source": "string", "linkStatus": "string", "label": [], "target": "string", "id": {}, "portUtilization": {} } ] } ], "cisco360view": "string" } } ], "issueDetails": { "issue": [ { "issueId": "string", "issueSource": "string", "issueCategory": "string", "issueName": "string", "issueDescription": "string", "issueEntity": "string", "issueEntityValue": "string", "issueSeverity": "string", "issuePriority": "string", "issueSummary": "string", "issueTimestamp": 0, "suggestedActions": [ { "message": "string", "steps": [] } ], "impactedHosts": [ { "hostType": "string", "hostName": "string", "hostOs": "string", "ssid": "string", "connectedInterface": "string", "macAddress": "string", "failedAttempts": 0, "location": { "siteId": "string", "siteType": "string", "area": "string", "building": "string", "floor": {}, "apsImpacted": [] }, "timestamp": 0 } ] } ] } } ]


Authors

  • Rafael Campos (@racampos)