Upgrade Manager

The upgrade process for OpManager Plus - installed servers across your network is simplified using the Upgrade Manager. It offers a centralised platform to manage and perform upgrades for OpManager Plus Standalone servers, Central, Probes, their Failover servers and APM plug-in. The enhanced smart upgrade feature helps to overcome the bottlenecks faced during the upgrade process.

Upgrade process for versions 12.8.344 & above

For 12.8.344 and above, the upgrade manager simplifies the process into three stages:

Note:

  • In the Enterprise Edition, all Probe services must be up and actively communicating with the Central server. For Failover setups, both the primary and secondary services should be up and running.
  • For service pack versions 12.8.344 and above, manual backup prerequisites are optional as the Upgrade Manager takes the backup automatically.
  • The QPM, designed to deliver targeted patches can be seamlessly applied across services using Upgrade Manager, following the same steps as a service pack.

1. Upload service packs

  • Go to Settings > General Settings > Upgrade Manager Settings > Upgrade Manager.
  • The upgrade manager page provides comprehensive installation details about the servers.
  • Click the Upgrade option at the top right.

Upgrade Manager

  • Download the relevant service pack from the click here option provided below the OpManager Plus service pack field, and click Upload.

Upgrade Manager

Note: If the service pack validation fails, you will be prompted to download and import an Integrity Certificate file to retry the validation process and proceed with the upgrade. Click here to download the certificate.

  • Enterprise Edition: Once the service packs are downloaded in Central, they will automatically be fetched by the Probes. The version number and type of each service pack will be shown for every Probe in the Upgrade Manager.

Upgrade Manager

  • The service pack's download progress status for individual Probes will be displayed under the Current Status column.

While downloading the service pack, if slowness or network issues is encountered, you can manually stop the download using the Stop button in the Actions column. In that case, manually copy the service pack to the <OpManager PlusProbe>\UpgradeManager directory for OpManager Plus service packs, and <OpManager Plus Probe>\AppManager\UpgradeManager for APM Plugin service packs. Use the Refresh button to fetch the latest status of the respective Probe service.

  • If a Probe goes offline or loses connection with Central during the service pack download, then the download will automatically resume once communication is restored.

2. Health check

Once the service pack is downloaded, the system automatically verifies the upgrade requisites via a health check.

  • If the check fails, click Details to view the reasons for the failure.
  • After resolving the issues, click Retry to run the health check again.

Upgrade Manager

  • With a successful health check for both the Central and all Probes, the product is now ready for the upgrade.
  • Click on Start Upgrade to proceed with the upgrade.

Upgrade Manager

3. Upgrade process

  • The upgrade will start, and the progress will be displayed automatically on the service URL.

Upgrade Manager

  • The APM plugin upgrade will automatically start once OpManager Plus has been successfully upgraded on the server.
  • For Failover servers, the upgrade will start automatically for both the active and the standby server.
  • All Probes will automatically begin upgrading simultaneously once the Central upgrade is successfully completed.
  • Upgrade details for individual servers will be automatically updated under the Current Status column in Central.

Upgrade Manager

The upgrade process for OpManager Plus versions above 12.8.344 will be successfully completed.

Upgrade process for versions below 12.8.344

Note: The QPM, designed to deliver targeted patches can be seamlessly applied across services using the UpdateManager.bat /.sh file, following the same steps as a service pack.


 

Upgrade Backup Pre-requisites

Note: For service pack versions below 12.8.179, following the upgrade backup prerequisites is mandatory. For versions 12.8.179 and above, these prerequisites are optional, as the backup is automatically performed during the upgrade process.
  • Take VM snapshot / folder backup of the OpManager Plus Service.
    • If Failover service is configured, take VM snapshot / folder backup of the OpManager Plus Service in both primary and secondary services.
  • If the configured database type is MSSQL or Remote PGSQL, take backup of OpManager Plus Database as well.

To backup only the configuration data:

  • Open command prompt with administrative privileges and go to < OpManager Plus Home>/bin/backup directory and execute the below command: 
    <OpManager Plus Home>/bin/backup>BackupDB.bat -mode configdata.
  • This is used to backup only the configuration data (Backup Conf., Images folder, the details of Devices, Device Templates, Interfaces, Interface Template, Dashboards & Widgets, Infrastructure Views, Business Views, Credentials, Notification Profiles and Users) and not the performance data.

