Accessing The Wsapi; Overview - HP 3PAR StoreServ 7200 2-node Manual

2 Accessing the WSAPI

Overview

The HP 3PAR Web Services API (WSAPI) makes it possible to manage CPGs, hosts, ports, volumes,
and VLUNs, and to query system information and available versus used storage space, through a
series of HTTP or HTTPS requests.
NOTE: For security reasons, HTTPS is the preferred choice and is used by default. Throughout
this document, HTTP is used to refer to both. The behavior is the same using both protocols.
Clients make HTTP requests to the server and receive HTTP replies. When input is provided, such
as with the HTTP POST method, or when output is returned, the body of the messages are coded
using JSON. The message body will be ignored for GET and DELETE operations.
The WSAPI enables programmatic management of HP 3PAR storage servers. The clients access
Web services at specified HTTPS locations that control the following tasks:
Gaining system access through session keys
Getting version information
Creating and deleting volumes
Querying all volumes or a single volume
Modifying a single volume
Creating snapshot volumes
Creating, modifying , and removing common provisioning groups (CPGs)
Querying all CPGs or a single CPG
Creating and removing VLUNs
Querying all VLUNs or a single VLUN
Querying all ports or a single port
Querying available space for the overall system, a CPG, or an LDLayout object
Creating, modifying, and deleting hosts
Querying all hosts or a single host
Tasks can be automated by developing a WSAPI client. Because the API is more formally defined,
using it is preferable to scripts that use the HP 3PAR CLI, since those scripts will need to process
CLI-generated text.
Overview 1 1