UFM Enterprise Appliance Upgrade | NVIDIA UFM XDR-DC Enterprise Appliance Software User Manual

Upgrading UFM Enterprise Appliance from LTS version to GA version and vice versa is not supported – user can upgrade from older GA-1 or GA-2 to selected GA version or in case of UFM LTS version from specific LTS update version to a newer version on the same LTS (for example: upgrading from LTS-2024-U1 to LTS-2024-U3).

Upgrading UFM XDR Enterprise appliance is supported only from up to two previous GA versions (GA-1 or GA-2).

Upgrading UFM XDR Enterprise appliance from an LTS version to a GA version, and vice versa, is not supported. Users can upgrade from GA-1 or GA-2 to the selected GA version, or — in the case of a UFM LTS version — from a specific LTS update version to a newer update on the same LTS (for example, upgrading from LTS-2024-U1 to LTS-2024-U3).

This is the recommended upgrade procedure, which involves upgrading all UFM Enterprise appliance software components and operating system. For additional upgrade procedures of specific software components, please refer to Appendix - Software Components Upgrade.

Some plugin images are available for deployment as part of the OMU (OS Manufacturer Upgrade) image. Information regarding the relevant plugins and their versions is available in the "show version" CLI command and in the /etc/ufm-release file.
The unique image name is "/var/opt/ufm/images/ufm-plugin-<plugin name>_from_release.tgz" to allow overriding previous plugin versions.
Note: Plugin versions are not upgraded automatically. The OMU upgrade only makes the new plugin versions available - upgrading them is a separate, manual step. For more information, refer to the UFM plugin upgrade command: UFM Commands -> ufm plugin.
As of UFM gNMI plugin version 1.3.0, the configuration file has been modified to support XDR. For further details, please refer to GNMI-Telemetry Plugin.

In-Service Upgrade via SHELL

Upgrade docs omit mandatory manual plugin upgrade step and misleading plugin version verification

The upgrade is performed on both Master and Standby nodes.

To upgrade the UFM Enterprise Appliance software:

On the standby server, extract the OMU image to the /tmp folder:
```
tar -xzf ufm-appliance-<version>-omu.ubuntu24.tar -C /tmp
```
On the standby server, access the installation folder and upgrade script:
```
standby# cd /tmp/ufm-appliance-<version>-omu.ubuntu24
```

Run the UFM upgrade script on the standby server:
```
./ufm-os-upgrade.sh --yes --reboot
```
After the reboot procedure is complete, a systemd service (ufm-os-firstboot.service) runs the remainder of the upgrade procedure. Once completed, a message is prompted to all open terminals including the status:
"UFM-OS-FIRSTBOOT-FAILURE" - if installation is failed.
"UFM-OS-FIRSTBOOT-SUCCESS" - if installation succeeded.
Example:
```
root# ufm-ai03:~#
root# ufm-ai03:~#
Broadcast message from root@ufm-ai03 (somewhere) (Fri Dec 30 18:47:32 2022):

UFM-OS-FIRSTBOOT-SUCCESS, installation succeeded additional info is available in /var/log/ufm-os-firstboot.log
```
To manually check the status, run systemctl status ufm-os-firstboot.service. If it is already finished, an error message is prompted stating that there is no such service. In that case, the log /var/log/ufm-os-firstboot.log can be checked instead.
```
systemctl status ufm-os-firstboot.service
```
Example:
```
root# ufm-ai03:~# systemctl status ufm-os-firstboot
Unit ufm-os-firstboot.service could not be found.
root# ufm-ai03:~# 
```

Do NOT proceed to the next step before ensuring that the systemctl status ufm-os-firstboot.service service has been completed.

After the completion of the upgrade script, the UFM code is upgraded, while the UFM data remains unchanged. The automatic upgrade of UFM data will take place during the next UFM startup. To initiate this process, execute a failover from the Master node (or perform a takeover from the Standby node).
```
master# ufm_ha_cluster failover
```

The upgrade script logs the data to /var/log/ufm_os_upgrade_<UFM-OS version>.log and outputs simultaneously it to the screen. In case of an issue, UFM data can be restored to factory default. For more information, refer to UFM Factory Reset.

Once UFM is operational on the upgraded node (formerly the standby node), proceed to replicate steps 1 to 3 on the non-upgraded node (previously the master node).

In-Service Upgrade via CLI

Alternatively, in-service upgrade can be performed via the CLI. The upgrade is performed on both Master and Standby nodes.

Follow the below instructions:

On the Standby node, fetch the new image from a remote server. Run:
```
ufmapl (config) # image fetch <download URL>
```
On the Standby node, install the new image. Run:
```
ufmapl (config) # image install <image name>
```
Reload the Standby UFM Enterprise Appliance. Run:
```
ufmapl (config) # reload
```
After the completion of the upgrade on the Standby node, the UFM code is upgraded, while the UFM data remains unchanged. The automatic upgrade of UFM data will take place during the next UFM startup. To initiate this process, execute a failover from the Master node. Once the Standby node is up and running, perform a failover on the Master node. Run:
```
ufmapl (config) # ufm ha failover
```
Once UFM is operational on the upgraded node (formerly the standby node), proceed to replicate steps 1 to 3 on the non-upgraded node (previously the Master node).

Last updated: August 31, 2026