HP OneView REST API Reference

enclosure-groups
enclosure-groups.html[10/17/2013 10:35:20 AM]
filter Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted in the
implementation description.
A general filter/query string that narrows the list of resources returned by
a multi-resource GET (read) request and DELETE (delete) request. The
default is no filter (all resources are returned).
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
EnclosureGroupList Returns the requested enclosure groups.
Response Codes
REST API Response Codes
Examples
Get a list of enclosure groups with a status of OK, sorted
by name.
GET https://{appl}/rest/enclosure-groups?
filter="healthStatus='OK'"&sort="name"
POST Creates an enclosure group. An interconnect bay mapping must be provided for each of the
interconnect bays in the enclosure. For this release, the same logical interconnect group must be
provided for each interconnect bay mapping.
Parameter Attributes Description
Request Header Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Request Body Attributes Description
EnclosureGroup Required The enclosure group resource to create.
Response Description
EnclosureGroup Returns the created enclosure group resource.
Response Codes
REST API Response Codes
Examples
Create an enclosure group named "Group 1."
POST https://{appl}/rest/enclosure-groups
{
"type": "EnclosureGroup",
"name" : "Group 1",
"stackingMode": "Enclosure",
"interconnectBayMappings":
[
{
"interconnectBay": 1,
"logicalInterconnectGroupUri": "/rest/logical-interconnect-