How to Install VMware Carbon Black Cloud Endpoint

Summary: Learn about how to install the VMware Carbon Black Cloud Endpoint sensor on a computer using these instructions for Windows, Mac, and Linux.

This article applies to This article does not apply to This article is not tied to any specific product. Not all product versions are identified in this article.
Check out other resources

Symptoms

This article discusses the installation process for the VMware Carbon Black Cloud Endpoint sensor.

Affected Products:

  • VMware Carbon Black Cloud Endpoint

Affected Operating Systems:

  • Windows
  • Mac
  • Linux

Cause

Not applicable

Resolution

Note: Before installation, ensure that system requirements are validated. For more information, reference VMware Carbon Black Cloud Endpoint Sensor System Requirements.

VMware Carbon Black Onboarding Part 2: System Requirements, Download, and Install

Duration: 03:00
Closed captions: Available in multiple languages

For steps on installing VMware Carbon Black Cloud Endpoint, click on Windows, Mac, or Linux.

Windows

VMware Carbon Black Cloud Endpoint can be installed on Windows through the:

  • User interface (UI)
  • Command-line interface (CLI)

Click the preferred method for more information.

  1. Double-click installer_vista_win7_win8_[BIT]_[VERSION].msi.

VMware Carbon Black Cloud installer

Note:
  1. In the Setup UI, click Next.

Setup UI

  1. Accept the terms in the License Agreement and then click Next.

End-User License Agreement

  1. Populate the activation code and then click Install.

Populating an activation code

Note:
  1. If User Account Control (UAC) is enabled, click Yes. Otherwise, go to Step 6.

User Account Control prompt

  1. Click Finish.

Completed installation

Note:
 
Switch Required Purpose
/i Yes Installs the product.
/passive No The installer shows a minimal UI with no prompts.
/q Yes Suppresses UI and prompts.
/L* No Creates an .msi install log file.
/L*vx No Creates a verbose .msi install log file. This is recommended over /L* for troubleshooting.


 

Parameter Value Required Purpose
AUTO_UPDATE= 0 No Disables auto update.
1 (Default) Enables auto update from VMware Carbon Black Cloud.
BACKGROUND_SCAN= 0 No Disables background scan from running on a device.
1 (Default) Enables background scan from running on a device.
BASE_IMAGE= 0 (Default) No Default operation for basic installation.
1 Used to create base images for cloning. This option is not supported for VDI.
BYPASS= 0 (Default) No Sends active communication to the cloud.
1 Sets the sensor in bypass mode. Bypass mode does not send any data to the cloud. Used for interoperability testing.
CBLR_KILL= 0 (Default) No Enables Live Response functionality.
1 Disables Live Response functionality.
CLI_USERS= See Examples No Identifies the activation code that is associated with the hostname. Only used with Directory User Integration.
COMPANY_CODE= See Examples Yes Ties the sensor to the VMware Carbon Black Cloud console. Enclose the code in double quotation marks.
CONNECT_LIMIT= See Examples No Limits the number of connections per hour. Default is no limit.
DELAY_SIG_DOWNLOAD= 0 No Immediately download signature definitions.
1 (Default) Delay signature definition downloads. Recommended to use when in production.
FILE_UPLOAD_LIMIT= See Examples No 4-byte integer representing MB. Example: A value of 3 is a limit of 3*1024*1024 bytes. The default value is 5.
GROUP_NAME= See Examples No Method to assign the device to a specific policy aside from automatic assignment. Enclose with double quotes if the policy name includes spaces.
HIDE_COMMAND_LINES= 0 (Default) No Shows command-line inputs.
1 Obfuscates command-line inputs.
LAST_ATTEMPT_PROXY_SERVER= See Examples No Sensor attempts cloud access by using this value as a failover when all other methods fail.
LEARNING_MODE= See Examples No Value is the number of hours after sensor install to limit event types. This parameter reduces the load on the backend and reduces reporting.
PROXY_PASSWD= See Examples No Password to use with PROXY_USER.
PROXY_SERVER= See Examples No IP Address or FQDN for Proxy Server. Format: Server.domain.com:PortNumber
PROXY_USER= See Examples No User credential for PROXY_SERVER.
QUEUE_SIZE= See Examples No Limits the event backlog in MB. The default value is 100 MB. This option does not include SSL overhead.
RATE_LIMIT= See Examples No Limits the amount of data transfer (KB) per hour. Default is no limit.
VDI= 0 (Default) No Standard deployment method.
1 Configured required for VDI deployments.
USER_EMAIL= See Examples No Email address that is tied to a specific sensor.

CLI Installation Examples:

Note:
  • The examples may differ in your environment.
  • [VERSION] = Version of the VMware Carbon Black Cloud Endpoint sensor.

Example #1

