Using the Administration Tools

The Vertica Administration tools allow you to easily perform administrative tasks. You can perform most Vertica database administration tasks with Administration Tools.

Run Administration Tools using the Database Administrator account on the Administration host, if possible. Make sure that no other Administration Tools processes are running.

If the Administration host is unresponsive, run Administration Tools on a different node in the cluster. That node permanently takes over the role of Administration host.

Any user can view the man page available for admintools. Enter the following:

man admintools

Running Administration Tools

As dbadmin user, you can run administration tools. The syntax follows:

/opt/vertica/bin/admintools [--debug ][
     { -h | --help }
   | { -a | --help_all} 
   | { -t | --tool } name_of_tool[ options] 
]

Options

--debug

If you include the debug option, Vertica logs debug information.

Note: You can specify the debug option with or without naming a specific tool. If you specify debug with a specific tool, Vertica logs debug information during tool execution. If you do not specify a tool, Vertica logs debug information when you run tools through the admintools user interface.

-h
--help
Outputs abbreviated help.
-a
--help_all
Outputs verbose help, which lists all command-line sub-commands and options.
{ ‑t | ‑‑tool } name_of_tool [options]

Specifies the tool to run, where name_of_tool is one of the tools described in the help output, and options are one or more comma-delimited tool arguments.

Note: Enter admintools -h to see the list of tools available. Enter admintools -t name_of_tool --help to review a specific tool's options.

An unqualified admintools command displays the Main Menu dialog box.

Admin Tools screen

If you are unfamiliar with this type of interface, read Using the Administration Tools Interface

First Login as Database Administrator

The first time you log in as the Database Administrator and run the Administration Tools, the user interface displays.

  1. In the end-user license agreement (EULA ) window, type accept to proceed.

    A window displays, requesting the location of the license key file you downloaded from the OpenText Web site. The default path is /tmp/vlicense.dat.

  2. Type the absolute path to your license key (for example, /tmp/vlicense.dat) and click OK.

Between Dialogs

While the Administration Tools are working, you see the command line processing in a window similar to the one shown below. Do not interrupt the processing.