Carbon Black EDR Unified View command line tools enable console users who have Sudo privileges to perform tasks on the command line instead of in the console or through an API.

The following tools are located in /usr/share/cb:

  • cbuser – Manages users for both Carbon Black EDR Unified View server and Carbon Black EDR clusters.

  • cbuv-cluster – Manages clusters for Carbon Black EDR Unified View.

To see all options for a command, enter the command together with the commands option. For example:

cbuser commands

User Commands

For user-specific commands, enter cbuser plus one of the following options:

Options

Description

get

Queries and displays information about the specified user:

  • Username: -u / --username

or

  • User ID: -i / --id

list

Lists all users in the Carbon Black EDR Unified View server.

delete

Deletes the specified Carbon Black EDR Unified View user:

  • Username: -u / --username

or

  • User ID: -i / --id

add

Adds a new user as specified by the following arguments.

Required:

  • Username: -u / --username

  • First name: -f / --first_name

  • Last name: -l / --last_name

Optional:

  • Set password: -p / --password .

  • If no password is set, the user is prompted for a password.

  • Create as Carbon Black EDR Unified View global administrator: -g / --is_admin

set

Changes information about the user.

Name options:

  • Username: -u / --username

  • First name: -f / --first_name

  • Last name: -l / --last_name

Admin options:

  • Set as global administrator: -g / --set_admin

or

  • Remove as administrator: -r / --remove_admin

Password options:

  • Set new password: -p / --password

or

  • Prompt for password: -P / --prompt_password

Example:

cbuser add -u jane_doe -f jane -l doe -p password -g

This command adds the user Jane Doe as an administrator to the user store using the specified password .

Cluster Commands

To perform cluster-specific tasks from the command line, enter the command cbuv-cluster followed by an option:

Options

Description

get

Queries and displays configuration information about the specified cluster:

  • Cluster name: -c / --cluster_name

or

  • Cluster ID: -i / --id

list

Lists all the clusters in the Carbon Black EDR Unified View server.

delete

Deletes the specified cluster:

  • Cluster name: -c / --cluster_name

or

  • Cluster ID: -i / --id

add

Adds a new cluster to Carbon Black EDR Unified View.

Required arguments:

  • Cluster name: -c / --cluster_name

  • URL: -u, --url

Optional arguments:

  • Description: -d / --cluster_desc.

  • Enable SSL verification: -v / --verify_ssl

  • Specify shared token: -s / --shared_token .

  • Use proxy: -P/ --use_proxy
  • Proxy URL: -r/ --proxy_url
  • Proxy port: -p/ --proxy_port

  • If the token type for the cluster is shared, the user is prompted for the API token.

set

Changes information about a specified cluster in the Carbon Black EDR Unified View:

  • Cluster name: -c / --cluster_name

or

  • Cluster ID: -i / --id

  • URL: -u, --url

  • Description: -d / --cluster_desc

  • Token type: -t / --token_type , where token_type is either individual or shared .

  • Enable the cluster: -e / --enable

or

  • Disable the cluster: -d / --disable

  • Enable SSL verification: -v / --verifiy_ssl

or

  • Disable SSL verification: -n / --no_verify_ssl

    or

  • Use proxy: -P/ --use_proxy
  • Proxy URL: -r/ --proxy_url
  • Proxy port: -p/ --proxy_port

    or

  • Don’t use proxy: -N/ --no_use_proxy

Example:

cbuv-cluster get -c acme

Retrieves and displays configuration information about the cluster named acme.