Clients

Module: Clients

Members

Methods

Clients

clients.js:3
clients.js:3

Methods

clients.js:55

(static) getClient(netId, client)

Return a client

Parameters
Name Type Description
netId *
client *
clients.js:88

(static) getClientPolicy(netId, clientMac, timespan)

Returnpolicy for a Client in a Network

Parameters
Name Type Description
netId *
clientMac *
timespan *
clients.js:42

(static) getClients(serial, timespan) → {Promise}

list the cliets for a Meraki device serial for a given timespan in seconds

Examples

Example request

meraki.getClients(serial, 86400).then((res) => {
console.log(res.data);
});

Example response

    [ { usage: { sent: 34169.925098183834, recv: 307158.1854811088 },
    id: 'k6c0941',
    description: 'Miles-MacBook-Pro-2',
    mdnsName: 'Miles-MacBook-Pro-2.local',
    dhcpHostname: null,
    mac: 'e0:55:3d:6c:ff:ff',
    ip: '192.168.0.1',
    vlan: 1,
    switchport: '1' },
  { usage: { sent: 0, recv: 112.21213665513233 },
    id: 'k6e9ac3',
    description: 'Android',
    mdnsName: 'Android.local',
    dhcpHostname: 'android-a73b2c8781caa2d2',
    mac: '60:e3:ac:f7:ff:ff',
    ip: '192.168.0.137',
    vlan: 1,
    switchport: '1' }]
Parameters
Name Type Description
serial *
timespan *
Returns

A promise holding the clients for this device serial

Type
Promise
clients.js:71

(static) getClientUsageHistory(netId, client)

Return client usage history

Parameters
Name Type Description
netId *
client *
clients.js:116

(static) getSplashAuth(netId, clientMac)

Return the splash authorization for a client, for each SSID they've associated with through splash.

Parameters
Name Type Description
netId *
clientMac *
clients.js:100

(static) updateClientPolicy(netId, clientMac, timespan, data)

update the policy for a Client in a Network

Parameters
Name Type Description
netId *
clientMac *
timespan *
data *
clients.js:127

(static) updateSplashAuth(netId, clientMac, body)

Return the splash authorization for a client, for each SSID they've associated with through splash.

Parameters
Name Type Description
netId *
clientMac *
body *