NetApp® SANtricity® Rest API and Client Libraries 1.1 Developers Guide October 2017 | 215-12519_A0 [email protected] Table of Contents About this Guide ................................................................................................................................................ 1 Overview of the Rest API .............................................................................................................................. 1 Overview of the Client Libraries .................................................................................................................... 1 General API Concepts ....................................................................................................................................... 2 API Version ................................................................................................................................................... 2 Logging in to the API .............................................................................................................................. 2 Embedded versus Proxy ............................................................................................................................... 2 Embedded Web Services ....................................................................................................................... 2 Proxy Mode ............................................................................................................................................. 3 HTTP Verbs................................................................................................................................................... 3 HTTP Status Codes ...................................................................................................................................... 3 General Storage Concepts ............................................................................................................................... 4 Storage Systems ........................................................................................................................................... 4 Disk, Pools, and Volumes ............................................................................................................................. 4 Host and Mappings ....................................................................................................................................... 4 SSL Configuration ............................................................................................................................................. 5 Getting started ............................................................................................................................................... 5 Generating an SSL certificate ....................................................................................................................... 5 Signing the generated SSL certificate ........................................................................................................... 6 Importing the certificate into the keystore ..................................................................................................... 6 Generating an SSL Certificate on an Application client ................................................................................ 7 Managing Storage Systems .............................................................................................................................. 8 Auto-discovering a storage array .................................................................................................................. 8 Manually Adding a Storage Array ................................................................................................................. 9 Removing a Storage Array .......................................................................................................................... 10 Provisioning Storage....................................................................................................................................... 12 Creating Storage Pools ............................................................................................................................... 12 Creating Volumes ........................................................................................................................................ 13 Setting up the Host ...................................................................................................................................... 15 Retrieving the Host Type ...................................................................................................................... 15 Retrieving the Host Port ....................................................................................................................... 15 Creating the Host .................................................................................................................................. 15 Mapping a Volume to a Host ....................................................................................................................... 17 Monitor Storage ............................................................................................................................................... 19 Monitoring Global Events ............................................................................................................................ 19 Monitoring the Status of Events for the Storage Device ............................................................................. 19 Monitoring MEL Events ............................................................................................................................... 20 Firmware Management .................................................................................................................................... 22 Obtaining a list of available Firmware Files ................................................................................................ 22 Verifying Firmware File Compatibility .......................................................................................................... 22 Upgrading Controller Firmware ................................................................................................................... 24 Using Python SDK ........................................................................................................................................... 25 Downloading the SANtricity WebAPI – Python SDK Client Library ............................................................ 25 GitHub Repository ................................................................................................................................ 25 PyPI ...................................................................................................................................................... 25 Requirements .............................................................................................................................................. 25 Installation ................................................................................................................................................... 25 setuptools Installation ........................................................................................................................... 25 Manual Installation ................................................................................................................................ 25 Getting Started ............................................................................................................................................ 25 Using HTTPS with the Python SDK ............................................................................................................ 26 Using HTTPS with the default self-signed certificates.......................................................................... 26 Using HTTPS with a signed certificate ................................................................................................. 28 NetApp SANtricity® Rest API and Client Libraries 1.1 Developers Guide i Using Java SDK ............................................................................................................................................... 29 Downloading the SANtricity WebAPI – Java SDK Client Library ................................................................ 29 GitHub Repository ................................................................................................................................ 29 Maven Central ...................................................................................................................................... 29 Requirements .............................................................................................................................................. 29 Installation ................................................................................................................................................... 29 Dependencies ....................................................................................................................................... 29 Getting Started ............................................................................................................................................ 30 Configuring Java to trust REST API Self Signed Certificates ....................................................................