Writing Administration Tools Scripts
You can invoke most Administration Tools from the command line or a shell script.
Syntax
/opt/vertica/bin/admintools { { -h | --help } | { -a | --help_all} | { [--debug ] { -t | --tool } toolname [ tool-args ] }
}
Note: For convenience, add /opt/vertica/bin
to your search path.
Parameters
-h
-help
|
Outputs abbreviated help. |
-a
-help_all
|
Outputs verbose help, which lists all command-line sub-commands and options. |
[debug] { ‑t | ‑tool }toolname [args]
|
Specifies the tool to run, where toolname is one of the tools listed in the help output described below, and args is one or more comma-delimited toolname arguments. If you include the debug option, Vertica logs debug information during tool execution. |
Tools
To return a list of all available tools, enter admintools -h
at a command prompt.
Note: To create a database or password, see Creating a Database Name and Password for naming rules.
To display help for a specific tool and its options or commands, qualify the specified tool name with --help
or -h
, as shown in the example below:
$ admintools -t connect_db --help Usage: connect_db [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to connect -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes
To list all available tools and their commands and options in individual help text, enter admintools -a
.
$ admintools -a Usage: adminTools [-t | --tool] toolName [options] Valid tools are: command_host connect_db create_db database_parameters db_add_node db_remove_node db_replace_node db_status distribute_config_files drop_db host_to_node install_package install_procedure kill_host kill_node license_audit list_allnodes list_db list_host list_node list_packages logrotate node_map rebalance_data restart_db restart_node return_epoch set_restart_policy set_ssl_params show_active_db start_db stop_db stop_host stop_node uninstall_package upgrade_license_key view_cluster ------------------------------------------------------------------------- Usage: command_host [options] Options: -h, --help show this help message and exit -c CMD, --command=CMD Command to run ------------------------------------------------------------------------- Usage: connect_db [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to connect -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes ------------------------------------------------------------------------- Usage: create_db [options] Options: -h, --help show this help message and exit -D DATA, --data_path=DATA Path of data directory[optional] if not using compat21 -c CATALOG, --catalog_path=CATALOG Path of catalog directory[optional] if not using compat21 --compat21 (deprecated) Use Vertica 2.1 method using node names instead of hostnames -d DB, --database=DB Name of database to be created -l LICENSEFILE, --license=LICENSEFILE Database license [optional] -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes [optional] -P POLICY, --policy=POLICY Database restart policy [optional] -s NODES, --hosts=NODES comma-separated list of hosts to participate in database --skip-fs-checks Skip file system checks while creating a database (not recommended). ------------------------------------------------------------------------- Usage: database_parameters [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database -P PARAMETER, --parameter=PARAMETER Database parameter -c COMPONENT, --component=COMPONENT Component[optional] -s SUBCOMPONENT, --subcomponent=SUBCOMPONENT Sub Component[optional] -p PASSWORD, --password=PASSWORD Database password[optional] ------------------------------------------------------------------------- Usage: db_add_node [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to be restarted -s HOSTS, --hosts=HOSTS Comma separated list of hosts to add to database -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes -a AHOSTS, --add=AHOSTS Comma separated list of hosts to add to database -i, --noprompts do not stop and wait for user input(default false) --compat21 (deprecated) Use Vertica 2.1 method using node names instead of hostnames --skip-fs-checks Skip file system checks while adding nodes (not recommended). ------------------------------------------------------------------------- Usage: db_remove_node [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to be modified -s HOSTS, --hosts=HOSTS Name of the host to remove from the db -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes -i, --noprompts do not stop and wait for user input (default false) --compat21 (deprecated) Use Vertica 2.1 method using node names instead of hostnames ------------------------------------------------------------------------- Usage: db_replace_node [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to be restarted -o ORIGINAL, --original=ORIGINAL Name of host you wish to replace -n NEWHOST, --new=NEWHOST Name of the replacement host -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes -i, --noprompts do not stop and wait for user input(default false) --skip-fs-checks Skip file system checks while replacing nodes (not recommended). ------------------------------------------------------------------------- Usage: db_status [options] Options: -h, --help show this help message and exit -s STATUS, --status=STATUS Database status UP,DOWN or ALL(list running dbs - UP,list down dbs - DOWN list all dbs - ALL ------------------------------------------------------------------------- Usage: distribute_config_files Sends admintools.conf from local host to all other hosts in the cluster Options: -h, --help show this help message and exit ------------------------------------------------------------------------- Usage: drop_db [options] Options: -h, --help show this help message and exit -d DB, --database=DB Database to be dropped ------------------------------------------------------------------------- Usage: host_to_node [options] Options: -h, --help show this help message and exit -s HOST, --host=HOST comma separated list of hostnames which is to be converted into its corresponding nodenames -d DB, --database=DB show only node/host mapping for this database. ------------------------------------------------------------------------- Usage: admintools -t install_package --package PACKAGE -d DB -p PASSWORD Examples: admintools -t install_package -d mydb -p 'mypasswd' --package default # (above) install all default packages that aren't currently installed admintools -t install_package -d mydb -p 'mypasswd' --package default --force-reinstall # (above) upgrade (re-install) all default packages to the current version admintools -t install_package -d mydb -p 'mypasswd' --package hcat # (above) install package hcat See also: admintools -t list_packages Options: -h, --help show this help message and exit -d DBNAME, --dbname=DBNAME database name -p PASSWORD, --password=PASSWORD database admin password -P PACKAGE, --package=PACKAGE specify package or 'all' or 'default' --force-reinstall Force a package to be re-installed even if it is already installed. ------------------------------------------------------------------------- Usage: install_procedure [options] Options: -h, --help show this help message and exit -d DBNAME, --database=DBNAME Name of database for installed procedure -f PROCPATH, --file=PROCPATH Path of procedure file to install -p OWNERPASSWORD, --password=OWNERPASSWORD Password of procedure file owner ------------------------------------------------------------------------- Usage: kill_host [options] Options: -h, --help show this help message and exit -s HOSTS, --hosts=HOSTS comma-separated list of hosts on which the vertica process is to be killed using a SIGKILL signal --compat21 (deprecated) Use Vertica 2.1 method using node names instead of hostnames ------------------------------------------------------------------------- Usage: kill_node [options] Options: -h, --help show this help message and exit -s HOSTS, --hosts=HOSTS comma-separated list of hosts on which the vertica process is to be killed using a SIGKILL signal --compat21 (deprecated) Use Vertica 2.1 method using node names instead of hostnames ------------------------------------------------------------------------- Usage: license_audit --dbname DB_NAME [OPTIONS] Runs audit and collects audit results. Options: -h, --help show this help message and exit -d DATABASE, --database=DATABASE Name of the database to retrieve audit results -p PASSWORD, --password=PASSWORD Password for database admin -q, --quiet Do not print status messages. -f FILE, --file=FILE Output results to FILE. ------------------------------------------------------------------------- Usage: list_allnodes [options] Options: -h, --help show this help message and exit ------------------------------------------------------------------------- Usage: list_db [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to be listed ------------------------------------------------------------------------- Usage: list_host [options] Options: -h, --help show this help message and exit ------------------------------------------------------------------------- Usage: list_node [options] Options: -h, --help show this help message and exit -n NODENAME, --node=NODENAME Name of the node to be listed ------------------------------------------------------------------------- Usage: admintools -t list_packages [OPTIONS] Examples: admintools -t list_packages # lists all available packages admintools -t list_packages --package all # lists all available packages admintools -t list_packages --package default # list all packages installed by default admintools -t list_packages -d mydb --password 'mypasswd' # list the status of all packages in mydb Options: -h, --help show this help message and exit -d DBNAME, --dbname=DBNAME database name -p PASSWORD, --password=PASSWORD database admin password -P PACKAGE, --package=PACKAGE specify package or 'all' or 'default' ------------------------------------------------------------------------- Usage: logrotate [options] Options: -h, --help show this help message and exit -d DBNAME, --dbname=DBNAME database name -r ROTATION, --rotation=ROTATION set how often the log is rotated.[ daily|weekly|monthly ] -s MAXLOGSZ, --maxsize=MAXLOGSZ set maximum log size before rotation is forced. -k KEEP, --keep=KEEP set # of old logs to keep ------------------------------------------------------------------------- Usage: node_map [options] Options: -h, --help show this help message and exit -d DB, --database=DB List only data for this database. ------------------------------------------------------------------------- Usage: rebalance_data [options] Options: -h, --help show this help message and exit -d DBNAME, --dbname=DBNAME database name -k KSAFETY, --ksafety=KSAFETY specify the new k value to use -p PASSWORD, --password=PASSWORD --script Don't re-balance the data, just provide a script for later use. ------------------------------------------------------------------------- Usage: restart_db [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to be restarted -e EPOCH, --epoch=EPOCH Epoch at which the database is to be restarted. If 'last' is given as argument the db is restarted from the last good epoch. -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes --timeout=NONINTERACTIVE_TIMEOUT set a timeout (in seconds) to wait for actions to complete ('never') will wait forever (implicitly sets -i) -i, --noprompts do not stop and wait for user input(default false) ------------------------------------------------------------------------- Usage: restart_node [options] Options: -h, --help show this help message and exit -s NODES, --hosts=NODES comma-separated list of hosts to be restarted -d DB, --database=DB Name of database whose node is to be restarted -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes --timeout=NONINTERACTIVE_TIMEOUT set a timeout (in seconds) to wait for actions to complete ('never') will wait forever (implicitly sets -i) -i, --noprompts do not stop and wait for user input(default false) -F, --force force the node to start and auto recover if necessary --compat21 (deprecated) Use Vertica 2.1 method using node names instead of hostnames ------------------------------------------------------------------------- Usage: return_epoch [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database ------------------------------------------------------------------------- Usage: set_restart_policy [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database for which to set policy -p POLICY, --policy=POLICY Restart policy: ('never', 'ksafe', 'always') ------------------------------------------------------------------------- Usage: set_ssl_params [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database whose parameters will be set -k KEYFILE, --ssl-key-file=KEYFILE Path to SSL private key file -c CERTFILE, --ssl-cert-file=CERTFILE Path to SSL certificate file -a CAFILE, --ssl-ca-file=CAFILE Path to SSL CA file -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes ------------------------------------------------------------------------- Usage: show_active_db [options] Options: -h, --help show this help message and exit ------------------------------------------------------------------------- Usage: start_db [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to be started -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes --timeout=NONINTERACTIVE_TIMEOUT set a timeout (in seconds) to wait for actions to complete ('never') will wait forever (implicitly sets -i) -i, --noprompts do not stop and wait for user input(default false) -F, --force force the database to start at an epoch before data consistency problems were detected. -U, --unsafe Start database unsafely, skipping recovery. Use under support guidance only. ------------------------------------------------------------------------- Usage: stop_db [options] Options: -h, --help show this help message and exit -d DB, --database=DB Name of database to be stopped -p DBPASSWORD, --password=DBPASSWORD Database password in single quotes -F, --force Force the databases to shutdown, even if users are connected. --timeout=NONINTERACTIVE_TIMEOUT set a timeout (in seconds) to wait for actions to complete ('never') will wait forever (implicitly sets -i) -i, --noprompts do not stop and wait for user input(default false) ------------------------------------------------------------------------- Usage: stop_host [options] Options: -h, --help show this help message and exit -s HOSTS, --hosts=HOSTS comma-separated list of hosts on which the vertica process is to be killed using a SIGTERM signal --compat21 (deprecated) Use Vertica 2.1 method using node names instead of hostnames ------------------------------------------------------------------------- Usage: stop_node [options] Options: -h, --help show this help message and exit -s HOSTS, --hosts=HOSTS comma-separated list of hosts on which the vertica process is to be killed using a SIGTERM signal --compat21 (deprecated) Use Vertica 2.1 method using node names instead of hostnames ------------------------------------------------------------------------- Usage: uninstall_package [options] Options: -h, --help show this help message and exit -d DBNAME, --dbname=DBNAME database name -p PASSWORD, --password=PASSWORD database admin password -P PACKAGE, --package=PACKAGE specify package or 'all' or 'default' ------------------------------------------------------------------------- Usage: upgrade_license_key --database mydb --license my_license.key upgrade_license_key --install --license my_license.key Updates the vertica license. Without '--install', updates the license used by the database and the admintools license cache. With '--install', updates the license cache in admintools that is used for creating new databases. Options: -h, --help show this help message and exit -d DB, --database=DB Name of database. Cannot be used with --install. -l LICENSE, --license=LICENSE Required - path to the license. -i, --install When option is included, command will only update the admintools license cache. Cannot be used with --database. -p PASSWORD, --password=PASSWORD Database password. ------------------------------------------------------------------------- Usage: view_cluster [options] Options: -h, --help show this help message and exit -x, --xpand show the full cluster state, node by node -d DB, --database=DB filter the output for a single database