HP 3PAR Web Service API 1.3.1 Developer's Guide

12 WSAPI Support for HP 3PAR Priority Optimization
HP 3PAR Priority Optimization software uses quality-of-service rules to manage and control the
I/O capacity of an HP 3PAR StoreServ Storage system across multiple workloads. Application of
the rules enables co-location of the data from workloads of different types (such as sequential,
random, and transactional, among others), with different I/O packet sizes on a single HP 3PAR
storage system.
Creating QoS Rules
To create a QoS rule, use the HTTP POST method on the following URI:
https://<storage_system>:8080/api/v1/qos
with message body members as shown in Table 141 (page 140). The name and type JSON objects
are required, and at least one of the other JSON objects in Table 141 (page 140) must be specified
as well.
QoS Rule Creation:
• The QoS rule can be applied to VV sets. By using sys:all_others, you can apply the rule
to all volumes in the system for which no QoS rule has been defined.
• ioMinGoal and ioMaxLimit must be used together to set I/O limits. Similarly,
bwMinGoalKB and bwMaxLimitKB must be used together.
• If ioMaxLimitOP is set to 2 (no limit), ioMinGoalOP must also be to set to 2, and vice
versa. They cannot be set to ”no limit” individually. Similarly, if bwMaxLimitOP is set to 2
(no limit), then bwMinGoalOP must also be set to 2.
• If ioMaxLimitOP is set to 1 (zero), ioMinGoalOP must also be to set to 1, and vice versa.
Similarly, if bwMaxLimitOP is set to 1 (zero), then bwMinGoalOP must also be set to 1.
• The ioMinGoalOP and ioMaxLimitOP fields take precedence over the ioMinGoal and
ioMaxLimit fields.
• The bwMinGoalOP and bwMaxLimitOP fields take precedence over the bwMinGoalKB and
bwMaxLimitKB fields.
Table 141 Message Body JSON Object Members for QoS Rule Creation
DescriptionIgnored ValuesAPI TypeJSON TypeMember
The name of the target
object on which the
None.
This is a required
field.
name31stringname
new QoS rules will be
created.
Since WSAPI 1.3
Type of QoS target.Zero and negative
values.
targetType Enumnumbertype
Since WSAPI 1.3
This is a required
field.
QoS priority.Zero and negative
values.
priority Enumnumberpriority
Since WSAPI 1.3
Bandwidth rate
minimum goal in
kilobytes per second.
Zero and negative
values.
uint64numberbwMinGoalKB
Since WSAPI 1.3
140 WSAPI Support for HP 3PAR Priority Optimization