Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

Using Aggregation

Aggregation allows a REST resource to be aggregated on a Prime Operations Center server from multiple managed Prime Infrastructure instances. Check the documentation for each request type to see if it supports Aggregation.

Aggregation Syntax

Operations Center aggregates data from all reachable managed Prime Infrastructure instances by default. Operations Center does not aggregate data from deactivated and unreachable instances. You can also aggregate data from specific Prime Infrastructure instances by using the following query parameter:

.instance

The following example retrieves data from a single managed instance:

../webacs/api/v3/data/Devices?.instance=192.168.1.1

The following example retrieves data from managed instances that contain "100" in their IP address:

../webacs/api/v3/data/Devices?.instance=contains("100")

The following example retrieves data from managed instances that contain "ncs" in their host name:

../webacs/api/v3/data/Devices?.instance=contains("ncs")

The following example retrieves data from managed instances that contain "New York" in their alias:

../webacs/api/v3/data/Devices?.instance=contains("New York")

It is possible to use IP address or host name or instance alias to enable filtering by managed instances. This query parameter has string type. Please see documentation for detailed information on filtering.

Supported API resources in 3.3

Resource Description API Version
GET Alarms

GET data/Alarms

Alarm is a representation of the fault or change of state that occurred in the managed system; it could be resource or service and customer related. Alarms are associated with a group of events received from the managed resources, usually with the same source and category, indicating that such fault or event had occurred.
GET Client Details

GET data/ClientDetails

Represents the detail view of a client. It provides attributes of client device, security information, connected device, traffic and session information. All information is collected in current or last session.
GET Client Summary

GET data/Clients

Represents client view with information about the end points. It provides end point information such as MAC address, IP address, username, and status.
GET Devices

GET data/Devices

Represents the device view with information about the managed network elements. It provides device information such as device name, device type, ip address, software type, version, and also provides the reachability and management status.
GET Events

GET data/Events

Represents a "normalized" record of an occurrence reported by the network (or any system capable of notifying of such an occurrence); it could be a syslog, SNMP trap, or any other such type. The term "normalized" denotes a single format abstracted over all types of reported events, regardless of source and structure.
GET Syslogs

GET data/Syslogs

Represents the syslog view. Syslogs are standard method for logging messages such as system events in an IP network. This API only supports Syslogs with severities 0, 1, 2 (Emergency, Alert, Critical)
GET Wireless Access Point Details

GET data/AccessPointDetails

Represents detail information of a wireless access points. It includes basic attributes, inventory, CDP, client and other information.
GET Wireless Lan Controller Details

GET data/WlanControllerDetails

Represents detail information about a WLAN controller.