Upgrade an engine - Administrator Guide - 8 - Cortex XSOAR - Cortex - Security Operations

Cortex XSOAR Cloud Documentation

Product
Cortex XSOAR
Version
8
Creation date
2024-03-07
Last date published
2024-10-09
Category
Administrator Guide
Solution
Cloud
Abstract

Upgrade an engine on Cortex XSOAR or directly on the remote machine.

Whenever there is a Cortex XSOAR major version change or a change in tenant-engine protocol version, your engines require an upgrade. On the Engines page, the Status column shows those engines that require upgrades. You can upgrade an engine by doing the following:

  • If you installed the engine using the Shell installer, you can upgrade the engine on the Engines page.

  • If you didn't install the engine using the Shell installer, you need to remove the engine and do a fresh install.

Upgrade an engine (Shell installations)

You can upgrade the engine on the Engines page if you have installed the engine using the Shell installer.

Note

The Engine needs to be connected.

  1. On the Engines page, select the checkbox for the engine that requires an upgrade.

  2. Click Upgrade Engine.

    When the upgrade finishes, the version appears in the Cortex XSOAR Version column. The upgrade procedure can take several minutes.

Upgrade an engine (non-shell installations)

If you didn't use the Shell installer, you need to remove the engine and do a fresh install.

  1. On the Engines page, locate the engine that requires an update.

  2. In the Download link, click relevant Download files.

  3. On the remote machine, do the following:

    When the upgrade finishes, the version appears in the Cortex XSOAR Version column. The upgrade procedure can take several minutes.

For troubleshooting, see Troubleshoot engines.

Note

By default, auto-upgrade extracts the files to the /tmp directory. In some cases, you might need to use a different directory. For example, a common use case is if your /tmp directory is mounted as a non-executable directory. To use a different directory, edit the XSOAR_ENGINE_AUTO_UPGRADE_TMP_DIR env variable. The env variable can be specified as a global variable or can be edited in the crontab of the root user that runs the engine upgrade script. To edit the crontab of root, run sudo crontab -e. For example:

# d1 engine
XSOAR_ENGINE_AUTO_UPGRADE_TMP_DIR=/root/tmp
PATH=/sbin:/bin:/usr/sbin:/usr/bin
* * * * * /usr/local/demisto/upgrade_engine.sh >> /var/log/demisto/demisto_install.log