The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Prime Performance Manager north bound API (NBAPI) allows you to perform some device, threshold, polling group, and user management functions including adding, updating, and deleting devices and thresholds, and adding, deleting and editing users. NBAPI information is provided at the following locations:
Note If Prime Performance Manager is integrated into the Cisco Prime Carrier Management suite, the interface is https://ppm_gateway:4440/nbapi/event.
Note If user access is enabled, SOAP requests must include a Prime Performance Manager user name and password through the HTTP Basic Authorization Header. The user must have sufficient permissions to perform the requested SOAP action.
Examples of NBAPI methods are provided in the following topics:
Device management methods include:
Examples of the NBAPI addDevice method are provided below:
An addDevice example for a device with SNMP v3 and Telnet credentials:
An addDevice example for a non-SNMP enabled device: QEMU/KVM Hypervisor
Examples of the NBAPI updateDevice method are provided below:
An updateDevice example with SSH_V2 credentials and public and private keys:
An example of the NBAPI deleteDevice method is provided below:
Descriptions of the add, update, and delete device attributes are provided below. Many of the following attributes are visible in Prime Performance Manager GUI, when you select the device and display the Details tab.
Note Prerequisite is to set the MULTI_COLLECTOR_ENABLED property to true in Server.properties file on both gateway and all the connected units. A restart of the gateway is required for the property change to take effect.
Available groups can be seen in the Prime Performance Manager GUI in Report/Group Policies and Polling Group Editor sections.
Note reportPolicy should exist in Prime Performance Manager.
Note pollingGroup should exist in Prime Performance Manager.
The following tags describe the SNMP attributes to be used when polling the device through SNMP. The SNMP Editor in the Prime Performance Manager GUI displays these values.
– snmpUserName only (NoAuthNoPriv)
– snmpUserName and snmpAuthProtocol (AuthNoPriv)
– snmpUserName, snmpAuthProtocol, snmpPrivProtocol (AuthPriv)
The following tags describe the credentials Prime Performance Manager will use while accessing the device through different collectors. You can view the added credentials through the Network > Credentials Editor window.
– WSMA_SSH—Web Services Management Agent over SSHv2. WSMA is an infrastructure framework that allows external applications to monitor and control Cisco devices. WSMA uses transports such as SSH, HTTP, and HTTPS to access a set of Web Services agents residing on the Cisco device.
– collectd_SSH—A daemon that collects, transfers, and stores performance data.
– HTTP—HyperText Transfer Protocol.
– HTTP_BULK—Bulk statistics through HTTP.
– WMI_HTTP—Windows Management Instrumentation over HTTP.
– WMI_HTTPS—Windows Management Instrumentation HTTPS.
– SMI_HTTPS—Storage Management Initiative over HTTPS.
– ULS_HTTP—Allows Prime Performance Manager to perform Small Cell upload server HTTP credential verification including subsystem, username, password, and credential parameters. Beyond that, ULS_HTTP is identical to HTTP protocol.
– vCenter_HTTPS—VMware vCenter server over HTTPS.
– ESXi_HTTP—VMware ESXi embedded bare metal hypervisor over HTTP.
– ESXi_HTTPS—VMware ESXi embedded bare metal hypervisor over HTTPS
– XEN_TLS—Xen hypervisor over Transport Layer Security (TLS) protocol.
– KVM_TLS—Linux Kernal-based Virtual Machine (KVM) over TLS.
– HyperV_HTTP—Microsoft HyperV server over HTTP.
– HyperV_HTTPS—Microsoft HyperV server over HTTPS.
– JMX—Java Management Extensions. Collects statistics from Java processes running on various servers.
– PNSC_HTTPS—Cisco Prime Network Services Controller secure HTTP connection.
– GMOND_SOCKET—Ganglia Monitoring Daemon (gmond) socket.
Note For more information about different transport protocol refer Prime Performance Manager 1.7 User Guide “Adding Device Credentials for Other Protocols” section.
Note NOTE: A blank string is the default subsystem for SSH. The default subsystem for WSMA is “wsma”.
Note NOTE: For SSHv2 or HTTPS transport protocol use PublicKey option and pass the authentication keys in the loginClientAuthPublicKey and loginClientAuthPrivateKey tags. By default, Prime Performance Manager authenticates itself to the device using the User Name and Password entries.
Note To add multiple login credentials for the same device use the updateDevice API.
This tag is available only for addDevice API.
Note NOTE: true or false values are case-insensitive. So you can also send as True or FALSE.
Note NOTE: Option values are case sensitive.
An example of the NBAPI getDeviceInfo method is provided below:
NBAPI threshold method examples are provided below. If you do not specify a field, the code takes the default value. However, if you explicitly leave the field empty, the code clears the default value unless the field is required.
The sample responses are for traditional number thresholds, so they don't show the <xxxOperator> and <xxxTestValue> elements in the KPI section because those are null. However, they would be present for a string threshold. The valid values for xxxOperator are the same as for report filtering: Equals, Does Not Equal, Contains, Does Not Contain, Begins With, Ends With. The valid xxxTestValuevalues for are anything that can go in xml, and there can be any number of them. The Operators starting with "Does Not" pass if the positive version does not match any of the test values. The other tests match if any test value matches. You cannot create or edit string thresholds with addThreshold or editThreshold. You must use the addThresholdInfoList or editThresholdInfoList methods. Also, abate tests are optional and not recommended for string thresholds. If they are omitted, the abateOccurs can still be specified. The threshold will abate when the onset test fails that number of times.
A <mailFrom> element is included in all request and response WSDL that has a <mailTo> element. The <mailFrom> element occurs first. On the CLI side, the mailFrom can be specified in addThreshold and getFilteredThresholdInfo through an -f option. The addThresholdInfoList and editThresholdInfoList methods that take an xml file with the -u option like the Probe equivalents.
For REST reports, you can display threshold API parameters by choosing Help > Reports > Threshold API Parameters in the Prime Performance Manager GUI. The page includes the threshold reportKey and kpiReport parameters. Metadata is added for each column including dataType, columnName, and kpiName. (columnName and kpiName are empty for all non-thresholdable columns.)
You can also run the following command to generate a list of reports available from the REST interface:
Each report will include the following parameters:
If file or folder name ends in.xml, and is not an existing directory, the XML is generated in that file. If file or folder name does not end in.xml or is an existing directory, the XML is generated in a ThresholdParameters.xml file in that directory.
Threshold management methods are provided in the following topics:
An example of the NBAPI addThreshold method is shown below:
An example of the NBAPI addThresholdInfoList method is shown below:
An example of the NBAPI editThreshold method is provided below.
An example of the NBAPI editThreshold InfoList method is shown below:
An example of the NBAPI enableThreshold method is provided below:
An example of the NBAPI disableThreshold method is provided below:
An example of the NBAPI rearmThreshold method is provided below:
An example of the NBAPI deleteThreshold method is provided below:
An example of the NBAPI getThresholdInfo method is provided below:
An example of the NBAPI getAllThresholdInfo method is provided below:
An example of the NBAPI getFilteredThresholdInfo method is provided below:
NBAPI methods that you can use to manage groups are provided in the following top8ics:
Example of the NBAPI addGroup method is provided below:
Example of the NBAPI updateGroup method is provided below:
Example of the NBAPI deleteGroup method is provided below:
Example of the NBAPI getGroupInfo method is provided below:
NBAPI methods that you can use to manage probes are listed in the following topics:
Example of the NBAPI addProbe method is provided below:
Example of the NBAPI updateProbe method is provided below:
Example of the NBAPI deleteProbe method is provided below:
An example of the NBAPI getProbeInfo method is provided below:
NBAPI methods that you can use to manage polling groups are listed in the following topics:
An example of the NBAPI addPollingGroup method is provided below:
An example of the NBAPI updatePollingGroup method is provided below:
An example of the NBAPI deletePollingGroup method is provided below:
An example of the NBAPI getPollingGroup method is provided below:
An example of the replacePalDeviceCapabilities is provided below. It replaces the whole Protocol Abstraction Layer (PAL) file and also returns the original contents, so you can restore them later if needed.
An example of the NBAPI getPalDeviceCapabilities method used to retrieve a device PAL information. The method has no parameters and always returns the whole file.
Report management methods are provided in the following topics:
An example of the NBAPI setReportStatus method is provided below:
An example of the NBAPI assignReportPolicies method is provided below:
An example of the NBAPI deleteReportPolicies method is provided below:
An example of the NBAPI getReportPolicies method is provided below:
The updateReportPolicies file should contain an xml ReportPolicyList produced by the getReportPolicies call. The ordering of categories, reports, flags, and numbers is not significant. The tools always generates output in the same order but handles any input order as long as the types are in the correct order.
For each update flag set, you can specify that all intervals are enabled or disabled, or you can specify individual interval settings. You cannot do both. Trying to do both will cause a validation failure.
The updateReportPolicies operation does not change unspecified settings, so you do not need to specify any settings that you do not want to change.
An example of the NBAPI updateReportPolicies method is provided below:
Prime Performance Manager north bound API (NBAPI) allows you to perform some user management functions including adding, updating, and deleting users and managing user parameters. The functionality is exactly the same as user management using the Prime Performance Manager GUI. For example, the allowed values for RoleName are the role display strings in the GUI. The main difference is that all NBAPI methods work in batch mode, so you can submit changes for multiple users in one request. Aside from getUsers, the methods all return an empty message unless an error occurs. getUsers returns a UserList, same as the one submitted for editUsers. Errors are returned if user access is not enabled, or if the requester does not have appropriate permission, which is same as required to use the GUI for user management.
URL: https:// ppm_gateway :4440/nbapi/admin
Note If Prime Performance Manager is integrated into the Cisco Prime Carrier Management suite, the interface is https://ppm_gateway:4440/nbapi/event.
Note User access must be enabled. SOAP requests must include a Prime Performance Manager user name and password through the HTTP Basic Authorization Header. The user must have sufficient permissions to perform the requested SOAP action.
/opt/CSCOppm-gw/tomcat/webapps/nbapi/WEB-INF/wsdl/AdminAPI.wsdl
NBAPI user management method examples are provided in the following topics:
An example of the NBAPI addUsers method is provided below:
An example of the NBAPI deleteUsers method is provided below:
An example of the NBAPI editUsers method is provided below:
An example of the NBAPI getUsers method is provided below:
An example of the NBAPI updateUserFlags method is provided below:
An example of the NBAPI updateUserPasswords method is provided below:
Use the following methods to add, delete, edit, and get views using the Prime Performance Manager north bound API (NBAPI).
An example of the NBAPI addView method is provided below:
An example of the NBAPI deleteView method is provided below:
An example of the NBAPI editView method is provided below:
An example of the NBAPI getView method is provided below: