POST /patterns/{id}
Use this method to deploy a server pattern to a target server.
Authentication
Authentication with username and password is required.
Request URL
POST 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.
Request body
None
Request body
| Attributes | Required / Optional | Type | Description |
|---|---|---|---|
| endpointIds | Required for empty Flex chassis bays and placeholder chassis bays Optional for Flex System servers | Array of strings | A list of one or more UUIDs for the target servers, empty chassis bay, or placeholder chassis bay. To obtain UUIDs for deployable target servers according to their pattern and profile, use the GET /config/target/{id} method. |
| restart | Required | String | Identifies when to activate the configurations. This can be one of the following values.
|
| uuid | Required for rack and tower servers Optional for Flex System servers | Array of strings | A list of one or more UUIDs for the target servers. To obtains the UUIDs for servers, use the GET /nodes method. |
The following example deploys a server pattern to two Flex System Placeholder chassis empty bays using deferred activation.
{
"endpointIds": [
"phc-efebecbc232a4e418081862589dde160_bay3",
"phc-efebecbc232a4e418081862589dde160_bay4"
],
"restart": "defer"
}
The following example deploys a server pattern to one System x rack server using immediate activation.
{
"uuid": ["1B54B9AEFCE04D5E820C0B6310D03590"],
"restart": "immediate"
}
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. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions. |
| 404 | Not found | A specified resource cannot be found. 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 | ||
|---|---|---|---|---|
| identifier | String | Always set to id | ||
| label | String | Always set to label | ||
| items | Array | Information about each server and category pattern | ||
| endpointIds | Array | UUIDs of all targeted servers | ||
| endpointNames | Array | Names of all targeted servers | ||
| jobName | String | Name of the deploy job created | ||
| jobRecordID | String | ID of the deploy job | ||
| locationIds | Array | Location IDs for empty bays or placeholder bays that are targeted | ||
| locationIdsFailed | Array | Location IDs for targeted bays for which deployment failed | ||
| locationNames | Array | Names of all targeted empty bays | ||
| message | Null | Currently not used. This value should always be null. | ||
| redeployedNodeUuids | Array | UUIDs of all servers targeted for redeployment | ||
| uuidsFailed | Array | UUIDs of targeted servers for which deployment failed | ||
{
identifier: "id"
label: "id"
items: [1]
0: {
endpointIds: [0]
endpointNames: [0]
jobName: "Server Profile activation: Apr 9, 2015"
jobRecordId: "48cf5296-9b6a-454e-80ad-b88b98f11b38"
locationIds: [2]
0: "phc-efebecbc232a4e418081862589dde160_bay3"
1: "phc-efebecbc232a4e418081862589dde160_bay4"
...
locationIdsFailed: [0]
locationNames: [2]
0: "Bay3"
1: "Bay4"
...
redeployedNodeUuids: [0]
message: null
uuidsFailed: [0]
}
...
...
}