For the complete documentation index, see llms.txt. This page is also available as Markdown.
Cortex XSOAR 6.14Cortex XSOAR6.14InstallationCortex XSOAR 6.x

Elasticsearch Installation

Install Cortex XSOAR 6.14 on a single server with Elasticsearch.

The following provides instructions for installing a new Cortex XSOAR environment with Elasticsearch.

Prerequisites for Installing Cortex XSOAR with Elasticsearch

Verify the following information and requirements before you install Cortex XSOAR with Elasticsearch.

  • A Customer Support Portal (CSP) account. Set up your CSP account. For more information, see How to Create Your CSP User Account. When you create a CSP account, you can set up two-factor authentication (2FA) to log into the CSP by using an Email, Okta Verify, or Google Authenticator (non-FedRAMP accounts). For more information, see How to Enable a Third Party IdP.

  • Have the following roles assigned:

    Role
    Details

    CSP role

    The Super User role is assigned to your CSP account. The user who creates the CSP account is granted the Super User role.

    Cortex role

    If you are the first user to access Cortex Gateway with the CSP Super User role, you are automatically granted Account Admin permissions for the Cortex Gateway. You can also add Account Admin users as required.

    After creating the CSP account, log in to the Cortex Gateway to download the relevant image file and license.

    Downloading an image file from Cortex Gateway ensures you have the latest pre-configured software package for easy deployment and updates.

    If you have multiple or development tenants, you must repeat these tasks for each tenant.

    To download the Cortex XSOAR images from Cortex Gateway, you need a license (or evaluation license through sales) assigned to your CSP account.

  • Your deployment meets the Elasticsearch System Requirements.

  • You have root access.

  • Elasticsearch is installed. Elasticsearch should not be installed on the same server as Cortex XSOAR.

  • The production server has Python 2.7 or 3.x.

  • If you are installing on an Oracle Linux operating system, you need to manually Install Docker.

If you are deploying a signed installer, you need to import the public key to the operating system. The public key is valid for six months.

It is recommended to install the Elasticsearch Monitoring content pack from the Marketplace to monitor Elasticsearch. After installation, add the Elasticsearch Monitoring dashboard, which includes various widgets to monitor Elasticsearch cluster status and track statistics.

Installation File Structure

By default, the .sh file is in /home/<user-name>. The .sh file installs the demistoserver_xxxxx.amd64.deb file in the /usr/local/demisto folder. You can change the default folder, if necessary.

For information about the default installation file structure, see Installation File Structure.

Install Cortex XSOAR with Elasticsearch

1

Download the installation package and license

  1. Log in to Cortex Gateway.

  2. In the Available for Activation section, use the serial number to locate the tenant to download.

    By default, the Production-Standalone license is selected. You can also select Dev.

    If you want to use a production and a development tenant with a private remote repository, select Dev. If you don't select it now, you can install a development tenant later.

  3. Select Download On Prem.

  4. Click Next.

  5. Under Choose Download Option, select Installer.

  6. Select the checkbox to agree to the terms and conditions of the license and click Download.

    In Google Chrome, to download the image and license files together, you may need to set the browser Settings → Privacy and security → Site settings → Additional permissions → Automatic downloads to the default behavior Sites can ask to automatically download multiple files.

    Two files download: the demistoserver-xxxxx.sh installer file and a zipped JSON license file.

    You can copy the download link button from the Downloads section in your browser to get the token needed for offline installation.

  7. (Optional) If you are deploying Cortex XSOAR using a signed installer (GPG), you need to import the GPG public key that was provided with the signed installer. Open a ticket with Palo Alto Networks support to get the public key (see here).

    For example, you can use the rpm --import public.key command to import the public key into the local GPG keyring. Note that each operating system has specific requirements.

  8. (Optional) If you are deploying Cortex XSOAR using a signed installer (GPG) you might need to manually install the makeself package by running the yum install makeself command.

2

Make the server package executable

Run the chmod +x demisto.sh command to convert the .sh file to an executable file.

3

Run the installer

  1. Install the app server with Elasticsearch by running one of the following commands:

  • If using username and password authentication: sudo ./demisto.sh -- -elasticsearch-url=<elastic search url address> -elasticsearch-username=<the elasticsearch user name> -elasticsearch-password=<the elasticsearch password>

  • If using API key authentication: sudo ./demisto.sh -- -elasticsearch-url=<elastic search url address> -elasticsearch-api-key=<the elasticsearch API key>

Use the following flags:

Flag
Type
Description

-elasticsearch-url

String

Elasticsearch URL addresses (comma-separated). For example, http://test1:9200,http://test2:9200

-elasticsearch-api-key

String

The Elasticsearch API key, which should be used in licensed versions.

Note: If you use this flag, you do not need to use the -elasticsearch-username and -elasticsearch-password flags.

-elasticsearch-username

String

The Elasticsearch username. This flag is used with the -elasticsearch-password flag.

Note: If you use this flag, you do not need to use the -elasticsearch-api-key flag.

-elasticsearch-password

String

The Elasticsearch password. This flag is used with the -elasticsearch-username flag.

Note: If you use this flag, you do not need to use the -elasticsearch-api-key flag.

-elasticsearch-proxy=

Boolean

Whether to use a proxy when communicating with Elasticsearch. Can be true or false. Default is false.

-elasticsearch-insecure=

Boolean

Whether to trust any certificate when communicating with Elasticsearch. Can be true or false. Default is false.

-elasticsearch-timeout

Integer

The amount of time (in seconds) before Elasticsearch times out. Default is 20 seconds.

  1. Accept the EULA and add the information when prompted.

  2. The Server HTTPS port (default is 443)

  3. Enter the Elasticsearch details, such as the URL, timeout, etc.

  4. Type the name of the Admin user (default is admin).

  5. Type the password (default is admin).

4

Verify the installation

( Optional) After the installation has completed, do the following:

  1. Confirm that the Cortex XSOAR server status is active, by running the systemctl status demisto command.

    If the server is not active, run the systemctl start demisto command to start the server.

  2. Confirm that the Docker service status is active, by running the systemctl status docker command.

  3. In a web browser, go to the https://serverURL:port to verify that Cortex XSOAR was successfully installed.

    When you open Cortex XSOAR for the first time, you need to add the license.

5

Add the license

After the installation is complete, activate the license.

  1. Log in to the Cortex XSOAR server.

  2. Upload the license file that you downloaded from the Cortex Gateway in Step 1.

Last updated

Was this helpful?