HP OneView REST API Reference

racks
racks.html[10/17/2013 10:35:42 AM]
Updated: October 16, 2013 4:37
MDT
API Specifications Create Read Update Delete
/rest/racks POST GET DELETE
/rest/racks/schema GET
/rest/racks/{id} GET PUT DELETE
/rest/racks/{id}/deviceTopology GET
Resource Model
Rack
RackList
EnvironmentalAnalysis
TaskResourceV2
HP OneView REST API Reference
racks
A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices and
unmanaged devices, in a data center. Describing the physical layout of equipment in racks in your data center simplifies
locating specific devices for hands-on-servicing, and enables space/power planning. Racks have physical dimensions
(width, height, depth) and a fixed number of U slots to contain IT equipment (enclosures, servers, power delivery devices,
unmanaged devices, etc). This API allows you to get the configuration data for one or more racks, create a rack, specify the
physical content of a rack, modify rack attributes, or delete a rack.
URI: /rest/racks
Method API
GET Gets a set of rack resources according to the specified parameters. Filters can be used to get a
specific set of racks. With no filters specified, the API returns a potentially paginated list of all the
racks subject to start/count/sort parameters.
Parameter Attributes Description
start Optional The 0-based index of the first resource to return (start=0 starts
with the first available resource). If the specified count does not
return all resources within the maximum allowed time (see count),
use the start parameter to view additional resource pages. The
default value for start is 0 (first available resource).
count Optional Optional parameter that specifies the number of resources to return
from each API invocation. The number of resources returned on
each call is referred to as a page. If you specify a count, the API
attempts to return the specified number of resources, however this
may be limited due to response time constraints and/or actual
number of resources available to return. The results include the total
number of resources that match the filter or query, the actual
count returned, and the URIs to go to the next page, previous
page, or both. If necessary, you can make several requests using
the URI for the next or previous page (or different start
parameters) to get the desired count.
sort Optional The sort order of the returned data set. By default, the sort order is
based on the create time, with the oldest entry first.
query Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted in
the implementation description.