Upgrading Cluster Control Manager

Last Updated : Mar 20, 2026 |
Prolog information
Use this procedure to upgrade Cluster Control Manager. The upgrade takes about 15 to 20 minutes to complete. When the upgrade completes, the upgrade utility exits and the Cluster Control Manager automatically reboots.
Before you begin
  • Download the CCM upgrade Docker image to your laptop or PC
  • Upload the CCM upgrade Docker image to CCM
  • If an upgrade configuration yaml is provided by your solution, transfer the CCM upgrade-config.yaml file to Cluster Control Manager by using a file transfer utility, such as WinSCP.
  1. Log in to the Cluster Control Manager (CCM) console as the customer user.
  2. Create the upgrade configuration yaml.
    ADDITIONAL INFORMATION:
    Note:
    If an upgrade configuration yaml is provided by your solution, use that file and skip this step.
    1. Type vi /home/<customer account directory>/upgrade-config.yaml
    2. Enter the version string from your solution documentation.
      ADDITIONAL INFORMATION:
      For example;
      common_services_product_version: 1.3.0.2.242002
      system: 1.3.0.2.242002
      For more information about the GA version number, see your solution release notes.
    3. Save and exit the file.
  3. Change the directory to /home/<customer account directory>.
  4. Run the following command:
    ADDITIONAL INFORMATION:
    screen
    STEP RESULT:
    The screen utility runs the upgrade in the background.
  5. To begin the upgrade, run the following command:
    ADDITIONAL INFORMATION:
    ccm upgrade system upgrade-config.yaml
  6. After the prompt to perform a backup, enter y.
    ADDITIONAL INFORMATION:
    • Entering n cancels the operation.
    • Entering y runs a backup after the upgrade is complete.
    STEP RESULT:
    The backup takes approximately 5 to 10 minutes to complete. The backup file is located at /var/avaya/artifactCache/
  7. To restore the operation, enter the password when prompted.
  8. When prompted, enter your Avaya SSO credentials.
    ADDITIONAL INFORMATION:
    You must enter the CCM local registry username and password configured with the agn-ctl setup command earlier.
  9. If the official Release Notes state that you must install a patch after the CCM upgrade, run the following command:
    ADDITIONAL INFORMATION:
    patchReleases
  10. Accept the EULA.
  11. Confirm the warning regarding the recommendation of a snapshot for reversion and acknowledgment that CCM restarts after the upgrade is applied.
    ADDITIONAL INFORMATION:
    Important:
    If a snapshot has not been taken, enter no and return to the Before you begin section to confirm all steps is complete before continuing.
    STEP RESULT:
    The restart takes about 2 minutes after the upgrade completes.
  12. Detach from the upgrade SSH session.
    ADDITIONAL INFORMATION:
    For the steps to detach a session, see the Detaching from the upgrade SSH session
  13. If the upgrade fails with an error, resolve the issue causing the failure and restart the upgrade by reverting to your snapshot and running the ccm upgrade system upgrade-config.yaml command.
    ADDITIONAL INFORMATION:
    For more information about troubleshooting installation failures, see the Maintaining and Troubleshooting Avaya Analytics™ for Avaya Oceana® document.