Most of Vertica's administrative tasks are done using Administration Tools(admintools tool).
To run the admintools you need to use the user account that owns the database catalog and data storage on disk.
Syntax
# /opt/vertica/bin/admintools [ -t | --tool ] toolname [ options ]
Parameters
[ -t | --tool ] toolname [ options ]
Valid tools are:
stop_node
host_to_node
install_procedure
return_epoch
stop_db
db_remove_node
stop_host
install_node
list_allnodes
rebalance_data
logrotate
drop_db
kill_node
list_db
kill_host
show_active_db
set_restart_policy
config_nodes
db_status
restart_db
database_parameters
restart_node
check_spread
view_cluster
node_map
list_host
start_db
upgrade_license_key
edit_auth
command_host
uninstall_node
create_db
connect_db
list_node
db_replace_node
db_add_node
drop_node
This tools they all have options :
stop_node [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 Use Vertica 2.1 method using node names instead of
hostnames
host_to_node [options]
-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.
install_procedure [options]
-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 onwer
return_epoch [options]
-d DB, --database=DB Name of database
stop_db [options]
-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.
-i, --noprompts do not stop and wait for user input(default false)
db_remove_node [options]
-d DB, --database=DB Name of database to be modified
Name of the host to remove from the db
--compat21 Use Vertica 2.1 method using node names instead of hostnames
stop_host [options]
install_node [options]
-s HOSTNAME, --host=HOSTNAME
Comma separated list of hostnames upon which to
install
-r RPMNAME, --rpm=RPMNAME
Fully qualified file name of the RPM to be used on
-p PASSWORD, --password=PASSWORD
Name of file containing root password for machines in
the list
list_allnodes [options]
rebalance_data [options]
-d DBNAME, --dbname=DBNAME
database name
-k KSAFETY, --ksafety=KSAFETY
specify the new k value to use
--script Don't re-balance the data, just provide a script for
later use.
logrotate [options]
-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
drop_db [options]
-d DB, --database=DB Database to be dropped
kill_node [options]
process is to be killed using a SIGKILL signal
--compat21 Use Vertica 2.1 method using node names
instead of
list_db [options]
-d DB, --database=DB Name of database to be listed
kill_host [options]
show_active_db [options]
set_restart_policy [options]
-d DB, --database=DB Name of database for which to set policy
-p POLICY, --policy=POLICY
Restart policy: ('never', 'ksafe', 'always')
config_nodes [options]
-f NODEHOSTFILE, --file=NODEHOSTFILE
File containing list of nodes, hostnames, catalog
path, and datapath (node<whitespacehost<whitespaceca
talogPath<whitespacedataPath one per line)
-i, --install Attempt to install from RPM on all nodes in the list
Name of file containing Root password for machines in
-c, --check Check all nodes to make sure they can interconnect
-s SKIPANALYZENODE, --skipanalyzenode=SKIPANALYZENODE
skipanalyzenode
db_status [options]
-s STATUS, --status=STATUS
Database status UP,DOWN or ALL(list running dbs -
UP,list down dbs - DOWN list all dbs - ALL
drop_node [options]
-n NODENAME, --node=NODENAME
Name of the node to be dropped
--force Force a node to be dropped if it? the last reference
to the host.
restart_db [options]
-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.
database_parameters [options]
-P PARAMETER, --parameter=PARAMETER
Database parameter
-c COMPONENT, --component=COMPONENT
Component[optional]
-s SUBCOMPONENT, --subcomponent=SUBCOMPONENT
Sub Component[optional]
Database password[optional]
restart_node [options]
-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
check_spread [options]
view_cluster [options]
-x, --xpand show the full cluster state, node by node
-d DB, --database=DB filter the output for a single database
node_map [options]
-d DB, --database=DB List only data for this database.
list_host [options]
start_db [options]
-d DB, --database=DB Name of database to be started
-i, --noprompts do not stop and wait for user
input(default false)
upgrade_license_key [options]
-d DB, --database=DB Name of database [required if databases exist]
-l LICENSE, --license=LICENSE
Database license
-i INSTALL, --install=INSTALL
argument '-i install' to Install license else without
'-i install' Upgrade license
edit_auth [options]
-d DATABASE, --database=DATABASE
database to edit authentication parameters for
command_host [options]
-c CMD, --command=CMD
Command to run
uninstall_node [options]
uninstall
-d, --delete Delete configuration data during uninstall
create_db [options]
comma-separated list of hosts to participate in
database
-d DB, --database=DB Name of database to be created
-c CATALOG, --catalog_path=CATALOG
Path of catalog directory[optional] if not using
compat21
-D DATA, --data_path=DATA
Path of data directory[optional] if not using compat21
Database password in single quotes [optional]
-l LICENSEFILE, --license=LICENSEFILE
Database license [optional]
-P POLICY, --policy=POLICY
Database restart policy [optional]
connect_db [options]
-d DB, --database=DB Name of database to connect
list_node [options]
Name of the node to be listed
db_replace_node [options]
-o ORIGINAL, --original=ORIGINAL
Name of host you wish to replace
-n NEWHOST, --new=NEWHOST
Name of the replacement host
db_add_node [options]
Comma separated list of hosts to add to database
-a AHOSTS, --add=AHOSTS
Examples of how you can use admintools line commands in the next tutorials.