Working with NetApp API Services – What You Need to Know

by bluemedora_editor on September 2, 2015

By Jake Martin

With the release of OnCommand Unified Manager 6 (OCUM), NetApp has changed the process in which performance metrics and data are collected from NetApp storage hardware. Previously with OCUM 5.x (also called DFM) we were able to connect directly to the OCUM server and collect data. With OCUM 6, we now need to connect to NetApp API Services.

NetApp API Services is a kind of middleman that collects all data from OnCommand Unified Manager and OnCommand Performance Manager (OCPM) and allows a single point of entry for data collection. Once the API Services box is set up and connected to both OCUM and OCPM, we will be able to successfully pull performance metrics into Blue Medora’s VMware vRealize Operations Management Pack for NetApp Storage.[cq_vc_fluidbox thumbwidth=”677″ float=”none” margin=”0 0 5px 0″ retina=”” fluidimage=”4023″]Figure 1 – Relationships between the servers involved in data collection[/cq_vc_fluidbox]Figure 1 displays the relationships between the servers involved in the collection of data through API Services. In this graph, Blue Medora’s Management Pack for NetApp Storage would be the Partner Application. Note that each server has its own set of requirements and should be hosted on separate VMs.

Successful installation and configuration of OnCommand API Services requires you to observe specific requirements on the platform and storage network environment on which the API server platform is installed.

API server requirements

The target API server system (the system on which you want to install OnCommand API Services) has the following minimum hardware requirements for the target machine:

  • x86_64 architecture 

  • 4 GB RAM 

  • 500 MB free disk space 

  • 2 cores 

  • 4786 MHz total CPU speed provided by each of the 2 cores 

  • Root user privilege (for installation only) 

  • Red Hat Enterprise Linux 6.5 installed 

  • Java Runtime Environment version 1.8 installed 

  • Internet browser access or FTP access to the NetApp Support Site

This blog post will focus primarily on the major configuration requirements of API Services, OCUM, and OCPM as they relate to collecting metrics for the Management Pack for NetApp Storage. Visit NetApp support pages for full documentation on installation of API Services, OnCommand Unified Manager, and OnCommand Performance Manager.

Configuring Servers (OCUM, OCPM, API Services)

Once the OCUM, OCPM, and API Services servers are up and running, the next step is configuring various servers for connection. There are a few key points worth noting for this process.

  1. Any Performance Manager servers you want to add to API Services must already be paired with OCUM and running version 1.1 or higher.
  2. Any Unified Manager Server you want to connect to API Services must be running version 6.2 or higher.

To connect the first Unified Manager to the API Services server, we will need to create a database user. You will also need to complete this process for any Performance Manager servers you want to incorporate into your API Services.

Creating a Database User

  1. Log in to the Web UI for the Unified Manager server that you want to include and click AdministrationManage UsersAdd to display the Add User dialog box.
  2. Configure a new user by specifying values for the following properties:
Property Input
Type Select Database User
Name Enter a unique name
Password Enter a unique password
Re-enter Password Enter the same password again
Role Select Integration Schema
  1. Click Add. The new user is listed in the Unified Manager Manager Users page.
  2. Note the user name and password.
  3. Log out of the Unified Manager web UI.

Including a Performance Manager Server

If you want to include a Performance Manager server that is already paired with the Unified Manager server that was just configured, complete the following additional steps:

  1. Log in to the Web UI for the specific Performance Manager server and click Administration > Manage Users > Add to display the Add User dialog box.
  2. Configure a new user by specifying values for the following properties:
Property Input
Type Select Database User
Name Enter the same user name specified for Unified Manager
Password Enter the same password specified for Unified Manager
Re-enter Password Enter the same password again.
Role Select Integration Schema
  1. Click Add. 
The new user is listed in the Performance Manager Manage Users page.
  2. Note the user name and password.
  3. Click Add.
  4. Log out of the Performance Manager web UI.

Adding a Local Admin to the API Server

Once you have the Database users configured, you will also need to add a local admin user to the API server. To add a local admin user to the API server:

  1. In the home page of the OnCommand API Services web UI, click Administration > Manage Users. 
The Manage Users tab appears.
  2. Select Add to enable the dialog fields.
  3. In the Add New User dialog box, enter information for the following fields:
Name The login name of the user who must access OnCommand API Services
Email The email address of the user being added
Role The role the user plays when accessing the OnCommand API Services. Supported roles include the following:Administrator: empowered to access the API server console or to submit Admin API requests directly to the API serverMonitor: empowered to submit Monitor API requests to the API server, usually on behalf of a partner applicationGuest: empowered to view the API help, but with no other privileges
Password The password for the user being added
Confirm Password Confirmation of the password entered above
  1. After your user configuration is complete, click Add.

