Try SpotterManage UserEnrichmentDetails objects of Users
| "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 and devices that the user is connected to.
- name: get_user_enrichment_details
cisco.dnac.user_enrichment_details:
state: query # required
headers: # required
register: query_result
headers:
description:
- Adds the header parameters.
required: true
type: dict
get_user_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 and devices that\
\ the user is connected to."
payload:
contains:
connectedDevice:
contains:
deviceDetails:
contains:
apManagerInterfaceIp:
description: It is the user enrichment details's apManagerInterfaceIp.
returned: always
sample: <apmanagerinterfaceip>
type: str
associatedWlcIp:
description: It is the user enrichment details's associatedWlcIp.
returned: always
sample: <associatedwlcip>
type: str
bootDateTime:
description: It is the user enrichment details's bootDateTime.
returned: always
sample: <bootdatetime>
type: str
collectionInterval:
description: It is the user enrichment details's collectionInterval.
returned: always
sample: <collectioninterval>
type: str
collectionStatus:
description: It is the user enrichment details's collectionStatus.
returned: always
sample: <collectionstatus>
type: str
errorCode:
description: It is the user enrichment details's errorCode.
returned: always
type: dict
errorDescription:
description: It is the user enrichment details's errorDescription.
returned: always
type: dict
family:
description: It is the user enrichment details's family.
returned: always
sample: <family>
type: str
hostname:
description: It is the user enrichment details's hostname.
returned: always
sample: <hostname>
type: str
id:
description: It is the user enrichment details's id.
returned: always
sample: '478012'
type: str
instanceUuid:
description: It is the user enrichment details's instanceUuid.
returned: always
sample: <instanceuuid>
type: str
interfaceCount:
description: It is the user enrichment details's interfaceCount.
returned: always
sample: <interfacecount>
type: str
inventoryStatusDetail:
description: It is the user enrichment details's inventoryStatusDetail.
returned: always
sample: <inventorystatusdetail>
type: str
lastUpdateTime:
description: It is the user enrichment details's lastUpdateTime.
returned: always
sample: 0
type: int
lastUpdated:
description: It is the user enrichment details's lastUpdated.
returned: always
sample: <lastupdated>
type: str
lineCardCount:
description: It is the user enrichment details's lineCardCount.
returned: always
sample: <linecardcount>
type: str
lineCardId:
description: It is the user enrichment details's lineCardId.
returned: always
sample: <linecardid>
type: str
location:
description: It is the user enrichment details's location.
returned: always
type: dict
locationName:
description: It is the user enrichment details's locationName.
returned: always
type: dict
macAddress:
description: It is the user enrichment details's macAddress.
returned: always
sample: <macaddress>
type: str
managementIpAddress:
description: It is the user enrichment details's managementIpAddress.
returned: always
sample: <managementipaddress>
type: str
memorySize:
description: It is the user enrichment details's memorySize.
returned: always
sample: <memorysize>
type: str
neighborTopology:
contains:
detail:
description: It is the user enrichment details's detail.
returned: always
sample: <detail>
type: str
errorCode:
description: It is the user enrichment details's errorCode.
returned: always
sample: 0
type: int
message:
description: It is the user enrichment details's message.
returned: always
sample: <message>
type: str
description: It is the user enrichment details's neighborTopology.
returned: always
type: list
platformId:
description: It is the user enrichment details's platformId.
returned: always
sample: <platformid>
type: str
reachabilityFailureReason:
description: It is the user enrichment details's reachabilityFailureReason.
returned: always
sample: <reachabilityfailurereason>
type: str
reachabilityStatus:
description: It is the user enrichment details's reachabilityStatus.
returned: always
sample: <reachabilitystatus>
type: str
role:
description: It is the user enrichment details's role.
returned: always
sample: <role>
type: str
roleSource:
description: It is the user enrichment details's roleSource.
returned: always
sample: <rolesource>
type: str
serialNumber:
description: It is the user enrichment details's serialNumber.
returned: always
sample: <serialnumber>
type: str
series:
description: It is the user enrichment details's series.
returned: always
sample: <series>
type: str
snmpContact:
description: It is the user enrichment details's snmpContact.
returned: always
sample: <snmpcontact>
type: str
snmpLocation:
description: It is the user enrichment details's snmpLocation.
returned: always
sample: <snmplocation>
type: str
softwareVersion:
description: It is the user enrichment details's softwareVersion.
returned: always
sample: <softwareversion>
type: str
tagCount:
description: It is the user enrichment details's tagCount.
returned: always
sample: <tagcount>
type: str
tunnelUdpPort:
description: It is the user enrichment details's tunnelUdpPort.
returned: always
type: dict
type:
description: It is the user enrichment details's type.
returned: always
sample: <type>
type: str
upTime:
description: It is the user enrichment details's upTime.
returned: always
sample: <uptime>
type: str
waasDeviceMode:
description: It is the user enrichment details's waasDeviceMode.
returned: always
type: dict
description: It is the user enrichment details's deviceDetails.
returned: always
type: dict
description: It is the user enrichment details's connectedDevice.
returned: always
type: list
userDetails:
contains:
apGroup:
description: It is the user enrichment details's apGroup.
returned: always
type: dict
authType:
description: It is the user enrichment details's authType.
returned: always
type: dict
avgRssi:
description: It is the user enrichment details's avgRssi.
returned: always
type: dict
avgSnr:
description: It is the user enrichment details's avgSnr.
returned: always
type: dict
channel:
description: It is the user enrichment details's channel.
returned: always
type: dict
clientConnection:
description: It is the user enrichment details's clientConnection.
returned: always
sample: <clientconnection>
type: str
connectedDevice:
description: It is the user enrichment details's connectedDevice.
returned: always
type: list
connectionStatus:
description: It is the user enrichment details's connectionStatus.
returned: always
sample: <connectionstatus>
type: str
dataRate:
description: It is the user enrichment details's dataRate.
returned: always
type: dict
dnsFailure:
description: It is the user enrichment details's dnsFailure.
returned: always
type: dict
dnsSuccess:
description: It is the user enrichment details's dnsSuccess.
returned: always
type: dict
frequency:
description: It is the user enrichment details's frequency.
returned: always
type: dict
healthScore:
contains:
healthType:
description: It is the user enrichment details's healthType.
returned: always
sample: <healthtype>
type: str
reason:
description: It is the user enrichment details's reason.
returned: always
sample: <reason>
type: str
score:
description: It is the user enrichment details's score.
returned: always
sample: 0
type: int
description: It is the user enrichment details's healthScore.
returned: always
type: list
hostIpV4:
description: It is the user enrichment details's hostIpV4.
returned: always
sample: <hostipv4>
type: str
hostIpV6:
description: It is the user enrichment details's hostIpV6.
returned: always
type: list
hostMac:
description: It is the user enrichment details's hostMac.
returned: always
sample: <hostmac>
type: str
hostName:
description: It is the user enrichment details's hostName.
returned: always
type: dict
hostOs:
description: It is the user enrichment details's hostOs.
returned: always
type: dict
hostType:
description: It is the user enrichment details's hostType.
returned: always
sample: <hosttype>
type: str
hostVersion:
description: It is the user enrichment details's hostVersion.
returned: always
type: dict
id:
description: It is the user enrichment details's id.
returned: always
sample: '478012'
type: str
issueCount:
description: It is the user enrichment details's issueCount.
returned: always
sample: 0
type: int
lastUpdated:
description: It is the user enrichment details's lastUpdated.
returned: always
sample: 0
type: int
location:
description: It is the user enrichment details's location.
returned: always
type: dict
onboarding:
contains:
aaaServerIp:
description: It is the user enrichment details's aaaServerIp.
returned: always
type: dict
averageAssocDuration:
description: It is the user enrichment details's averageAssocDuration.
returned: always
type: dict
averageAuthDuration:
description: It is the user enrichment details's averageAuthDuration.
returned: always
type: dict
averageDhcpDuration:
description: It is the user enrichment details's averageDhcpDuration.
returned: always
type: dict
averageRunDuration:
description: It is the user enrichment details's averageRunDuration.
returned: always
type: dict
dhcpServerIp:
description: It is the user enrichment details's dhcpServerIp.
returned: always
type: dict
maxAssocDuration:
description: It is the user enrichment details's maxAssocDuration.
returned: always
type: dict
maxAuthDuration:
description: It is the user enrichment details's maxAuthDuration.
returned: always
type: dict
maxDhcpDuration:
description: It is the user enrichment details's maxDhcpDuration.
returned: always
type: dict
maxRunDuration:
description: It is the user enrichment details's maxRunDuration.
returned: always
type: dict
description: It is the user enrichment details's onboarding.
returned: always
type: dict
onboardingTime:
description: It is the user enrichment details's onboardingTime.
returned: always
type: dict
port:
description: It is the user enrichment details's port.
returned: always
type: dict
rssi:
description: It is the user enrichment details's rssi.
returned: always
type: dict
rxBytes:
description: It is the user enrichment details's rxBytes.
returned: always
type: dict
snr:
description: It is the user enrichment details's snr.
returned: always
type: dict
ssid:
description: It is the user enrichment details's ssid.
returned: always
type: dict
subType:
description: It is the user enrichment details's subType.
returned: always
sample: <subtype>
type: str
txBytes:
description: It is the user enrichment details's txBytes.
returned: always
type: dict
userId:
description: It is the user enrichment details's userId.
returned: always
type: dict
vlanId:
description: It is the user enrichment details's vlanId.
returned: always
sample: <vlanid>
type: str
description: It is the user enrichment details's userDetails.
returned: always
type: dict
description: It is the user enrichment details's payload.
returned: always
type: list
returned: always
type: dict