> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Cisco Prime Connector

## Intro

Cisco Prime is a network management software suite that simplifies the management of wireless and wired networks. To learn more about the Cisco Prime API, visit their page ([https://developer.cisco.com/site/prime-infrastructure/documents/api-reference/rest-api-v3-0/](https://developer.cisco.com/site/prime-infrastructure/documents/api-reference/rest-api-v3-0/)).

You connect to your Cisco Prime account in the Data Center. This topic discusses the fields and menus that are specific to the Cisco Prime connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Prerequisites

To connect to your Cisco Prime account and create a DataSet, you must have the following:

* The username and password for your Cisco Prime account
* The hostname or IP address of the Cisco Prime instance

## Connecting to Your Cisco Prime Account

This section enumerates the options in the **Credentials** and **Details** panes in the Cisco Prime Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your Cisco Prime account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:201;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Host </p></td><td colspan="1" rowspan="1"><p> Enter the hostname or IP address for the Cisco Prime instance. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Username </p></td><td colspan="1" rowspan="1"><p> Enter the username for your Cisco Prime account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Password </p></td><td colspan="1" rowspan="1"><p> Enter the password for your Cisco Prime account. </p></td></tr></tbody></table>

Once you have entered valid Cisco Prime credentials, you can use the same account any time you go to create a new Cisco Prime DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

### Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:201;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the Cisco Prime report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p> Access Points </p></td><td colspan="1" rowspan="1"><p> Returns data about wireless access points, both unified and autonomous. Provides device attributes such as type, version, association controller, number of associated clients, etc. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Access Point Details </p></td><td colspan="1" rowspan="1"><p> Returns details about wireless access points. Provides basic attributes, inventory, CDP, client and other information. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Alarms </p></td><td colspan="1" rowspan="1"><p> Returns a list of alarms—representations of a fault or change of state that occurred in the managed system. </p></td></tr><tr><td colspan="1" rowspan="1"><p> API Calls per Client </p></td><td colspan="1" rowspan="1"><p> Returns the IP addresses of all clients using either all services or the specified service over the last 24 hours. </p></td></tr><tr><td colspan="1" rowspan="1"><p> API Health Records </p></td><td colspan="1" rowspan="1"><p> Returns API performance and diagnostic information. </p></td></tr><tr><td colspan="1" rowspan="1"><p> API Response Time Summary </p></td><td colspan="1" rowspan="1"><p> Returns summarized information about response times for each service. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Client Counts </p></td><td colspan="1" rowspan="1"><p> Returns the number of clients counted during the last polling cycle. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Client Details </p></td><td colspan="1" rowspan="1"><p> Returns the detail view of a given client. It provides attributes of client device, security information, connected device, traffic and session information. All information is collected in the current or last session. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Client Historical Statistics </p></td><td colspan="1" rowspan="1"><p> Returns client statistics collected in the last 24 hours with a 15- minute (default) interval. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Clients </p></td><td colspan="1" rowspan="1"><p> Returns client data with information about the end points such as MAC address, IP address, username, and status. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Client Sessions </p></td><td colspan="1" rowspan="1"><p> Returns details about client sessions. It provides device- and session-related attributes including security, connected device, session time, traffic, etc. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Client Statistics </p></td><td colspan="1" rowspan="1"><p> Returns client statistics data collected during the last polling cycle. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Client Traffic </p></td><td colspan="1" rowspan="1"><p> Returns a client's traffic information collected during the last polling cycle. </p></td></tr><tr><td colspan="1" rowspan="1"><p> CLI Templates </p></td><td colspan="1" rowspan="1"><p> Returns CLI configuration templates. </p></td></tr><tr><td colspan="1" rowspan="1"><p> CLI Template Configuration Folders </p></td><td colspan="1" rowspan="1"><p> Returns a list of CLI template configuration folders. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Device Availabilty </p></td><td colspan="1" rowspan="1"><p> Returns device availability data for a given IP address. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Device Availability Summary </p></td><td colspan="1" rowspan="1"><p> Returns a device availability summary. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Device Health Information </p></td><td colspan="1" rowspan="1"><p> Returns health information for a given device. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Device Reachability Status </p></td><td colspan="1" rowspan="1"><p> Returns the reachability status for a given device. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Devices </p></td><td colspan="1" rowspan="1"><p> Returns device view data with information about the managed network elements. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Device Types </p></td><td colspan="1" rowspan="1"><p> Returns the list of device types you can specify for a CLI template. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Disk Information </p></td><td colspan="1" rowspan="1"><p> Returns capacity and usage information for the volumes present on the application's server. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Events </p></td><td colspan="1" rowspan="1"><p> Returns a "normalized" record of an occurrence reported by the network (or any system capable of notifying of such an occurrence). </p></td></tr><tr><td colspan="1" rowspan="1"><p> Generate Report from Template </p></td><td colspan="1" rowspan="1"><p> Lets you pull a Cisco Prime report from a saved template. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Group Sites </p></td><td colspan="1" rowspan="1"><p> Returns list of locations, including the count of alarms of each severity for each group. Also includes counts of devices, APIs and clients associated with the location, and location information regarding the location. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Historical Client Counts </p></td><td colspan="1" rowspan="1"><p> Returns client counts collected in the last 24 hours with a 5-minute (default) interval. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Historical Client Traffic </p></td><td colspan="1" rowspan="1"><p> Returns client traffic information collected in the last 24 hours with a 15-minute (default) interval. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Interface Utilization Summary </p></td><td colspan="1" rowspan="1"><p> Returns the interface utilization summary. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Number of Users </p></td><td colspan="1" rowspan="1"><p> Returns the number of users for an application. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Templates </p></td><td colspan="1" rowspan="1"><p> Returns saved report templates. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Request Count Thread </p></td><td colspan="1" rowspan="1"><p> Returns the number of requests, grouped by day and HTTP status, for all services or a given service if specified, over the last seven days. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Response Time Trend </p></td><td colspan="1" rowspan="1"><p> Returns the data for each request over the last 24 hours, showing the response time and the time the request was received, either for all services or for the specified service. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Service Name List </p></td><td colspan="1" rowspan="1"><p> Returns the list of services for which there are ApiHealthRecords. </p></td></tr><tr><td colspan="1" rowspan="1"><p> System Logs </p></td><td colspan="1" rowspan="1"><p> Returns syslog data. Syslogs are the standard method for logging messages such as system events in an IP network. </p></td></tr><tr><td colspan="1" rowspan="1"><p> System Health Statistics </p></td><td colspan="1" rowspan="1"><p> Returns system health statistics. </p></td></tr><tr><td colspan="1" rowspan="1"><p> System Information Statistics </p></td><td colspan="1" rowspan="1"><p> Returns system information statistics. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Traffic Analysis </p></td><td colspan="1" rowspan="1"><p> Returns the traffic analysis for a given application. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Uptime Information </p></td><td colspan="1" rowspan="1"><p> Returns uptime information as well as information about the application and the server it runs on. </p></td></tr><tr><td colspan="1" rowspan="1"><p> User Defined Groups </p></td><td colspan="1" rowspan="1"><p> Returns the list of user-defined groups for both Network Device Groups and Port Groups, including the count of alarms of each severity for each group. </p></td></tr><tr><td colspan="1" rowspan="1"><p> WLC Utilizations </p></td><td colspan="1" rowspan="1"><p> Returns the latest CPU and memory utilization collected from a WLAN controller. </p></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> IP Address </p></td><td colspan="1" rowspan="1"><p> Enter the IP address of the device you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Template </p></td><td colspan="1" rowspan="1"><p> Select the saved report template you want to generate a DataSet from. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Type </p></td><td colspan="1" rowspan="1"><p> Select the type of statistics you want to retrieve, either simple or detailed. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Date Type </p></td><td colspan="1" rowspan="1"><p> Select whether you want to retrieve data for a single date or a date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Date </p></td><td colspan="1" rowspan="1"><p> Select the date you want to pull information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Date Offset </p></td><td colspan="1" rowspan="1"><p> Enter the number of days back you want to pull data for each time this report is run. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Date From </p></td><td colspan="1" rowspan="1"><p> Select the first date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Date From Offset </p></td><td colspan="1" rowspan="1"><p> Enter the number of days back from the first date in your date range you want to pull data for each time this report is run. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Date To </p></td><td colspan="1" rowspan="1"><p> Select the last date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Date To Offset </p></td><td colspan="1" rowspan="1"><p> Enter the number of days back from the last date in your date range you want to pull data for each time this report is run. </p></td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector")
