About the bdd-admin script

The bdd-admin script includes a number of commands that perform different administrative tasks for your cluster, like starting components and updating BDD's configuration. The script is located in the $BDD_HOME/BDD_manager/bin directory.

Important: bdd-admin can only be run from the Admin Server by the bdd user. This user must have the following:
  • Passwordless sudo enabled on all nodes in the cluster
  • The same UID on all nodes in the cluster
bdd-admin has the following syntax: 
./bdd-admin.sh <command> [options]
When you run the script, you must specify a command. This determines the operation it will perform. You can't specify multiple commands at once, and you must wait for a command to complete before running it a second time. Additionally, you can't run the following commands at the same time: For example, if you run stop, you can't run start until all components have been stopped.

You can also include any of the specified command's supported options to further control the script's behavior. For example, you can run most commands on all nodes or one or more specific ones. The options each command supports are described later in this chapter.

The commands bdd-admin supports are described below.

Lifecycle management commands

bdd-admin supports the following lifecycle management commands.

Command Description
start Starts components.
stop Stops components.
restart Restarts components.

System management commands

bdd-admin supports the following system management commands.

Command Description
autostart Enables/disables autostart for components. Components that have autostart enabled will automatically restart after their hosts are rebooted.
backup Backs up your cluster's data and metadata to a single tar file.
restore Restores your cluster's data and metadata from a backup tar file.
publish-config Publishes updated BDD, Hadoop, and Kerberos configuration to all BDD nodes. Can also be used to refresh TLS/SSL certificates on secured Hadoop clusters.
update-model Either updates the model files for Data Enrichment modules, or restores them to their original states.
flush Flushes component caches.
reshape-nodes Adds or removes Data Processing nodes from your BDD cluster.
enable-components For use by Oracle Support, only. Enables components that are currently disabled.
disable-components For use by Oracle Support, only. Disables components that are currently enabled.

Diagnostics commands

bdd-admin supports the following diagnostics commands.

Command Description
get-blackbox Generates the Dgraph's on-demand tracing blackbox file and returns its name and location. This command is intended for use by Oracle Support only.
status Returns either component statuses or the overall health of the cluster.
get-stats Returns component statistics. This command is intended for use by Oracle Support only.
reset-stats Resets component statistics. This command is intended for use by Oracle Support only.
get-log-levels Outputs the current levels of component logs.
set-log-levels Sets the log levels for components and subsystems.
get-logs Generates a zip file of component logs. This command is intended for use by Oracle Support only.
rotate-logs Rotates component logs. This command is intended for use by Oracle Support only.

Global options

bdd-admin supports the following global options. You can include these with any command, or without a command.

Command Description
--help Prints the usage information for the bdd-admin script and its commands.
--version Prints version information for your BDD installation.
For example, to view the usage for the entire bdd-admin script, run: 
./bdd-admin.sh --help
To view the usage for a specific command, run the command with the --help flag: 
./bdd-admin.sh <command> --help
For the version number of your BDD installation, run: 
./bdd-admin.sh --version