Enable a NetApp SANtricity Web Services Proxy

NetApp SANtricity Web Services Proxy is a RESTful API server installed separately on a host Windows or Linux system to manage NetApp E-Series storage systems. This host-based application can manage many NetApp E-Series arrays. 

The NetApp SANtricity Web Services Proxy can manage all E-Series storage systems, including a mixture of older systems and the latest E2800, EF280, E5700, EF570, EF300 and EF600 series systems. 

Before adding the storage arrays to SRM, SANtricity Web Services Proxy software must be installed and configured, storage arrays must be enrolled into SANtricity Web Services Proxy, and the relevant user must be enabled or created.

Ensure you have the following information:

• IP address or hostname of the NetApp SANtricity Web Services Proxy
• Provider username
• Provider password
• Protocol (Default is HTTPS.)
• HTTP port (Default is 8080.)
• HTTPS port (Default is 8443.)

Review the documentation

For information about enabling the NetApp SANtricity Web Services Proxy software, see the documentation provided with your array, contact your vendor, or visit the NetApp SANtricity Web Services Proxy documentation resources. The software is available to install on Linux, Windows, or as a docker image.
 

Understand user privileges

The minimum privileges required for a monitoring user should be set as the “storage.monitor” role. The built-in “monitor” user can be used for monitoring, but this user account is disabled until the password is set for that account. The storage monitoring role has read-only access to view storage system data.

Note: When you set up the NetApp SANtricity Web Services Proxy, you must use the Array admin credential, which is defined by NetApp in their documentation. The SANtricity Web Services Proxy user role must be read-only.
 

Install the NetApp SANtricity Web Services Proxy

1. Review NetApp’s installation and upgrade requirements.
2. Download a package from:
   • The NetApp Support Site – All Products – E-Series SANtricity Unified Manager and Web Services Proxy (Downloads)

• • NetApp/E-Series Web Services Docker Image | Docker Hub to a server (Linux or Windows) where the SANtricity Web Services Proxy will reside.

3. Run the installation in one of four ways:
   • Graphical
   • Console
   • Silent
   • RPM file (on Linux only)

Note: During the installation of SANtricity Web Services Proxy on a Linux host, a pop-up dialog with daemon name displays. Keep this name, as you will need it if you have to stop and re-start service.

Graphical installation instructions:

1. Open the folder where the installation package was downloaded.
2. Run the installation:
   1. Double-click santricity_webservices-windows_x64-nn.nn.nn.nnnn.exe on Windows, where nn.nn.nn.nnnn is the version number.

2. 2. Run the command santricity_webservices-windows_x64-nn.nn.nn.nnnn.bin on Linux, where nn.nn.nn.nnnn is the version number.
3. Enable features and enter configuration parameters when prompted. These can be changed later in the configuration files.
4. Follow the rest of the instructions as displayed on screen.

Console mode installation instructions:

1. Run the following command:

2. Enable features and enter configuration parameters prompted. These can be changed later in the configuration files.
3. Press Enter to exit the installer when the installation is complete.

Silent mode installation instructions:

Note: Silent mode means no return messages or scripts display in the terminal window.

Run the following command:

<install filename> -i silent

For example:

santricity_webservices-windows_x64-nn.nn.nn.nnnn.exe -i silent

A command prompt displays in the terminal window after installation finishes successfully.

RPM command installation instructions (on Linux only):

1. Download the RPM file to a server where the proxy will reside.
2. Open a terminal window.
3. Paste in the following command:

Discover storage systems

To manage storage systems in the network, you must first discover them and add them to the management list. After the SANtricity Web Services Proxy is installed, you can open Unified Manager (a browser-based interface).

1. Open a browser and paste in the following URL:

2. For the first-time login, enter "admin" as the username.
3. Set and confirm the password for this user.
4. From the Manage page, select Add/Discover.
5. Select Discover all storage arrays within a network range.
6. Enter the starting network address and ending network address to search across your local sub-network. Then click Start Discovery.
7. Review the list of discovered storage arrays and select the storage arrays you want to add to your management domain. Then click Next.
8. Unified Manager performs a credential check on each array you add to your management domain. You might need to resolve any self-signed certificates and untrusted certificates associated with that array.
9. Click Next and procees to the next steps in the wizard.

Test API

After you have installed SANtricity Web Services Proxy and added a storage array to the system, you can test whether the API is working correctly by launching a browser and accessing interactive API documentation.

1. Open a web browswer and paste in the following URL:

2. Click the Storage-System category.
3. Click the GET:/storage-systems endpoint.
4. Click Try it out.
5. For the first-time login, enter the username and password for the user intended for SolarWinds monitoring.
6. Click Execute.
   A JSON response with multiple properties displays.
7. Search for the name property to validate that all the arrays are present in the response.

Restart the Web Server

After it is installed, the Web Server service runs in the background. You can stop or restart it as needed.

On a Windows host:

1. Click the Start menu and type Windows Administrative Tools.
2. Double-click Services.
3. Find NetApp SANtricity Web Services.
4. Right-click Stop or Start.

On a Linux host:

1. Open the command line console.
2. Enter the following command:
   
   systemct1 <operation> <service name>