Cisco Cisco 3365 Mobility Services Engine White Paper
© 2013 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public Information.
Page 47 of 55
Cisco MSE API
Cisco MSE Context Aware Service can detect and track the location of wireless devices. As long as Wi-Fi is
turned on in a wireless device, Cisco MSE can detect the device (even if the device is not associated with a
wireless network). Cisco MSE has an open API to collect location and history information for different wireless
devices and to configure various parameters on Cisco MSE.
An important API feature of Cisco MSE is its capability to broadcast a real-time stream of events to a destination.
Cisco MSE can generate and send multiple types of events, but for the purposes of this document, the events of
interest are:
●
Location update events
●
Containment events
●
Generic northbound notifications
Location Update Events
Location update events are configurable events that can direct Cisco MSE to generate notifications whenever a
wireless device moves a certain distance. This feature can be enabled using the API and requires the following
information:
●
URL of the event receiver
●
Movement distance
●
Message protocol: XML or text
●
Destination type: Simple Object Access Protocol (SOAP), Simple Network Management Protocol (SNMP),
or syslog
●
Device type: client, rogue, tag, or interferer
●
MAC address filter
Containment Events
Every containment event that is sent by Cisco MSE includes the MAC address of the device, the zone or area in
which the device was detected, and information indicating whether the device was inside or outside the zone.
Generic Northbound Notifications
Cisco MSE can send a real-time stream of all the activity for all clients to a destination (Figure 50). These
notifications are a superset of the location update events. This feature can be enabled using the API and requires
the following information:
●
URL of the event receiver
●
Device type: client
●
Trigger type: location change or presence
●
Notification contents: location, custom key-value pair, and secure system ID (SSID)