Upgrade Pre-requisites

Before Upgrading OpManager Plus, there are certain pre-requisites to follow for a seamless upgrade process.

  • If an antivirus is running on your system, ensure that it does not interfere with the OpManager Plus directory during the upgrade process.
  • Ensure that the user performing the upgrade has the required permissions for the OpManager Plus folder.

Edition-specific Upgrade

EditionWithout FailoverNew FailoverOld Failover
Standard / ProfessionalUpgrade the service using the UpdateManager.bat /.sh file and once the upgrade is completed start the service to continue monitoring.
  • Stop both primary and secondary failover service.
  • Follow the steps provided under UpdateManager.bat /.sh file to upgrade the service.
  • Then, start the secondary service once as master and stop the service.
  • Now start the primary service followed by secondary service.
  • Stop both primary and secondary service
  • Begin with upgrading the primary service using UpdateManager.bat /.sh file.
  • Once primary service upgrade is successful, perform upgrade on secondary service using UpdateManager.bat /.sh file.
  • After installing the ppm file, start the secondary service followed by the primary service.
  • The secondary service will automatically switch to standby mode once primary service is started completely.
Enterprise EditionUpgrade the service using the steps provided for Smart Upgrade.To upgrade the service, follow the steps provided here.
Note: For detailed information about your Failover model, refer How to identify the Failover model.

Upgrade OpManager Plus using UpdateManager.bat/.sh file

  1. Download the appropriate version from the service packs page.
  2. Stop the OpManager Plus service for the upgrade.
  3. Open command prompt with administrative privileges and go to <OpManager Plus_Home>/bin/ directory.
  4. Execute UpdateManager.bat file (use UpdateManager.sh for Linux).
  5. Browse to the downloaded service pack and select the .ppm file.
  6. Click install and proceed to complete the installation process.
Note: For old Failover model, the upgrade should be performed in both primary and secondary services.

Steps to import the public certificate during an offline upgrade

  • For service packs versions 12.8.000 and below, download this certificate, and for service packs versions above 12.8.000, download this certificate.
  • Launch the Update Manager by running UpdateManager.bat (or UpdateManager.sh for Linux) located in the <OpManager Plus_Home>/bin directory.
  • Click the Import Certificate button in the top-right corner.
  • Browse and select the downloaded certificate file, then click Import.
  • Once the certificate is successfully imported, proceed with applying the .ppm file to begin the upgrade.

Upgrade Manager

 

Smart Upgrade (Automatic upgrading of Probe servers)

  1. The Probe will automatically contact the Central server.
  2. Once the Probe server detects a build number mismatch with the Central server, all the Probe services will be stopped.
  3. The Probe server downloads the Update Pack from the Central server and starts upgrading.
  4. Once the update process is complete, restart all Probe services.
Note: Browser cache might cause issues with the updated OpManager Plus client view, so clear the browser cache after the update.

The following content applies to OpManager Plus versions with build number 12.5.375 and above, till build number 12.8.344

Smart Upgrade (enhanced version)

With this enhancement, users can now view the live upgrade status of the Probes in the Central.

The entire process happens in three parts:

  1. Adding the ppm file.
  2. Sending it to all the Probes.
  3. Upgrading Central and Probes (Smart Upgrade)

Smart Upgrade Process:(For versions below 12.8.344)

  • In the Central, navigate to Settings --> Configuration --> Probe details page and click on Smart Upgrade.

OpManager Plus Enterprise Edition update guide: Probe details page

  • Click on the Browse to add the ppm file.
  • Click on Upload.

OpManager Plus Enterprise Edition update guide: Smart upgrade display page

  • Once the ppm file is uploaded, the download complete status is shown and the Upgrade button appears on the top right corner.
  • Click on Upgrade and at first the Central gets upgraded. (The Central goes down and is restarted once again.)
  • After this the real time upgrade progress of the corresponding Probes is displayed in the Central.
  • Once all the Probes are upgraded, the Upgrade Success status is updated.

