Patch a group

patch/compute-ops-mgmt/v1/groups/{group-id}

Partially update a group.

SecurityBearer
Request
path Parameters
group-id
required
string <uuid>
header Parameters
Content-Type
required
string

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

Value: "application/merge-patch+json"
Request Body schema: application/merge-patch+json
required
name
string [ 1 .. 100 ] characters
description
string <= 10000 characters
settingsUris
Array of strings
Default: []

URIs for group device settings

Server Policies (object) or OneView Appliance Policies (object) or null (groupPolicies-v1)
autoAddTags
object

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

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

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

If a devices is in a group, any further tag changes will not move it to another group. If the device was added to a group but has been removed, is not in any group, and still has not been activated, changing the device 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
200

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

415

Unsupported media type

500

Internal server error

Request samples
application/merge-patch+json
{
  • "name": "Production Group",
  • "description": "All prod servers",
  • "settingsUris": [
    ],
  • "policies": {
    },
  • "autoAddTags": {
    }
}
Response samples
application/json
{
  • "deviceType": "DIRECT_CONNECT_SERVER",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Production Group",
  • "type": "compute-mgmt-ops/group",
  • "description": "All prod servers",
  • "complianceStatus": "COMPLIANT",
  • "settingsUris": [
    ],
  • "devicesUri": "/compute-ops-mgmt/v1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices",
  • "devices": [ ],
  • "policies": {
    },
  • "autoAddTags": {
    },
  • "securityStatus": "RISK",
  • "groupCompliance": {
    },
  • "resourceUri": "/compute-ops-mgmt/v1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d",
  • "generation": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}