Skip to main content

POST /profiles/{id}

Use this method to activate a profile on a target system by assigning an inactive server profile to a target server or redeploying a server profile that is active, pending, or failed activation.

Authentication​

Authentication with username and password is required.

Request URL​

POST https://{management_server_IP}/profiles/{id}

where {id} is the unique ID of the server profile that was assigned when the server pattern was deployed. To obtain the server profile ID, use the GET /profiles method.

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
restartRequiredStringIndicates when to restart the server to activate the profile. This can be one of the following values.
  • immediate. Restart the server and completes the activation immediately.
  • defer. Does not restart the server. Activate is completed after the server is manually restarted.
uuidRequired if the server profile is inactive (not assigned); otherwise, optionalStringFor a rack or tower server, this is the UUID of the target server.

For a Flex System server, this is the location ID of the target server.

Important
An assigned server profile (in the active, pending, or failed activation state) can be redeployed only to the server to which the profile is currently assigned. If you do not specify the uuid attribute for an assigned server profile, the target-server UUID is retrieved from the server profile. If you specified the uuid attribute for an assigned server profile, the specified UUID must match the UUID of the current target server.
The following example activates a profile on the target system and restart the server to activate the profile.
{
   "restart": "defer",
   "uuid": "1B54B9AEFCE04D5E820C0B6310D03590_bay3"
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
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​

None