White Papers

Configuration details
7 Dell Storage Manager REST API Cookbook | 3089-WP-SAN
1 Getting started
The Python interpreter is used in this paper to interface with the DSM RESTful API to deliver commands and
retrieve data proxied through DSM to a Dell EMC SC Series array. This section outlines installing and
configuring Python as well as the required configuration for the DSM RESTful API interface.
The difference between the legacy Storage Center CompCU and the DSM RESTful API with Python, is that
the former interacts directly with the SC Series array while the latter proxies all requests through a DSM Data
Collector installation to an SC Series array.
1.1 REST overview
REST stands for Representational State Transfer. It relies on a stateless, client-server-based, cacheable
communications protocol; in most cases the HTTP protocol is used.
REST is an architecture style for designing scalable networked applications relying on a simple yet effective
HTTP transport protocol to make calls between machines, devices, or platforms.
REST relies on the HTTP CRUD (Create/Read/Update/Delete) operations to interact with the destination
machine or device. These operations are more commonly known as the GET, POST, PUT, and DELETE
HTTP methods.
Each DSM REST API call is referenced by a specific delimited string. The application of this string with one of
the HTTP methods mentioned previously will direct DSM to either return data, create an object, modify an
object, or remove an object accordingly.
The DSM REST API calls are shown in a table at the start of each section as well as referenced by the REST
variable name within each section of code.
Use the following procedure to download the complete list of REST API calls, help files, and enumerated field
values supported by the DSM Data Collector.
1. Go to http://www.dell.com/support/home/us/en/19/product-support/product/storage-sc2000/drivers/.
2. Refine the Drivers and downloads search criteria:
- Keyword: Enter REST API.
- Category: Set to Systems Management.
3. Browse the query results and download the applicable version of the Public REST API for Dell
Storage API.
1.2 Install and configure Python
This paper uses the Python v2.7.10 interpreter on a Fedora
®
23 server installation to create and manage the
HTTP session connection, submit REST API calls to the DSM installation, and retrieve data for processing or
validation. The following commands install Python, pip, and the required supporting modules. The installation
methods presented are applicable to Red Hat
®
Enterprise Linux
®
, CentOS
®
and other compatible Linux
distributions.