VMware Carbon Black provides diagnostic tools and scripts for each supported platform. You can easily collect the information most commonly required for troubleshooting.
After gathering the diagnostic file, send it to Red Canary by clicking on your account and choosing Share a File.
Gathering diagnostics on Windows
To gather diagnostics for sensor versions 6.2.1 and below:
- Obtain the diagnostic tool via the official VMware Carbon Black Community, or have it sent to you by creating a Red Canary support case.
- Gather diagnostics by extracting the package and executing the binary with administrative privileges.
- When prompted, press 0 to begin. It may take up to 10 minutes to complete the process.
Once complete, a new archive will be created in the local folder where you saved the diagnostic tool and will be named for the time of generation, e.g., 2020-09-01_07_23_45.diag.gz
.
To gather diagnostics for sensor versions 6.2.2 and above:
Note: .NET 4.5 or higher needs to be installed for this tool to work.
- Open a command prompt as administrator.
- Change directory to C:\Windows\CarbonBlack
- Run the diagnostic tool by running the following command:
Sensordiag.exe -type CDE
- Collect the output file at C:\Windows\CarbonBlack\diags\<filename>.zip
To gather diagnostics remotely via a Live Response session:
- Open a Live Response session with the endpoint.
- Put the diagnostic package in the desired remote directory and run the following command:
Execfg CbDiag.exe --tar
- Use the get command to obtain the resulting diagnostic package.
Gathering diagnostics on Linux
To execute the diagnostic script:
- Run the following command in a terminal session as root:
Sensor version 6.1.x
opt/cbsensor/sensordiag.sh
Sensor version 6.2.x
opt/carbonblack/response/bin/sensordiag.sh
- When complete, the diagnostic package will be created in the local working directory named as such:
sensordiag_<Hostname>_<SensorVersion>_<TimeStamp>.tgz
Gathering diagnostics on macOS
To gather diagnostics for sensor versions 6.1.9 and below:
-
Navigate to the Carbon Black directory.
- Open Terminal and change to the Carbon Black installation directory:
cd /Applications/CarbonBlack/
- Execute the diagnostic script. The script requires elevated permissions to gather certain files:
sudo ./sensordiag.sh
- The diagnostic package will be created in the current working directory, named using the following convention:
sensordiag_<Hostname>_<SensorVersion>_<TimeStamp>.zip
To gather diagnostics for sensor versions 6.2.x-6.3.0:
- Navigate to the Carbon Black directory.
- Open Terminal and run the following command:
sudo /Applications/CarbonBlack/sensordiag -type CDE
- Optionally, gather logs from a specified date and later:
sudo /Applications/CarbonBlack/sensordiag -type CDE -startdate 2018-06-29
To gather diagnostics for sensor versions 7.0 and above:
Note: Spaces in macOS directory names need to be preceded by a "\".
- Navigate to the Carbon Black directory.
- Open Terminal and run the following command:
sudo /Applications/VMware\ Carbon\ Black\ EDR.app/Contents/Helpers/sensordiag -type CDE
- Optionally, gather logs from a specified date and later:
sudo /Applications/VMware\ Carbon\ Black\ EDR.app/Contents/Helpers/sensordiag -type CDE -startdate 2018-06-29
The diagnostic package will be created in the current working directory, named using the following convention: sensordiag_<Hostname>_<SensorVersion>_<TimeStamp>.zip
To gather diagnostics remotely via Live Response:
- Open a Live Response session with the endpoint.
- Run the command for your sensor version, for example:
execfg /Applications/CarbonBlack/sensordiag -type CDE
- Use the
get
command to obtain the resulting diagnostic package.