Skip to main content

Assign, unassign, or deploy a template

POST 
/apis/v1/templates-management/management

Use this method to assign or unassign a device template to specified resources or to deploy assigned templates to specified resources.

An asynchronous job is created to complete this request in the background. The response header returns the URI for the job in the Location field. Use GET /api/v1/jobs-management/jobs to retrieve the job status and additional job details.

A successful response code indicates that the job was successfully created and accepted by the portal. It does not indicate that the operation that is associated with the job was successful. If a job was not successfully started, refer to the response code and response body for details.

Attention:

  • In some cases, prerequisite firmware might be needed to install the target firmware version. XClarity One automatically installs prerequisite firmware, when available.
  • Some components require the device to be restarted to complete the firmware update, such as unified extensible firmware interface (UEFI), network cards, RAID adapters, and disks. During the update process, the device might be restarted automatically one or more times until the entire process is complete. Ensure that any running workloads have either been stopped or moved to a different server.
  • Performing firmware updates, device-settings updates, os deployments, and power operations on managed devices are disabled by default. Before deploying a template, ensure that you enable the appropriate functions on the XClarity One portal and on the management hub that manages that target devices.
  • To avoid out-of-memory errors, update no more than 300 devices simultaneously.

Request​

Responses​

Success