Get Clients Connected to Host Device (Meraki)
This object returns the list of devices connected to the selected Meraki host device.
Input Parameters
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
Connected Client List |
Collection
|
The list of connected end-clients to the selected device. It contains following information:
Id | String | Aa0a00000 | The connected device’s generated ID. | MAC | String | 00:00:00:00:00:00 | The MAC address of the device. | Description | String | iPad | The device description. | mDNS Name | String | Device.local | The DNS name of the device. | DHCP Hostname | String | Devicename | The device name. | IP | String | 192.168.0.123 | The assigned device IP address | VLAN | String | 1 | The VLAN number on which the device is. | Switch Port | String | 44 | The switchport of the device. | Usage Sent | Integer | 1231 | The reported sent traffic in bytes. | Usage Received | Integer | 161221 | The 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
Meraki API Key |
String |
Yes |
1a1a1a1a1a1a1a1a1a1a1a2a2a2a2a2a2a2a3a3a |
Device Serial Number |
String |
Yes |
A1A1-A1A1-A1A1 |