Legal Disclaimer: The resource assets in this website may include abbreviated and/or legacy terminology for HPE Aruba Networking products. See www.arubanetworks.com for current and complete HPE Aruba Networking product lines and names.
Streaming API
Streaming API Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. allows customers to subscribe to a select set of services instead of polling the NB API Northbound Application Programming Interface. A northbound interface is an application programming interface (API) or protocol that allows a lower-level network component to communicate with a higher-level or more central component. to get an aggregated state or statistics of the events. For example, with Streaming API, the customers can get notifications about the following types of events:
- The UP and DOWN status of the devices
- Change in location of stations
For a complete list of supported services, with Streaming API, users can write applications based on the aggregated context.
- Streaming API service in HPE Aruba Networking Central requires an Advanced License for all the managed devices. For more information about streaming API in the HPE Aruba Networking Central licensing model, see HPE Aruba Networking Central Licensing Guide.
-
MSP Managed Service Provider. The Managed Service Provider (MSP) mode is a multi-tenant operational mode that Aruba Central accounts can be converted into, provided these accounts have subscribed to the Aruba Central app. level does not support Streaming API services.
- For users with limited group scope, the menu will appear in the left menu when you click the keywords like Groups or Sites in the context selector.
Supported Services
Streaming API supports the following services:
- Audit—The Audit messages are sent to notify events like device connectivity, configuration status, and firmware status.
- AppRF—AppRF stream is the flow of all the client sessions. For each connected device (IAP/BGW), It lists the client's web session information of the past 14/15 minutes (Ip, Rx/Tx, Timestamp, etc).
- Monitoring—The monitoring streaming event is generated for state message (on state change) and stats message (received for every 5 minutes).
- Presence —The Presence events are sent to provide details of all associated and unassociated clients detected by Instant AP devices.
- Location—A location event is generated when a client location is computed using RSSI Received Signal Strength Indicator. RSSI is a mechanism by which RF energy is measured by the circuitry on a wireless NIC (0-255). The RSSI is not standard across vendors. Each vendor determines its own RSSI scale/values. values reported by IAPs. The event message includes the following:
- Co-ordinates of the client on the Floorplan
- GeoFence notification that contains information on when a device enters or leaves a GeoFence region (only when GeoFence is enabled)
- Security—The Security streaming event is generated when the IAPs have enabled Intrusion Detection. This feed contains all the IDS Intrusion Detection System. IDS monitors a network or systems for malicious activity or policy violations and reports its findings to the management system deployed in the network. detections reported by the IAPs in the network.
The following conditions are required for RAPIDS to send messages to Streaming APIs:
- Monitored APs must be classified as Rogue for RAPIDS to send messages to Streaming APIs.
- All IDS events are sent through Streaming APIs.
For more information on IDS and Rogue Access Point, see the RAPIDS topic.
