Server Configuration File

The server configuration csv file applies a set of configuration settings for each of the Cybereason servers. The server configuration file is used during the second stage of deployment, and allows for more advanced server configuration.

Download the appropriate server configuration CSV file for your environment from this page: Server Configuration Files. This page includes server configuration CSV files for:

  • Production environments

  • Production environments with lti(air-gap)

  • POC environments

The template includes the following fields.

Note

To enable binary fields, type TRUE. Blank values are not applied.

Field

Description

Required/Optional

Restrictions

hostname

The server name, for example: server-tr-1.

Required

The hostname field must include a maximum of 128 characters. In addition, this field must not include the following special characters:

  • %

  • &

  • *

  • $

  • #

  • @

  • !

  • \

  • /

  • :

  • ?

  • ‘’

  • <

  • >

  • |

  • ;

fqdn

The fully qualified domain name (FQDN) of the server, for example: company-tr-1.company-test.com.

Required

The FQDN must include a maximum of 255 characters.

ip

The server IP, for example: 1.1.1.1.

Required

netmask

The server netmask. For example: 255.255.255.0.

Required

gw

The server gateway. For example: 1.1.1.254.

Required

dns1

The DNS server IP. For example: 8.8.8.8.

Required

dns2

The second DNS server IP, if one exists. For example: 8.8.8.8.

Required

organization

A string including the organization name, for example: company.

Required

The organization name must include a minimum of 2 characters and a maximum of 23 characters. The organization name can include letters, numbers, and hyphens. Additional characters are not accepted.

probe_port

The sensor port (probe port) used to connect between the servers. For more details on communication between Cybereason On-Prem components, see Communication and Certificates.

Required

web_port

The web port used by the UI server.

Required

role

The type of Cybereason server. The information provided in this field is used to automatically apply Puppet configuration according to the role.

Values include:

  • web_app: The WebApp Server.

  • detection: The Detection Server.

  • registration: The Registration Server.

  • microservices: The SM Microservices server, which includes the set of microservices used by Cybereason.

  • ansible: The Configuration management server, used for configuration task automation.

Note

All values are case-sensitive.

Required

poc

Instructs Cybereason to deploy the installation in a limited POC configuration. Type FALSE for production deployments, or TRUE for POC deployments.

Required for POC setups only

Column should be deleted for production setup

airgap

Defines that the server is air gapped (physically isolated from an unsecured network). This field is relevant for the UI Server, and when used, instructs Cybereason to communicate with the Local Threat Intel Server instead of the Global Threat Intel Server. For more information, see Communication with Threat Intel services.

To define an air-gapped environment, leave this field blank at all times.

This allows communication with the Global Threat Intel Server.

Required

domain

The server domain, for example: server1.test.

Required

Starting from version 23.1, this column must be empty for both air-gapped and non air-gapped systems.

datastore

The name of the VM data store.

Required

customization

The name of the customization created previously, see Configure customization specification in VMWare.

Required

template

The name of the server template for each of the VMs (the template created when you deploy and configure the servers).

Required

vmhost

The name of the ESXi server in the cluster.

Required

The vmhost field must not include the following special characters:

  • %

  • &

  • *

  • $

  • #

  • @

  • !

  • \

  • /

  • :

  • ?

  • ‘’

  • <

  • >

  • |

  • ;

vmnetwork

The name of the VM network in the ESXi cluster.

Required

The vmnetwork field must not include the following special characters:

  • %

  • &

  • *

  • $

  • #

  • @

  • !

  • \

  • /

  • :

  • ?

  • ‘’

  • <

  • >

  • |

  • ;

cpusockets

The number of CPU sockets for this VM.

The number of CPU sockets multiplied by the number of CPU cores should be equal to the required vCPU for the VM. For example, if the total required vCPU is 8, you can configure 2 CPU sockets multiplied by 4 cores per socket (according to your hardware availability).

For example: 2.

Note

The vCPU requirements are determined according to various factors, see VM Resource Requirements (Production) or VM Resource Requirements (POC), or contact your Cybereason technical representative for more details.

Required

corespersocket

The number of cores per socket for this VM.

The number of CPU sockets multiplied by the number of CPU cores should be equal to the required vCPU for the VM. For example, if the total required vCPU is 8, you can configure 2 CPU sockets multiplied by 4 cores per socket (according to your hardware availability).

For example: 4.

Note

The vCPU requirements are determined according to various factors,see VM Resource Requirements (Production) or VM Resource Requirements (POC), or contact your Cybereason technical representative for more details.

Required