HP 3PAR Web Service API 1.3.1 Developer's Guide

2 Accessing the WSAPI
The HP 3PAR Web Services API (WSAPI) makes it possible to manage CPGs, hosts and host sets,
volumes and volume sets, VLUNs, ports, tasks, quality of service (QoS) rules, and to query system
information and available 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.
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
• Getting WSAPI configuration information
• Creating, modifying, deleting, and querying HP 3PAR Priority Optimization quality of service
(QoS) rules
• Creating, tuning, and removing volumes
• Querying all volumes or a single volume
• Modifying a single volume
• Creating, stopping, or querying physical copies of volumes or virtual volume (VV) sets
• Promoting, and stopping the promotion of, a virtual copy of a volume
• Creating, modifying, and removing VV sets
• Promoting, and stopping the promotion of, VV set virtual copies
• Adding and removing members from VV sets
• Querying all VV sets and a single VV set
• Creating snapshots of volumes and VV sets
• 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
• Creating, modifying, and removing host sets
• Querying all host sets and single host sets
• Adding and removing members from host sets
• Querying port devices and FC switches
• Querying and canceling tasks
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.
14 Accessing the WSAPI