Shut down Cortex XSOAR - Shut down a session from the VM textual UI menu. - Administrator Guide - 8.5 - Cortex XSOAR - Cortex - Security Operations

Cortex XSOAR On-prem Documentation

Product
Cortex XSOAR
Version
8.5
Creation date
2024-03-10
Last date published
2025-12-17
End_of_Life
EoL
Category
Administrator Guide
Solution
On-prem
Abstract

Shut down a session from the VM textual UI menu.

You may need to shut down Cortex XSOAR in order to perform maintenance or troubleshooting activities.

You can gracefully shut down or reboot a cluster by selecting the Shutdown/Reboot menu item from the textual UI.

Important

  • Do not reboot Cortex XSOAR or do a hard shutdown if it is not working properly. Instead, download a log bundle and perform a graceful shutdown from the textual UI menu. Contact support or engineering for assistance.

  • When performing shutdown or reboot on any single node in a three-node cluster, at least two nodes must be online and in healthy status.

  • You must shut down or reboot one node at a time. Shutting down or rebooting two or more nodes at the same time is not possible and would possibly crash the app cluster.

  • Ensure one node has finished its complete boot-up sequence and is online and in healthy status before initiating shutdown on another node.

  • Before shutting down or rebooting a node, you must first drain it to ensure the node stops accepting new work before going offline.

Perform graceful shutdown (one node at a time)
  1. Drain the node you want to shut down.

    1. From the textual UI menu in your VM, select Cluster Administration.

    2. Select the IP address of the node you want to drain.

    3. Select Drain.

      In the list of nodes in the Cluster Administration menu, the node IP will display as Ready,SchedulingDisabled.

  2. Shut down the node.

    1. From the textual UI menu in your VM, select Shutdown/RebootShutdown.

    2. Wait for the node to completely shut down.

Perform graceful reboot (one node at a time)
  1. Drain the node you want to reboot.

    1. From the textual UI menu in your VM, select Cluster Administration.

    2. Select the IP address of the node you want to drain.

    3. Select Drain.

      In the list of nodes in the Cluster Administration menu, the node IP will display as Ready,Schedulable.

  2. Reboot the node.

    1. From the textual UI menu in your VM, select Shutdown/RebootReboot.

    2. Wait for the node to completely restart.

Monitor node status before and after shutdown or reboot

Before initiating a graceful shutdown or reboot, you can use the textual UI menu in the VM to check the node list under Cluster Administration. A node is considered safe to shut down/reboot only after it has been successfully drained, changing its status to Ready,SchedulingDisabled. For more information, see Manage nodes in a cluster.

After shutdown or reboot, you can check the node's health and status from the System Diagnostics page, where the Active Nodes Snapshot widget lists all nodes and their status (for example, Connected or Disconnected). For more information, see View system status in the System Diagnostics page. You must confirm the node has finished its complete boot-up sequence and is online and in healthy status before acting on another node.View system status in the System Diagnostics page