Get Clients Connected to Host Device (Meraki)

This object returns the list of devices connected to the selected Meraki host device.

Input Parameters

Name Type Required Description
Meraki API Key String Yes The API key that will be used to pull information about the environment. The account used to obtain this key must have as a recommended minimum, full read-only access.
Device Serial Number String Yes The unique serial number of the device.

Output Parameters

Name Type Description
Connected Client List Collection The list of connected end-clients to the selected device. It contains following information:

ItemTypeExampleDescription
IdStringAa0a00000The connected device’s generated ID.
MACString00:00:00:00:00:00The MAC address of the device.
DescriptionStringiPadThe device description.
mDNS NameStringDevice.localThe DNS name of the device.
DHCP HostnameStringDevicenameThe device name.
IPString192.168.0.123The assigned device IP address
VLANString1The VLAN number on which the device is.
Switch PortString44The switchport of the device.
Usage SentInteger1231The reported sent traffic in bytes.
Usage ReceivedInteger161221The reported received traffic in bytes.
Count of Client Devices Number The count of connected client devices.
Result Number Returns a success value of zero or any value other than zero to indicate failure.
Result String String Object execution error details.

Example Input Parameters

Name Type Required Example
Meraki API Key String Yes 1a1a1a1a1a1a1a1a1a1a1a2a2a2a2a2a2a2a3a3a
Device Serial Number String Yes A1A1-A1A1-A1A1