HP 3PAR Web Service API 1.3.1 Developer's Guide

1 Introduction
This HP 3PAR Web Services API 1.3 Developer's Guide describes how to write a client that uses
the HP 3PAR Web Services API (WSAPI) to manage HP 3PAR storage systems. HP 3PAR storage
systems include both hardware components that store data, and software applications to manage
data.
About the WSAPI
The API consists of a server and a definition of the operations, inputs, and outputs of the API. The
application program interface (API) provides a more flexible and powerful way to perform storage
management tasks than the HP 3PAR Command Line Interface (CLI) scripting or the HP 3PAR OS
Management Console software. This API enables you to automate management of hosts, ports,
volumes, common provisioning groups (CPGs), virtual LUNs (VLUNs), storage space, and system
information.
The Software Development Kit (SDK) of the API includes sample clients that can be referenced for
the development of customer-defined clients. Clients of the API interact with the server through
HTTPS.
For an overview of the supported HTTP methods, see “Supported HTTP Methods” (page 15).
Unless otherwise stated, features, commands, and operations described in this guide are available
in all versions of the WSAPI. Those that are new with WSAPI 1.2 or WSAPI 1.3 are called out.
For typographic conventions used in this guide, see “Typographic conventions” (page 151).
Getting Started
This section of the HP 3PAR Web Services API Developer's Guide shows how to configure the
server. Included also is an introduction to the WSAPI commands and a summary of the items
included in the HP 3PAR Web Services API Server SDK.
Starting and Configuring the Server
The WSAPI server is part of the HP 3PAR OS 3.1.2 and later, and runs on HP 3PAR StoreServ
Storage systems.
HP 3PAR CLI commands used to manage the WSAPI server are shown in Table 1 (page 11).
Table 1 HP 3PAR CLI Commands for the WSAPI Server
AuthorityDescriptionCommand
Super, ServiceSets properties of the WSAPI server.setwsapi
Any role granted the wsapi_set right
Any role in the system.Displays the WSAPI server service
configuration state.
showwsapi
Super, ServiceStarts the WSAPI server.startwsapi
Any role granted the wsapi_set right
Super, ServiceStops the WSAPI server.stopwsapi
Any role granted the wsapi_set right
Any role in the system.Shows the WSAPI server sessions
information.
showwsapisession
(Since WSAPI 1.3)
SuperRemoves WSAPI user connections.removewsapisession
About the WSAPI 11