Create a group

post/compute-ops/v1beta2/groups

Create a group for a specific user.

To create a OneView appliance group, please use the v1beta3 API.

SecurityBearer
Request
header Parameters
Content-Type
required
string

Content-Type header must designate 'application/json' in order for the request to be performed.

Value: "application/json"
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Request Body schema: application/json
required
name
required
string [ 1 .. 100 ] characters
description
string <= 10000 characters
autoFwUpdateOnAdd
boolean
Default: false

Enable automatic firmware updates to the configured baseline when a server is added to a group, This is equivalent to firmwareUpdate under serverPolicies. The value must be same if both are provided

platformFamily
string
Default: "ANY"

Platform family of all servers in this group. There are no restrictions for groups and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in this group, regardless of the value passed in.

Enum: "ANY" "PROLIANT"
serverSettingsUris
Array of strings
Default: []

URIs for group server settings

data
object
Default: {}
object

Stores policy settings for server group actions

autoAddServerTags
object

A case insensitive tag that can be associated with a group to automatically add servers to the group. A group can have a maximum of one tag and multiple groups can not have the same tag.

When a server is onboarded or has its tags changed, the server's tags will be checked against the group's autoAddServerTags. If at least one of the server tags matches one group's autoAddServerTags, the server will be placed into the associated group. Once a server has been connected, the server becomes ineligible for automatically being placed into groups, even if it is later disconnected.

If a server's tags match more than one group, it will not be put into any group.

If a server is in a group, any further tag changes will not move it to another group. If the server was added to a group but has been removed, is not in any group, and still has not been activated, changing the server tags will automatically assign it to the matching group.

Tags can contain any alphaneumeric characters, any Unicode space separators, and the following characters: _ . : = + - @. An example of one of these tags can be seen in the sample request on this page.

Responses
201

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

409

Conflict

415

Unsupported media type

500

Internal server error

Request samples
application/json
{
  • "name": "Production Group",
  • "description": "All prod servers",
  • "autoFwUpdateOnAdd": false,
  • "platformFamily": "ANY",
  • "serverSettingsUris": [
    ],
  • "data": { },
  • "serverPolicies": {
    },
  • "autoAddServerTags": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "compute-ops/group",
  • "resourceUri": "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d",
  • "name": "Production Group",
  • "generation": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "description": "All prod servers",
  • "autoFwUpdateOnAdd": true,
  • "groupComplianceStatus": "COMPLIANT",
  • "serverSettingsUris": [
    ],
  • "platformFamily": "ANY",
  • "devicesUri": "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices",
  • "devices": [ ],
  • "serverPolicies": {
    },
  • "autoAddServerTags": {
    },
  • "groupMeta": {
    }
}