About the bdd-admin script

You can use the bdd-admin script to perform a number of administrative tasks for the BDD cluster from the command line.

The bdd-admin script must be run from the Admin Server by a user who has passwordless sudo enabled on all nodes in the cluster. The script is located in the $BDD_HOME/BDD_manager/bin directory.

The script has the following syntax:

./bdd-admin.sh <command> [component] <option>

The following sections describe the commands, components, and options the bdd-admin script supports.

Commands

The command argument determines the action the script will perform. This argument is required. The following table describes the commands the bdd-admin script supports.

Command	Description
`refresh-config`	Updates the configuration for all nodes in the cluster by copying a modified version of the configuration file from the Admin Server to every other node.
`autostart`	Enables and disables automatic restart for the specified services.
`start`	Starts the specified services if they are not already running.
`stop`	Stops the specified services if they are running.
`restart`	Restarts the specified services.
`status`	Returns the status of the specified services.
`dgraph-admin`	Performs administrative operations for the Dgraph. For more information, see Dgraph administrative operations.
`update-model`	Not supported. Updates the models used by Data Enrichment modules, or reverts all changes made to the models.

Components

The component argument enables you to run the script on a specific service. This argument is optional. If you omit it, the script will run on all services.

Note: Some commands do not accept all of the following component arguments, and some don't allow you to specify a component at all.

Component	Description
`--dgraph`	Runs the script on the Dgraph only. Note that running some commands on the Dgraph will also have an effect on the HDFS Agent.
`--agent`	Runs the script on the HDFS Agent only.
`--bddServer`	Runs the script on Studio and the Dgraph Gateway.

Options

The option argument specifies the node(s) the script will run on. This argument is required.

Note: Some commands can only be run on all nodes and therefore don't accept the option argument.

Option	Description
`--all`	Runs the script on all BDD nodes in the cluster.
`<hostname>`	Runs the script on the specified node. You must provide the node's fully qualified hostname; for example, `web009.us.example.com`. Additionally, the name you provide must match one defined in the `<COMPONENT>_SERVERS` property for the service(s) the script will run on. For example, if you run the script with the `--dgraph` component argument, the hostname you provide must match a hostname listed in the `DGRAPH_SERVERS` property.

Option

Description

--all

Runs the script on all BDD nodes in the cluster.

<hostname>

Runs the script on the specified node. You must provide the node's fully qualified hostname; for example, web009.us.example.com.

Additionally, the name you provide must match one defined in the <COMPONENT>_SERVERS property for the service(s) the script will run on. For example, if you run the script with the --dgraph component argument, the hostname you provide must match a hostname listed in the DGRAPH_SERVERS property.

bdd-admin script help

You can obtain usage information for the bdd-admin script and its commands by running it with the --help flag:

./bdd-admin.sh --help

For information on a specific command, provide the command's name after the --help flag:

./bdd-admin.sh --help refresh-config