Skip to main content

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

ParametersRequired / OptionalDescription
IncludeResultDetails={boolean>OptionalIdentifies whether to include details about the unassignment request. This can be one of the following values.
  • true. Returns details.
  • false. Returns only a success or failure message.

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

AttributesRequired / OptionalTypeDescription
forceOptionalBooleanIdentifies whether to force profile deactivation. This can be one of the following values.
  • true. Forces profile deactivation.
  • false. Does not force profile deactivation.
powerDownITEOptionalBooleanIdentifies whether to power off the server. This can be one of the following values.
  • true. Powers off the server.
  • false. Does not power off the server.
resetIMMOptionalBooleanIdentifies whether to reset the baseboard management controller. This can be one of the following values.
  • true. Resets the management controller.
  • false. Does not reset the management controller.
resetSwitchOptionalBooleanIdentifies whether to reset the switch internal port settings to default values. This can be one of the following values.
  • true. Resets the switch internal port settings to default values.
  • false. (default) Does not reset the switch internal port settings.

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

CodeDescriptionComments
200OKThe request completed successfully.
403ForbiddenThe 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.

404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

AttributesTypeDescription
 ArrayInformation about the actions that were accomplished during the unassignment of the profile
 deactivateProfileArrayProfile is deactivated from LDAP
  attemptedBooleanIndicates whether the disabling profile mode was attempted. This can be one of the following values.
  • true. Deactivating the profile was attempted.
  • false. Deactivating the profile was not attempted.
  requiredBooleanIndicates whether the profile must be deactivated. This can be one of the following values.
  • true. Deactivating the profile is required.
  • false. Deactivating the profile is not required.
  succeededBooleanIndicates whether the reset was successful. This can be one of the following values.
  • true. Deactivating the profile was successful.
  • false. Deactivating the profile was not successful.
 disableProfileModeArrayProfile is disabled from LDAP
  attemptedBooleanIndicates whether the disabling profile mode was attempted. This can be one of the following values.
  • true. Disabling profile mode was attempted.
  • false. Disabling profile mode was not attempted.
  requiredBooleanIndicates whether the profile mode must be disabled. This can be one of the following values.
  • true. Disabling profile mode is required.
  • false. Disabling profile mode is not required.
  succeededBooleanIndicates whether the reset was successful. This can be one of the following values.
  • true. Disabling profile mode was successful.
  • false. Disabling profile mode was not successful.
 powerOffServerArrayServer request was sent as a result of unassign. Must be specified as part of the request body.
  attemptedBooleanIndicates whether the powered off was attempted. This can be one of the following values.
  • true. Power off was attempted.
  • false Power off was not attempted.
  requiredBooleanIndicates whether the server must be powered off. This can be one of the following values.
  • true. Power off is required.
  • false Power off is not required.
  succeededBooleanIndicates whether the powered off was successful. This can be one of the following values.
  • true. Power off was successful.
  • false Power off was not successful.
 resetIMMToDefaultsArrayReset IMM to defaults as a result of unassign. Must be specified as part of the request body.
  attemptedBooleanIndicates whether the reset was attempted. This can be one of the following values.
  • true. Reset was attempted.
  • false Reset was not attempted.
  requiredBooleanIndicates whether the IMM must be reset to default values. This can be one of the following values.
  • true. Reset is required.
  • false. Reset is not required.
  succeededBooleanIndicates whether the reset was successful. This can be one of the following values.
  • true. Reset was successful.
  • false Reset was not successful.
profileIdIntegerID of profile on which action was attempted
messageStringDetailed description of the message
The following example is returned if the request is successful.
{
[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: ""
}