Try SpotterManage ClientEnrichmentDetails objects of Clients
| "added in version" 1.0 of racampos.dnac"
Authors: first last (@GitHubID)
preview | supported by community
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install racampos.dnac:==0.0.1
collections:
- name: racampos.dnac
version: 0.0.1Enriches 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.
- name: get_client_enrichment_details
cisco.dnac.client_enrichment_details:
state: query # required
headers: # required
register: query_result
headers:
description:
- Adds the header parameters.
required: true
type: dict
get_client_enrichment_details:
contains: null
description: "Enriches a given network End User context (a network user-id or end\
\ user\u2019s 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."
payload:
contains:
connectedDevice:
contains:
deviceDetails:
contains:
apManagerInterfaceIp:
description: It is the client enrichment details's apManagerInterfaceIp.
returned: always
sample: <apmanagerinterfaceip>
type: str
associatedWlcIp:
description: It is the client enrichment details's associatedWlcIp.
returned: always
sample: <associatedwlcip>
type: str
bootDateTime:
description: It is the client enrichment details's bootDateTime.
returned: always
type: dict
cisco360view:
description: It is the client enrichment details's cisco360view.
returned: always
sample: <cisco360view>
type: str
collectionInterval:
description: It is the client enrichment details's collectionInterval.
returned: always
sample: <collectioninterval>
type: str
collectionStatus:
description: It is the client enrichment details's collectionStatus.
returned: always
sample: <collectionstatus>
type: str
errorCode:
description: It is the client enrichment details's errorCode.
returned: always
sample: <errorcode>
type: str
errorDescription:
description: It is the client enrichment details's errorDescription.
returned: always
type: dict
family:
description: It is the client enrichment details's family.
returned: always
sample: <family>
type: str
hostname:
description: It is the client enrichment details's hostname.
returned: always
sample: <hostname>
type: str
id:
description: It is the client enrichment details's id.
returned: always
sample: '478012'
type: str
instanceUuid:
description: It is the client enrichment details's instanceUuid.
returned: always
sample: <instanceuuid>
type: str
interfaceCount:
description: It is the client enrichment details's interfaceCount.
returned: always
type: dict
inventoryStatusDetail:
description: It is the client enrichment details's inventoryStatusDetail.
returned: always
sample: <inventorystatusdetail>
type: str
lastUpdateTime:
description: It is the client enrichment details's lastUpdateTime.
returned: always
sample: 0
type: int
lastUpdated:
description: It is the client enrichment details's lastUpdated.
returned: always
sample: <lastupdated>
type: str
lineCardCount:
description: It is the client enrichment details's lineCardCount.
returned: always
type: dict
lineCardId:
description: It is the client enrichment details's lineCardId.
returned: always
type: dict
location:
description: It is the client enrichment details's location.
returned: always
type: dict
locationName:
description: It is the client enrichment details's locationName.
returned: always
type: dict
macAddress:
description: It is the client enrichment details's macAddress.
returned: always
sample: <macaddress>
type: str
managementIpAddress:
description: It is the client enrichment details's managementIpAddress.
returned: always
sample: <managementipaddress>
type: str
memorySize:
description: It is the client enrichment details's memorySize.
returned: always
sample: <memorysize>
type: str
neighborTopology:
contains:
links:
contains:
id:
description: It is the client enrichment details's id.
returned: always
type: dict
label:
description: It is the client enrichment details's label.
returned: always
type: list
linkStatus:
description: It is the client enrichment details's linkStatus.
returned: always
sample: <linkstatus>
type: str
portUtilization:
description: It is the client enrichment details's portUtilization.
returned: always
type: dict
source:
description: It is the client enrichment details's source.
returned: always
sample: <source>
type: str
target:
description: It is the client enrichment details's target.
returned: always
sample: <target>
type: str
description: It is the client enrichment details's links.
returned: always
type: list
nodes:
contains:
clients:
description: It is the client enrichment details's clients.
returned: always
sample: 0
type: int
count:
description: It is the client enrichment details's count.
returned: always
type: dict
description:
description: It is the client enrichment details's description.
returned: always
sample: <description>
type: str
deviceType:
description: It is the client enrichment details's deviceType.
returned: always
type: dict
fabricGroup:
description: It is the client enrichment details's fabricGroup.
returned: always
type: dict
family:
description: It is the client enrichment details's family.
returned: always
type: dict
healthScore:
description: It is the client enrichment details's healthScore.
returned: always
type: dict
id:
description: It is the client enrichment details's id.
returned: always
sample: '478012'
type: str
ip:
description: It is the client enrichment details's ip.
returned: always
type: dict
level:
description: It is the client enrichment details's level.
returned: always
sample: 0
type: int
name:
description: It is the client enrichment details's name.
returned: always
sample: <name>
type: str
nodeType:
description: It is the client enrichment details's nodeType.
returned: always
type: dict
platformId:
description: It is the client enrichment details's platformId.
returned: always
type: dict
radioFrequency:
description: It is the client enrichment details's radioFrequency.
returned: always
type: dict
role:
description: It is the client enrichment details's role.
returned: always
sample: <role>
type: str
softwareVersion:
description: It is the client enrichment details's softwareVersion.
returned: always
type: dict
userId:
description: It is the client enrichment details's userId.
returned: always
type: dict
description: It is the client enrichment details's nodes.
returned: always
type: list
description: It is the client enrichment details's neighborTopology.
returned: always
type: list
platformId:
description: It is the client enrichment details's platformId.
returned: always
sample: <platformid>
type: str
reachabilityFailureReason:
description: It is the client enrichment details's reachabilityFailureReason.
returned: always
sample: <reachabilityfailurereason>
type: str
reachabilityStatus:
description: It is the client enrichment details's reachabilityStatus.
returned: always
sample: <reachabilitystatus>
type: str
role:
description: It is the client enrichment details's role.
returned: always
sample: <role>
type: str
roleSource:
description: It is the client enrichment details's roleSource.
returned: always
sample: <rolesource>
type: str
serialNumber:
description: It is the client enrichment details's serialNumber.
returned: always
sample: <serialnumber>
type: str
series:
description: It is the client enrichment details's series.
returned: always
sample: <series>
type: str
snmpContact:
description: It is the client enrichment details's snmpContact.
returned: always
sample: <snmpcontact>
type: str
snmpLocation:
description: It is the client enrichment details's snmpLocation.
returned: always
sample: <snmplocation>
type: str
softwareVersion:
description: It is the client enrichment details's softwareVersion.
returned: always
sample: <softwareversion>
type: str
tagCount:
description: It is the client enrichment details's tagCount.
returned: always
sample: <tagcount>
type: str
tunnelUdpPort:
description: It is the client enrichment details's tunnelUdpPort.
returned: always
sample: <tunneludpport>
type: str
type:
description: It is the client enrichment details's type.
returned: always
sample: <type>
type: str
upTime:
description: It is the client enrichment details's upTime.
returned: always
sample: <uptime>
type: str
waasDeviceMode:
description: It is the client enrichment details's waasDeviceMode.
returned: always
type: dict
description: It is the client enrichment details's deviceDetails.
returned: always
type: dict
description: It is the client enrichment details's connectedDevice.
returned: always
type: list
issueDetails:
contains:
issue:
contains:
impactedHosts:
contains:
connectedInterface:
description: It is the client enrichment details's connectedInterface.
returned: always
sample: <connectedinterface>
type: str
failedAttempts:
description: It is the client enrichment details's failedAttempts.
returned: always
sample: 0
type: int
hostName:
description: It is the client enrichment details's hostName.
returned: always
sample: <hostname>
type: str
hostOs:
description: It is the client enrichment details's hostOs.
returned: always
sample: <hostos>
type: str
hostType:
description: It is the client enrichment details's hostType.
returned: always
sample: <hosttype>
type: str
location:
contains:
apsImpacted:
description: It is the client enrichment details's apsImpacted.
returned: always
type: list
area:
description: It is the client enrichment details's area.
returned: always
sample: <area>
type: str
building:
description: It is the client enrichment details's building.
returned: always
sample: <building>
type: str
floor:
description: It is the client enrichment details's floor.
returned: always
type: dict
siteId:
description: It is the client enrichment details's siteId.
returned: always
sample: <siteid>
type: str
siteType:
description: It is the client enrichment details's siteType.
returned: always
sample: <sitetype>
type: str
description: It is the client enrichment details's location.
returned: always
type: dict
macAddress:
description: It is the client enrichment details's macAddress.
returned: always
sample: <macaddress>
type: str
ssid:
description: It is the client enrichment details's ssid.
returned: always
sample: <ssid>
type: str
timestamp:
description: It is the client enrichment details's timestamp.
returned: always
sample: 0
type: int
description: It is the client enrichment details's impactedHosts.
returned: always
type: list
issueCategory:
description: It is the client enrichment details's issueCategory.
returned: always
sample: <issuecategory>
type: str
issueDescription:
description: It is the client enrichment details's issueDescription.
returned: always
sample: <issuedescription>
type: str
issueEntity:
description: It is the client enrichment details's issueEntity.
returned: always
sample: <issueentity>
type: str
issueEntityValue:
description: It is the client enrichment details's issueEntityValue.
returned: always
sample: <issueentityvalue>
type: str
issueId:
description: It is the client enrichment details's issueId.
returned: always
sample: <issueid>
type: str
issueName:
description: It is the client enrichment details's issueName.
returned: always
sample: <issuename>
type: str
issuePriority:
description: It is the client enrichment details's issuePriority.
returned: always
sample: <issuepriority>
type: str
issueSeverity:
description: It is the client enrichment details's issueSeverity.
returned: always
sample: <issueseverity>
type: str
issueSource:
description: It is the client enrichment details's issueSource.
returned: always
sample: <issuesource>
type: str
issueSummary:
description: It is the client enrichment details's issueSummary.
returned: always
sample: <issuesummary>
type: str
issueTimestamp:
description: It is the client enrichment details's issueTimestamp.
returned: always
sample: 0
type: int
suggestedActions:
contains:
message:
description: It is the client enrichment details's message.
returned: always
sample: <message>
type: str
steps:
description: It is the client enrichment details's steps.
returned: always
type: list
description: It is the client enrichment details's suggestedActions.
returned: always
type: list
description: It is the client enrichment details's issue.
returned: always
type: list
description: It is the client enrichment details's issueDetails.
returned: always
type: dict
userDetails:
contains:
authType:
description: It is the client enrichment details's authType.
returned: always
type: dict
clientConnection:
description: It is the client enrichment details's clientConnection.
returned: always
sample: <clientconnection>
type: str
connectedDevice:
description: It is the client enrichment details's connectedDevice.
returned: always
type: list
connectionStatus:
description: It is the client enrichment details's connectionStatus.
returned: always
sample: <connectionstatus>
type: str
dataRate:
description: It is the client enrichment details's dataRate.
returned: always
type: dict
healthScore:
contains:
healthType:
description: It is the client enrichment details's healthType.
returned: always
sample: <healthtype>
type: str
reason:
description: It is the client enrichment details's reason.
returned: always
sample: <reason>
type: str
score:
description: It is the client enrichment details's score.
returned: always
sample: 0
type: int
description: It is the client enrichment details's healthScore.
returned: always
type: list
hostIpV4:
description: It is the client enrichment details's hostIpV4.
returned: always
sample: <hostipv4>
type: str
hostIpV6:
description: It is the client enrichment details's hostIpV6.
returned: always
type: list
hostMac:
description: It is the client enrichment details's hostMac.
returned: always
sample: <hostmac>
type: str
hostName:
description: It is the client enrichment details's hostName.
returned: always
type: dict
hostOs:
description: It is the client enrichment details's hostOs.
returned: always
type: dict
hostType:
description: It is the client enrichment details's hostType.
returned: always
sample: <hosttype>
type: str
hostVersion:
description: It is the client enrichment details's hostVersion.
returned: always
type: dict
id:
description: It is the client enrichment details's id.
returned: always
sample: '478012'
type: str
issueCount:
description: It is the client enrichment details's issueCount.
returned: always
sample: 0
type: int
lastUpdated:
description: It is the client enrichment details's lastUpdated.
returned: always
sample: 0
type: int
location:
description: It is the client enrichment details's location.
returned: always
type: dict
port:
description: It is the client enrichment details's port.
returned: always
type: dict
rssi:
description: It is the client enrichment details's rssi.
returned: always
type: dict
snr:
description: It is the client enrichment details's snr.
returned: always
type: dict
ssid:
description: It is the client enrichment details's ssid.
returned: always
type: dict
subType:
description: It is the client enrichment details's subType.
returned: always
type: dict
userId:
description: It is the client enrichment details's userId.
returned: always
sample: <userid>
type: str
vlanId:
description: It is the client enrichment details's vlanId.
returned: always
sample: <vlanid>
type: str
description: It is the client enrichment details's userDetails.
returned: always
type: dict
description: It is the client enrichment details's payload.
returned: always
type: list
returned: always
type: dict