Try SpotterManage ClientDetail 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.1Returns detailed Client information retrieved by Mac Address for any given point of time.
- name: get_client_detail
cisco.dnac.client_detail:
state: query # required
mac_address: SomeValue # string, required
timestamp: 1 # integer
register: query_result
timestamp:
description:
- Epoch time(in milliseconds) when the Client health data is required.
type: int
mac_address:
description:
- MAC Address of the client.
required: true
type: str
get_client_detail:
connectionInfo:
contains:
band:
description: It is the client detail's band.
returned: always
sample: <band>
type: str
channel:
description: It is the client detail's channel.
returned: always
sample: <channel>
type: str
channelWidth:
description: It is the client detail's channelWidth.
returned: always
sample: <channelwidth>
type: str
hostType:
description: It is the client detail's hostType.
returned: always
sample: <hosttype>
type: str
nwDeviceMac:
description: It is the client detail's nwDeviceMac.
returned: always
sample: <nwdevicemac>
type: str
nwDeviceName:
description: It is the client detail's nwDeviceName.
returned: always
sample: <nwdevicename>
type: str
protocol:
description: It is the client detail's protocol.
returned: always
sample: <protocol>
type: str
spatialStream:
description: It is the client detail's spatialStream.
returned: always
sample: <spatialstream>
type: str
timestamp:
description: It is the client detail's timestamp.
returned: always
sample: 0
type: int
uapsd:
description: It is the client detail's uapsd.
returned: always
sample: <uapsd>
type: str
wmm:
description: It is the client detail's wmm.
returned: always
sample: <wmm>
type: str
description: Connection Info, property of the response body.
returned: always
type: dict
contains: null
description: Returns detailed Client information retrieved by Mac Address for any
given point of time.
detail:
contains:
apGroup:
description: It is the client detail's apGroup.
returned: always
type: dict
authType:
description: It is the client detail's authType.
returned: always
sample: <authtype>
type: str
avgRssi:
description: It is the client detail's avgRssi.
returned: always
type: dict
avgSnr:
description: It is the client detail's avgSnr.
returned: always
type: dict
channel:
description: It is the client detail's channel.
returned: always
sample: <channel>
type: str
clientConnection:
description: It is the client detail's clientConnection.
returned: always
sample: <clientconnection>
type: str
clientType:
description: It is the client detail's clientType.
returned: always
sample: <clienttype>
type: str
connectedDevice:
description: It is the client detail's connectedDevice.
returned: always
type: list
connectionStatus:
description: It is the client detail's connectionStatus.
returned: always
sample: <connectionstatus>
type: str
dataRate:
description: It is the client detail's dataRate.
returned: always
sample: <datarate>
type: str
dnsFailure:
description: It is the client detail's dnsFailure.
returned: always
type: dict
dnsSuccess:
description: It is the client detail's dnsSuccess.
returned: always
type: dict
frequency:
description: It is the client detail's frequency.
returned: always
sample: <frequency>
type: str
healthScore:
contains:
healthType:
description: It is the client detail's healthType.
returned: always
sample: <healthtype>
type: str
reason:
description: It is the client detail's reason.
returned: always
sample: <reason>
type: str
score:
description: It is the client detail's score.
returned: always
sample: 0
type: int
description: It is the client detail's healthScore.
returned: always
type: list
hostIpV4:
description: It is the client detail's hostIpV4.
returned: always
sample: <hostipv4>
type: str
hostIpV6:
description: It is the client detail's hostIpV6.
returned: always
type: list
hostMac:
description: It is the client detail's hostMac.
returned: always
sample: <hostmac>
type: str
hostName:
description: It is the client detail's hostName.
returned: always
sample: <hostname>
type: str
hostOs:
description: It is the client detail's hostOs.
returned: always
type: dict
hostType:
description: It is the client detail's hostType.
returned: always
sample: <hosttype>
type: str
hostVersion:
description: It is the client detail's hostVersion.
returned: always
type: dict
id:
description: It is the client detail's id.
returned: always
sample: '478012'
type: str
iosCapable:
description: It is the client detail's iosCapable.
returned: always
sample: false
type: bool
issueCount:
description: It is the client detail's issueCount.
returned: always
sample: 0
type: int
lastUpdated:
description: It is the client detail's lastUpdated.
returned: always
sample: 0
type: int
location:
description: It is the client detail's location.
returned: always
type: dict
onboarding:
contains:
aaaRootcauseList:
description: It is the client detail's aaaRootcauseList.
returned: always
type: list
aaaServerIp:
description: It is the client detail's aaaServerIp.
returned: always
sample: <aaaserverip>
type: str
assocDoneTime:
description: It is the client detail's assocDoneTime.
returned: always
type: dict
assocRootcauseList:
description: It is the client detail's assocRootcauseList.
returned: always
type: list
authDoneTime:
description: It is the client detail's authDoneTime.
returned: always
type: dict
averageAssocDuration:
description: It is the client detail's averageAssocDuration.
returned: always
type: dict
averageAuthDuration:
description: It is the client detail's averageAuthDuration.
returned: always
type: dict
averageDhcpDuration:
description: It is the client detail's averageDhcpDuration.
returned: always
type: dict
averageRunDuration:
description: It is the client detail's averageRunDuration.
returned: always
type: dict
dhcpDoneTime:
description: It is the client detail's dhcpDoneTime.
returned: always
type: dict
dhcpRootcauseList:
description: It is the client detail's dhcpRootcauseList.
returned: always
type: list
dhcpServerIp:
description: It is the client detail's dhcpServerIp.
returned: always
type: dict
maxAssocDuration:
description: It is the client detail's maxAssocDuration.
returned: always
type: dict
maxAuthDuration:
description: It is the client detail's maxAuthDuration.
returned: always
type: dict
maxDhcpDuration:
description: It is the client detail's maxDhcpDuration.
returned: always
type: dict
maxRunDuration:
description: It is the client detail's maxRunDuration.
returned: always
type: dict
otherRootcauseList:
description: It is the client detail's otherRootcauseList.
returned: always
type: list
description: It is the client detail's onboarding.
returned: always
type: dict
onboardingTime:
description: It is the client detail's onboardingTime.
returned: always
type: dict
port:
description: It is the client detail's port.
returned: always
type: dict
rssi:
description: It is the client detail's rssi.
returned: always
sample: <rssi>
type: str
rxBytes:
description: It is the client detail's rxBytes.
returned: always
sample: <rxbytes>
type: str
snr:
description: It is the client detail's snr.
returned: always
sample: <snr>
type: str
ssid:
description: It is the client detail's ssid.
returned: always
sample: <ssid>
type: str
subType:
description: It is the client detail's subType.
returned: always
sample: <subtype>
type: str
txBytes:
description: It is the client detail's txBytes.
returned: always
sample: <txbytes>
type: str
userId:
description: It is the client detail's userId.
returned: always
type: dict
vlanId:
description: It is the client detail's vlanId.
returned: always
sample: <vlanid>
type: str
vnid:
description: It is the client detail's vnid.
returned: always
sample: <vnid>
type: str
description: Detail, property of the response body.
returned: always
type: dict
returned: always
topology:
contains:
links:
contains:
id:
description: It is the client detail's id.
returned: always
type: dict
label:
description: It is the client detail's label.
returned: always
type: list
linkStatus:
description: It is the client detail's linkStatus.
returned: always
sample: <linkstatus>
type: str
portUtilization:
description: It is the client detail's portUtilization.
returned: always
type: dict
source:
description: It is the client detail's source.
returned: always
sample: <source>
type: str
target:
description: It is the client detail's target.
returned: always
sample: <target>
type: str
description: It is the client detail's links.
returned: always
type: list
nodes:
contains:
clients:
description: It is the client detail's clients.
returned: always
type: dict
connectedDevice:
description: It is the client detail's connectedDevice.
returned: always
type: dict
count:
description: It is the client detail's count.
returned: always
type: dict
description:
description: It is the client detail's description.
returned: always
sample: <description>
type: str
deviceType:
description: It is the client detail's deviceType.
returned: always
sample: <devicetype>
type: str
fabricGroup:
description: It is the client detail's fabricGroup.
returned: always
type: dict
family:
description: It is the client detail's family.
returned: always
type: dict
healthScore:
description: It is the client detail's healthScore.
returned: always
sample: 0
type: int
id:
description: It is the client detail's id.
returned: always
sample: '478012'
type: str
ip:
description: It is the client detail's ip.
returned: always
sample: 1.1.1.17
type: str
level:
description: It is the client detail's level.
returned: always
sample: 0
type: int
name:
description: It is the client detail's name.
returned: always
sample: <name>
type: str
nodeType:
description: It is the client detail's nodeType.
returned: always
sample: <nodetype>
type: str
platformId:
description: It is the client detail's platformId.
returned: always
type: dict
radioFrequency:
description: It is the client detail's radioFrequency.
returned: always
type: dict
role:
description: It is the client detail's role.
returned: always
sample: <role>
type: str
softwareVersion:
description: It is the client detail's softwareVersion.
returned: always
type: dict
userId:
description: It is the client detail's userId.
returned: always
type: dict
description: It is the client detail's nodes.
returned: always
type: list
description: Topology, property of the response body.
returned: always
type: dict
type: dict