POST /profiles/unassign/{id}
Use this method to deactivate a profile from a specific managed server.
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/profiles/unassign/{id}
where {id} is the unique ID of the server profile that was assigned when the server pattern was deployed. You can specify multiple profile IDs, separated by commas. To obtain the server profile IDs, use the GET /profiles method.
Query parameters
Parameters | Required / Optional | Description |
---|---|---|
IncludeResultDetails={boolean> | Optional | Identifies whether to include details about the unassignment request. This can be one of the following values.
|
The following example deactivate a profile from a specific managed server and returns details about the request.
PSOT https://192.0.2.0//profiles/unassign/52?IncludeResultDetails=true
Request body
Attributes | Required / Optional | Type | Description |
---|---|---|---|
force | Optional | Boolean | Identifies whether to force profile deactivation. This can be one of the following values.
|
powerDownITE | Optional | Boolean | Identifies whether to power off the server. This can be one of the following values.
|
resetIMM | Optional | Boolean | Identifies whether to reset the baseboard management controller. This can be one of the following values.
|
resetSwitch | Optional | Boolean | Identifies whether to reset the switch internal port settings to default values. This can be one of the following values.
|
The following example deactivate a profile from a specific managed server, and resets the baseboard management controller and switch settings.
{
"force": true
"powerDownITE": true,
"resetIMM": false,
"resetSwitch": true
}
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. |
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 | ||
---|---|---|---|---|
Array | Information about the actions that were accomplished during the unassignment of the profile | |||
deactivateProfile | Array | Profile is deactivated from LDAP | ||
attempted | Boolean | Indicates whether the disabling profile mode was attempted. This can be one of the following values.
| ||
required | Boolean | Indicates whether the profile must be deactivated. This can be one of the following values.
| ||
succeeded | Boolean | Indicates whether the reset was successful. This can be one of the following values.
| ||
disableProfileMode | Array | Profile is disabled from LDAP | ||
attempted | Boolean | Indicates whether the disabling profile mode was attempted. This can be one of the following values.
| ||
required | Boolean | Indicates whether the profile mode must be disabled. This can be one of the following values.
| ||
succeeded | Boolean | Indicates whether the reset was successful. This can be one of the following values.
| ||
powerOffServer | Array | Server request was sent as a result of unassign. Must be specified as part of the request body. | ||
attempted | Boolean | Indicates whether the powered off was attempted. This can be one of the following values.
| ||
required | Boolean | Indicates whether the server must be powered off. This can be one of the following values.
| ||
succeeded | Boolean | Indicates whether the powered off was successful. This can be one of the following values.
| ||
resetIMMToDefaults | Array | Reset IMM to defaults as a result of unassign. Must be specified as part of the request body. | ||
attempted | Boolean | Indicates whether the reset was attempted. This can be one of the following values.
| ||
required | Boolean | Indicates whether the IMM must be reset to default values. This can be one of the following values.
| ||
succeeded | Boolean | Indicates whether the reset was successful. This can be one of the following values.
| ||
profileId | Integer | ID of profile on which action was attempted | ||
message | String | Detailed description of the message |
{
[1]
0: {
deactivateProfile:
{
"required": true,
"attempted": true,
"succeeded": true
},
...
disableProfileMode:
{
"required": false,
"attempted": false,
"succeeded": false
},
...
powerOffServer:
{
"required": false,
"attempted": false,
"succeeded": false
},
...
resetIMMToDefaults:
{
"required": false,
"attempted": false
"succeeded": false
},
...
},
...
profileId: "52",
message: ""
}