Using the hadbm Command

The hadbm command is the command-line interface used to manage the HADB domain and its database instances. This hadbm command-line interface is located in the install_dir/SUNWhadb/4/bin directory by default. The hadbm sends management requests to the specified management agent. The database configuration information is available to the management agent from the repository.

The commands to administer HADB are subcommands of the hadbm command. The general syntax is as follows:

hadbm subcommand [-short-form [argument]]* [--long-form [argument]]* [dbname]

For example, the following is one use of the hadbm status subcommand, which checks the status of HADB:

hadbm status --nodes

The subcommand identifies the operation or task to perform. Subcommands are case-sensitive.

Command options are also case-sensitive. Each option has a long form and a short form. Short forms have a single dash (-); while long forms have two dashes (--). Options modify how hadbm performs a subcommand. Most options require argument values, except for boolean options, which must be present to switch a feature on. Options are enclosed in square brackets [ ]and are not required for successful execution of the command.

For subcommands that take a database name, if a database is not identified, the default database is used. The default database is hadb, all lowercase.

For enhanced security, set the password for a subcommand from a file instead of entering the password at the command line. The --dbpasswordfile option takes the file containing the passwords. The valid contents for the file are:

HADBM_DBPASSWORD=password

The rest of the contents of the file are ignored. If both the --dbpassword and --dbpasswordfile options are specified, the --dbpassword takes precedence. If a password is required, but is not specified in the command, you are prompted for a password.

The hadbm general command options, used with any hadbm subcommand, are listed in the following table. All are booleans that are not present by default.

Table 0-1  hadbm General Options 

Long Form

Short Form

Description

--quiet

-q

Executes the subcommand silently without any descriptive messages.

--help

-?

Displays a brief description of this command and all the supported subcommands. No subcommand is required.

--version

-V

Displays the version details of the hadbm command. No subcommand is required.

--yes

-y

Executes the subcommand in non-interactive mode.

--force

-f

Executes the command non-interactively and does not throw an error if the command’s post condition is already achieved.

--echo

-e

Displays the subcommand with all the options and their user-defined values or the default values, then executes the subcommand.


Legal Notices