GET /patterns/{id}
Use this method to return information about a specific server pattern or category pattern.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/patterns/{id}
where {id} is the unique ID that was assigned when the server pattern was created. To obtain the pattern ID, use the GET /patterns method.
Query parameters
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 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. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| identifier | String | Always set to id | ||
| items | Array | Information about the pattern | ||
| bmcOnly | Boolean | Indicates whether the server pattern contains only IMM settings, including System Information, Management Interface,and Extended BMCcategory patterns. This can be one of the following values.
| ||
| containsM2 | Boolean | Indicates whether the server pattern contains M.2 drive settings. This can be one of the following values.
| ||
| description | String | Description of the pattern that was defined by the user when the pattern was created | ||
| formFactor | String | Form factor of the pattern. This can be one of the following values.
| ||
| id | String | Patterns unique ID that was generated on creation | ||
| inUse | Boolean | Indicates whether pattern has been deployed to one or more servers. This can be one of the following values.
| ||
| name | String | Name of the pattern | ||
| nodeType | String | Type of server to which the pattern applies. This value is always sysx. | ||
| referencedBy | Array | List of patterns that reference this pattern. For server patterns, this attribute is always empty. | ||
| serverType | String | Server type If the type is unknown, this value is | ||
| type | String | Type of pattern. This value is always Server . | ||
| useCount | Integer | (Category patterns only) Number of server patterns that use this category pattern | ||
| uri | String | URI that is used to make individual REST API calls to the referenced object | ||
| userDefined | Boolean | Indicates whether the pattern is user-defined or predefined. This can be one of the following values.
| ||
| label | String | Always set to label | ||
The following example is returned for a server pattern if the request is successful.
{
"identifier": "id",
"items": [{
"bmcOnly": false,
"containsM2": false,
"description": "",
"formFactor": "f",
"id": "46",
"inUse": true,
"name": "asdfasdf",
"nodeType": "sysx",
"referencedBy": [],
"serverType": "NA",
"type": "Server",
"uri": "/config/template/46",
"userDefined": true
}],
"label": "name"
}
The following example is returned for a system information category pattern if the request is successful.
{
"identifier": "id",
"items": [{
"bmcOnly": false,
"containsM2": false,
"description": "",
"id": "46",
"inUse": false,
"name": "sysInfo",
"referencedBy": [],
"serverType": "NA",
"type": "SystemInfo",
"uri": "/config/template/46",
"useCount": 2,
"userDefined": true
}],
"label": "name",
}
Give documentation feedback