Adding the OCUM Server to the API Server[cq_vc_fluidbox thumbwidth=”551″ float=”none” margin=”0 0 5px 0″ retina=”” fluidimage=”4009″]Figure 2 – Adding a new management service to the API server[/cq_vc_fluidbox]Now that all of the servers and users are configured, you can add the OCUM server to the API server. To complete this process, follow the steps below:

  1. Specifying one of the URLs that were displayed at the end of the API installation, use a supported browser to go to the login page for the newly installed OnCommand API Services Web UI. 

  2. Use the password that was specified during installation to log in as the admin user to the newly installed OnCommand API Services web UI. 

  3. Click Add Management Services. 
The Add New User dialog box dialog box appears. 

  4. In the Add New User dialog box, enter information for the following fields: 

Name A user-specified name for the Unified Manager service that you want to add
Type The type of service that you want to addCurrently a single type, Unified Manager, is available for selection
Hostname The host name or IP address of the system on which the target Unified Manager server is installed
Username (Access to UM DB) The name of a database user, configured and assigned the “Integration Schema” role on the target Unified Manager server, authorized to read the Unified Manager database on behalf of the API server
Password (Access to UM DB) The password used by the database user to access the Unified Manager database
Port (UM DB) The port on the target Unified Manager server through which the API server conducts OnCommand API Services queries to the Unified Manager databaseThe default port is 3306
Username (Access to UM) In all cases “umadmin,” the name of the primary Unified Manager user authorized to execute ZAPI operations on behalf of the API server
Password (Access to UM) The password that was assigned to the primary Unified Manager user, umadmin, during Unified Manager installation
Port (Access to UM) The port on the target Unified Manager server through which the API server accesses the ZAPI libraryThe default port is 443.
  1. To test the validity of the connection configuration, click Test Connectivity.
 The system either confirms a valid connection or informs you of errors in your configuration. 

  2. After your test connectivity check is successful, click Add. 


The newly added Unified Manager service is now listed on the Management Services tab. Any Performance Manager servers that are connected with the newly added Unified Manager server are also listed.

Test Call

Now that we have the API services box fully configured and connected to both OCUM and OCPM, we can perform a test call to check the functionality of the system. To do this, navigate to the API services admin page at https://(ipaddress):(port). You will need to log in with the admin account set up earlier.

Once logged in, possible calls can be expanded by selecting Show/Hide at the top right of the window. All of the possible calls will now be listed.[cq_vc_fluidbox thumbwidth=”700″ float=”none” margin=”0 0 5px 0″ retina=”” fluidimage=”4010″]Figure 3 – Some of the calls possible from the NetApp API Services admin page[/cq_vc_fluidbox]Select the GET option next to the call you want to perform. Doing this will expand various information about the function.[cq_vc_fluidbox thumbwidth=”700″ float=”none” margin=”0 0 5px 0″ retina=”” fluidimage=”4024″]Figure 4 – Information about the asup-configuration function from the API Services admin page[/cq_vc_fluidbox]Test calls can be performed by clicking Try It Out at the bottom left of the page. API Services will perform the call and display the information as seen in Figure 5 below. Test calls can also be performed by copying the Request URL and pasting it into a web browser. In Figure 4 above, the request URL can be seen at the bottom of the image. Pasting the request URL will display the information gathered as displayed below in Figure 5. [cq_vc_fluidbox thumbwidth=”655″ float=”none” margin=”0 0 5px 0″ retina=”” fluidimage=”4025″]Figure 5 – A returned call from the API Services server[/cq_vc_fluidbox]To learn more about Blue Medora’s Management Pack for NetApp Storage, visit our product page. For more information on Blue Medora solutions, updates on our newest management packs, and more helpful technical information, check out the Blue Medora blog.[ultimatesocial_false count=”” align=”left” skin=”default” share_text=”Share:” networks=”twitter, linkedin, facebook”]

Get started

Try BindPlane for free. No credit card required.

Sign up
True Visibility
BindPlane for VMware vRealize Operations

True Visibility allows cloud management teams to use VMware vRealize’s powerful machine learning and capacity planning engine across their entire hybrid cloud environment.

Azure Monitor...everything
BindPlane for Microsoft Azure Monitor

Make Azure Monitor your first-pane-of-glass across your entire multi-cloud, multi-database or hybrid platform environment.

Thank you for contacting us. Your information was received. We'll be in touch shortly.