GET /resourceGroups/{uuid}
Use this method to retrieve information about a specific resource group.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/resourceGroups/{uuid}
where {uuid} is the UUID of a resource group. To obtain the group UUID, use GET /resourceGroups.
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| criteria | Object | (Dynamic groups only) Information about a simple criteria object or criteria set that select which managed devices are members of the dynamic group Simple criteria is a query (logical rule) that compares property values. The following example selects managed devices whose contact is John@company.com. A criteria set is the root of the tree structure that defines how the simple criteria are logically combined, using Boolean AND and OR relationships. The following example shows a criteria set that logically combines two simple criteria with an AND relationship. It selects managed devices whose contact is John@company.com and are in the Critical state. | ||
| criteria | Array of objects | Nested criteria or criteria set that defines the members of the dynamic group. Array elements can be a combination of simple criteria or criteria set objects. | ||
| id | String | ID of the simple criteria or criteria set object | ||
| operator | String | Operator For criteria, you can obtain a list of valid operator values for each property using GET /resourceGroups/criteriaProperties. For criteria sets, this can be one of the following values:
| ||
| parent | String | ID of the parent criteria set. This is rootwhen the criteria or criteria set is not nested. | ||
| property | String | Inventory property. To obtain a list of properties, use GET /resourceGroups/criteriaProperties. | ||
| value | String | Value of the property | ||
| description | String | Description of the resource group | ||
| healthStatus | String | Status of the device with the highest severity. This can be one of the following values.
| ||
| members | Array of strings | URIs for all managed devices that are members of this resource group Members are automatically removed from the group if the device is not managed by Lenovo XClarity Administrator. For dynamic groups, the members consist of the managed devices that satisfy the criteria at the time that the GET request is done. | ||
| memberUuids | Array of strings | UUIDs for all managed devices that are members of this resource group | ||
| name | String | Unique name of the resource group | ||
| query | String | Internal use only. Deprecated This attribute is deprecated and will be removed in a future release. | ||
| rsql | String | Internal use only. Deprecated This attribute is deprecated and will be removed in a future release. | ||
| type | String | Type of resource group. This can be one of the following values.
| ||
| uuid | String | Resource group UUID | ||
The following example is returned if the request is successful for a static group.
{
"criteria": null,
"description": "Business application VMware clusters",
"healthStatus": "Normal",
"members": [
"nodes/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"nodes/BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"
],
"memberUuids": [
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"
],
"name": "e-Commerce Servers",
"query": null
"rsql": null,
"type": "static",
"uuid": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
}
The following example is returned if the request is successful for a dynamic group.
{
"criteria": {
"criteria": [{
"id": "1000",
"operator": "equals",
"parent": "root",
"property": "overallHealthState",
"value": "Critical"
},
{
"id": "1002",
"operator": "contains",
"parent": "root",
"property": "location.location",
"value": "Lab10"
},
{
"id": "1002",
"operator": "contains",
"parent": "root",
"property": "location.rack",
"value": "rack1"
},
{
"criteria": [{
"id": "1004",
"operator": "contains",
"parent": "1003",
"property": "machineType",
"value": "7X07"
},
{
"id": "1005",
"operator": "contains",
"parent": "1003",
"property": "machineType",
"value": "7X08"
}],
"id": "1003",
"operator": "OR",
"parent": "root"
}],
"id": "root",
"operator": "AND",
"parent": "root"
},
"description": "All ThinkSystem SR530 servers in room 1 in Lab10 that have critical errors",
"healthStatus": "Normal",
"members": [
"nodes/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"nodes/BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
"nodes/CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC"
],
"memberUuids": [
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
"CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC"
],
"name": "Critical SR530 servers",
"query": null
"rsql": null,
"type": "dynamic",
"uuid": "GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG"
}
Give documentation feedback