msiexec /q /i installer_vista_win7_win8-64-3.4.0.1091.msi /L* COMPANY_CODE="ABCD1234#EFGH56789@IJKLM" AUTO_UPDATE=0 GROUP_NAME=Accounting BASE_IMAGE=1

Example #1 contains:

  • Installer = installer_vista_win7_win8-64-3.4.0.1091.msi
  • Bit = 64 bit
  • Version=3.4.0.1091
  • MSI Logging = Yes
  • MSI Location= %Temp%
    • Default value since not defined
  • Company Code = ABCD1234#EFGH56789@IJKLM
  • Auto update enabled= No
  • Base Image = Yes
  • Bypass mode = No
    • Default value since not defined
  • Group assigned = Accounting
  • Proxy Server = None
    • Default value since not defined
  • Live Response functionality= Enabled
    • Default value since not defined
  • Learning mode= No
    • Default value since not defined
  • Rate limit= No limit
    • Default value since not defined
  • File upload limit= 5.2 MB
    • Default value since not defined

Example #2

msiexec /q /i installer_vista_win7_win8-32-3.4.0.1091.msi /L*vx "C:\CBInstall.txt" COMPANY_CODE="ABCD1234#EFGH56789@IJKLM" BYPASS=1 PROXY_Server="server.domain.com" PROXY_USER=example@domain.com PROXY_PASSWD="P@55w0rd" LEARNING_MODE=48 CBLR_KILL=1 RATE_LIMIT=2088

Example #2 contains:

  • Installer = installer_vista_win7_win8-64-3.4.0.1091.msi
  • Bit = 64 bit
  • Version=3.4.0.1091
  • MSI Logging = Yes with verbosity enabled
  • MSI Location= C:\CBInstall.txt
  • Company Code = ABCD1234#EFGH56789@IJKLM
  • Auto update enabled= Yes
    • Default value since not defined
  • Base Image = No
    • Default value since not defined
  • Bypass mode = No
    • Default value since not defined
  • Group assigned = None specified.
    • Default value since not defined
    • Device is assigned based on auto-assignment cloud settings.
  • Proxy server = server.domain.com
    • Proxy user = example@domain.com
    • Proxy user password = P@55w0rd
  • Live Response functionality= Disabled
  • Learning Mode= 48 hours
  • Rate limit= 2088 KB (2 MB) /per hour.
  • File upload limit= 5.2 MB
    • Default value since not defined

Mac

VMware Carbon Black Cloud Endpoint can be installed on Mac through the:

  • User interface (UI)

Click the appropriate method for more information.

  1. Double-click confer_installer_mac-[VERSION].dmg.

VMware Carbon Black Cloud macOS installer

Note:
  1. Double-click CbDefenseInstall.pkg.

CbDefense Install

  1. Click Continue.

Determining if software can be installed

  1. Click Continue.

Introduction

  1. Review the end user license agreement (EULA) and then click Continue.

License

  1. Agree to the EULA.

Agreeing to the software license agreement

  1. Populate the install code and then click Continue.

Device Registration

Note:
  1. Click Install.

Installation type

  1. Populate an administrator’s User Name and Password. Once populated, click Install Software.

Populating administrator credentials

  1. On installation, click Close.

Summary

Warning:

Linux

VMware Carbon Black Cloud Endpoint can be installed on Linux through the:

  • User interface (UI)

Click the appropriate method for more information.

  1. Open Terminal.

Terminal

  1. In Terminal, type sudo tar –xvf'/FilePathA/cb-psc-sensor.tgz ' –C /FilePathB and then press Enter.

Extracting the file

Note:
  • In the above example:
    • FilePathA is the path where the tar.gz exists.
      • FilePathA example = /home/administrator/Downloads/
    • FilePathB is the path where the tar.gz is being extracted.
      • FilePathB example = /home/administrator/Desktop/cb
  • To obtain cb-psc-sensor.tgz, reference How to Download the VMware Carbon Black Cloud Endpoint Sensor.
  • Commands are case-sensitive.
  • The example paths may differ in your environment.
  1. Populate the password for the account being used and then press Enter.

Password prompt

  1. Type sudo 'filepath/install.sh' [COMPANYCODE] into Terminal and then press Enter.

Running the installer

Note:
  1. Populate the password for the account being used and then press Enter.

Password prompt

  1. Type exit and then press Enter.

Exit

To contact support, reference Dell Data Security International Support Phone Numbers.
Go to TechDirect to generate a technical support request online.
For additional insights and resources, join the Dell Security Community Forum.

 

Affected Products

VMware Carbon Black
Article Properties
Article Number: 000126331
Article Type: Solution
Last Modified: 24 Jan 2024
Version:  15
Find answers to your questions from other Dell users
Support Services
Check if your device is covered by Support Services.