Note:

  • When the Auto Download option is enabled, the Probe automatically pulls the ppm file from the Central.
  • When the Auto Download option is disabled, the ppm file should be placed manually in the specified OpManager Plus Probe\SUM folder.

 

Smart Upgrade for Old Model Failover:

For base versions prior to 12.8.344, follow the steps below to upgrade the setup configured with Old Model Failover via Smart Upgrade:

  1. Stop all the secondary services.
  2. Download the ppm file.
  3. Go to the primary Central server, navigate to Settings --> Configuration --> Probe Details page, and click on "Smart Upgrade." Then, upload the ppm file by clicking browse.
  4. Once the ppm is uploaded in Central, it will be downloaded by all the Probes.
  5. Click "Upgrade" to start the Smart Upgrade.

Smart upgrade steps in Failover configured servers: Smart upgrade for old model Failover

  1. The primary Central server will start the upgrade, and once it is complete, the primary Probe will upgrade.
  2. After the upgrade is complete, stop all the primary services completely.
  3. Manually upgrade the secondary Central and secondary Probe using the UpdateManager.bat file, from the <OpManager Plus>/bin directory.
  4. Start the secondary servers first, and they will enter active mode.
  5. Now, start the primary servers. The primary servers will take 20 to 30 secs to switch into active mode, and the secondary servers will revert to standby mode.

Smart Upgrade for New Failover (Virtual IP):

For base versions prior to 12.8.344, follow the steps below to upgrade the setup configured with New Failover (Virtual IP) via Smart Upgrade:

  1. Stop all the secondary services. Ensure that the secondary server's OpManager Plus folder is accessible to the primary server.
  2. Download the ppm file.
  3. Go to the primary Central server, navigate to Settings --> Configuration --> Probe Details page, and click on "Smart Upgrade." Then, upload the ppm file by clicking browse.
  4. Click "Upgrade" to start the smart upgrade.

Smart upgrade steps in Failover configured servers: Smart upgrade for new failover

  1. All the primary and the secondary servers will be upgraded simultaneously.
  2. After the upgrade, the primary servers will start automatically. Start the secondary servers after that.
  3. The primary servers will enter active mode, and the secondary servers will be in standby mode.

How to identify the Failover model

Failover models that do not use Virtual IP and share folder are called Old Failover model, whereas, Failover models that use Virtual IP and share folder can be called as the New Failover model. There are two methods to identify the Failover model.

Method 1 (via UI)

  • In OpManager Plus UI, navigate to Settings -> General Settings -> Failover Details.
  • If there is only a table, it is the old Failover.

Smart upgrade steps in Failover configured servers: Failover details

  • If the Failover architecture is displayed, it must be the new Failover model.

Smart upgrade steps in Failover configured servers: Displayed failover architecture

Method 2 (manual steps)

Old Failover
Connect to OpManager Plus database. Or ensure that DB Query is enabled under System Settings -> Client settings tab, and click the Support icon from the OpManager Plus UI, select DB Query and then execute the below query. If there are two rows, then it is the old Failover model.

  • For Essential / Central - Select * from FailOverDetails where ID = -1;
  • For Probe - Select * from FailOverDetails where ID = (Select MOID from ManagedObject where TYPE='Region');

New Failover

  • If the file itom_fos.conf is present in both the primary and the secondary server, under <OpManager Plus Home>/conf directory, then it is the new Failover model.
Video Zone
OpManager Customer Videos
Michael Senatore, Operations Manager, Rojan Australia Pty Ltd.
  
  •  Venkatesan Veerappan, IT Consultant
     Mohd Jaffer Tawfiq Murtaja, Information Security officer from Al Ain sports club
  •  Jonathan ManageEngine Customer
     IT Admin from "Royal flying doctor service", Australia
  •  Michael Senatore, Operations Manager, Rojan Australia Pty Ltd.
     Michael - Network & Tech, ManageEngine Customer
  •  Altaleb Alshenqiti - Ministry of National Guard - Health Affairs
     Donald Stewart, IT Manager from Crest Industries
  •  John Rosser, MIS Manager - Yale Chase Equipment & Services
     David Tremont, Associate Directory of Infrastructure,USA