HP OneView REST API Reference

enclosure-groups
enclosure-groups.html[10/17/2013 10:35:20 AM]
Updated: October 16, 2013 4:47
MDT
API Specifications Create Read Update Delete
/rest/enclosure-groups POST GET
/rest/enclosure-groups/schema GET
/rest/enclosure-groups/{id} GET PUT DELETE
Resource Model
EnclosureGroup
EnclosureGroupList
HP OneView REST API Reference
enclosure-groups
The enclosure group resource provides REST APIs for managing enclosure groups. An enclosure group is a resource that
defines common settings that should be applied to all enclosures within the group. You can retrieve an enclosure group resource
representing any enclosure group managed by the appliance, create new enclosure groups, and update existing enclosure
groups.
URI: /rest/enclosure-groups
Method API
GET Gets a list of enclosure groups.
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.
If the query is supported, the following is the way it works. A general
query string that narrows the list of resources returned by a multi-
resource GET (read) request and DELETE (delete) request. The default is
no query (all resources are returned). One advantage query has over
filter is that it can have embedded ORs. A single query parameter
can do what would take multiple parameters or multiple GET requests
using filter. Use query for more complex queries.