HP 3PAR StoreServ 7450 2-node HP 3PAR Web Service API 1.2 Developer's - Page 9

Introduction, About the WSAPI, Getting Started, Starting and Configuring the Server

Get HP 3PAR StoreServ 7450 2-node PDF manuals and user guides View all HP 3PAR StoreServ 7450 2-node manuals
Add to My Manuals
Save this manual to your list of manuals

Page 9 highlights

1 Introduction This HP 3PAR Web Services API 1.2 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 14). 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 are called out. For typographic conventions used in this guide, see "Typographic conventions" (page 89). 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 API server is part of the HP 3PAR OS 3.1.2 and later, and will run on the HP 3PAR StoreServ Storage. The server must be started with the startwsapi command-line interface (CLI) command, and can be configured with the setwsapi command. To start the server, do the following: 1. In the CLI, enter the startwsapi command. NOTE: This command does not run by default. 2. To configure the server, enter the setwsapi command. About the SDK In addition to the WSAPI, HP provides an SDK for Java and Perl, available via download from the following website:software.hp.com. https://h20392.www2.hp.com/portal/swdepot/displayProductInfo.do? productNumber=HP3PAR_WS_API About the WSAPI 9

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
1 Introduction
This
HP 3PAR Web Services API 1.2 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 14)
.
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 are called out.
For typographic conventions used in this guide, see
“Typographic conventions” (page 89)
.
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 API server is part of the HP 3PAR OS 3.1.2 and later, and will run on the HP 3PAR StoreServ
Storage. The server must be started with the
startwsapi
command-line interface (CLI) command,
and can be configured with the
setwsapi
command. To start the server, do the following:
1.
In the CLI, enter the
startwsapi
command.
NOTE:
This command does not run by default.
2.
To configure the server, enter the
setwsapi
command.
About the SDK
In addition to the WSAPI, HP provides an SDK for Java and Perl, available via download from the
following website:
s
o
f
t
w
ar
e
.hp
.co
m
.
h
t
tp
s://h20
3
9
2
.w
w
w2
.hp
.co
m/po
r
t
al/s
w
depo
t/dis
pla
yPr
odu
c
tInf
o
.do?
pr
odu
c
tNumbe
r=HP3P
AR_W
S_AP
I
About the WSAPI
9