Upgrading agents remotely

You can upgrade agents that have a status of Upgrade Recommended or Upgrade Required by using the Upgrade action.

Before you begin

  • To ensure compatibility and optimal performance, run the same version of the HCL DevOps Deploy (Deploy) server and agents. Server and agents of different versions may result in unexpected behavior. In such case, you must update or roll back the server and agents so that they run the same versions.
  • You must upgrade the server before you upgrade the agents.

About this task

The agent status indicates when it is time to upgrade it. You must upgrade agents in the following cases:
  • When an agent has the Upgrade Required status. Such agents cannot run deployments until they are upgraded. This status might occur if a change is made to server-agent communications.
  • When an agent has the Upgrade Recommended status. It might occur after a performance enhancement. An agent with the status Upgrade Recommended can run deployments, but for best performance, upgrade the agent.
  • To improve the Deploy security by using a TLS protocol. Some older agents are only compatible with SSLv3. SSLv3 is dynamically enabled if necessary. See Supported TLS and SSL protocols and ciphers.
  • Upgrade agents and agent relays in addition to upgrading the server.

Refer to the Upgrading z/OS agents section for information about upgrading the z/OS agents remotely.

You can upgrade agents individually or in a batch. To upgrade agents:


  1. Click Resources > Agents.
    The Agents pane lists agents and their status.
  2. Select the check boxes for the agents to upgrade.
  3. Click Actions > Upgrade
    Upgraded agents are taken offline while the upgrade is applied and have the Offline status. If the upgrade finishes, the agents are automatically restarted and have the Online status. If the agents do not come back online, check their logs for error messages.

    Updating many agents simultaneously can have a significant affect the server. As a rule-of-thumb, limit the number of simultaneous upgrades to 10 or fewer.


Upgraded or installed agents are migrated to compact mode. Note that agents are updated to compact only if the agent is installed/upgraded on a platform that supports compact agents.