Manage engines - Administrator Guide - Cortex XSIAM - Cortex - Security Operations

Cortex XSIAM Documentation
Product
Cortex XSIAM
Creation date
2024-03-06
Last date published
2024-04-25
Category
Administrator Guide
Abstract

Manage engines and load balancing groups.

You can manage your engines and load-balancing groups by going to Settings → Configurations → Engines.

You can view engine names, hosts, status, connection, and other engine information.

Note

You can do the following:

  • Add/remove engines to the load-balancing group.

    You can only add the engine to the load-balancing group after you have connected the engine.

  • Create load-balancing groups

    When selecting Load-Balancing Group → Add to new group, you can create multiple load-balancing groups and decide which engines are part of each group. It is useful to create separate load-balancing groups. For example,

    • Use separate load-balancing groups for different integrations and instances. Create Load-Balancing groups for certain tasks, which can help segregate the infrastructure of critical integrations.

    • Managed Security Service Providers may want to split internal engines and SaaS product engines.

    • If you have multiple AWS accounts that are not connected and do not want a single point of failure for AWS integrations that use STS.

    Users can move an engine from one group to another. A group will be deleted when the last engine is removed from it.

    Each engine can only belong to one group.

  • Get engine logs

    Logs are located in /var/log/demisto. For multiple engines, logs are located in /var/log/demisto/<name of the engine>. For example, var/log/demisto.d1_e1.

  • Upgrade an engine

    Whenever there is a Cortex XSIAM major version change or a change in server-engine protocol version, your engines require an upgrade. The Status column shows those engines that require upgrades.

    To upgrade the engine, select the checkbox for the engine that requires an upgrade and click Upgrade Engine. When the upgrade finishes, the version appears in the Cortex XSIAM Version. The upgrade procedure can take several minutes.

    You can only upgrade the engine if you installed the engine with the shell installer. To upgrade engines that were not installed with the shell installer, you need to remove the engine and do a fresh install. For more information, see Engine requirements. For troubleshooting, see Troubleshoot engine upgrades.

    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

  • Delete an engine