Book Contents

Book Index

Next Topic

Home

Writing Administration Tools Scripts

You can invoke any of the Administration Tools from the command line or a shell script.

Syntax

 

> /opt/vertica/bin/adminTools [ -t | --tool ] toolname [ options ]

For convenience, you can add /opt/vertica/bin to your search path.

Semantics

 

toolname

is one of the tools described in the help output below.

options

 

-h

--help

shows a brief help message and exits.

-a

--help_all

lists all command line sub-commands and options as shown below.

Tools

Usage:

adminTools [-t | --tool] toolName [options]

Valid tools are:

kill_node

run_designer

list_db

view_cluster

uninstall_node

create_db

stop_db

list_node

install_node

drop_db

stop_node

config_nodes

drop_node

restart_db

restart_node

check_spread

start_db

connect_db

-------------------------------------------------------------------------

usage: kill_node [options]

options:

-h, --help show this help message and exit

-s NODES, --nodes=NODES

comma-separated list of nodes on which the vertica

prcoess is to be killed

-------------------------------------------------------------------------

usage: runDesigner [options]

options:

-h, --help show this help message and exit

-f PARAMFILE, --file=PARAMFILE

Designer parameters file

-p DBPASSWORD, --password=DBPASSWORD

Database password

-------------------------------------------------------------------------

usage: list_db [options]

options:

-h, --help show this help message and exit

-d DB, --database=DB Name of database to be listed

-------------------------------------------------------------------------

usage: view_cluster [options]

options:

-h, --help show this help message and exit

-------------------------------------------------------------------------

usage: uninstall_node [options]

options:

-h, --help show this help message and exit

-s NODENAME, --node=NODENAME

Node name upon which to uninstall

-p PASSWORD, --password=PASSWORD

Name of file containing root password for machines in

the list

-d, --delete Delete configuration data during uninstall

-------------------------------------------------------------------------

usage: create_db [options]

options:

-h, --help show this help message and exit

-s NODES, --nodes=NODES

comma-separated list of nodes to participate in

database

-d DB, --database=DB Name of database to be created

-p DBPASSWORD, --password=DBPASSWORD

Database password

-l LICENSEFILE, --license=LICENSEFILE

Database license

-------------------------------------------------------------------------

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

-------------------------------------------------------------------------

usage: list_node [options]

options:

-h, --help show this help message and exit

-s NODENAME, --node=NODENAME

Name of the node to be listed

-------------------------------------------------------------------------

usage: install_node [options]

options:

-h, --help show this help message and exit

-s NODENAME, --node=NODENAME

Node name upon which to install

-r RPMNAME, --rpm=RPMNAME

Fully qualified file name of the RPM to be used on

install

-p PASSWORD, --password=PASSWORD

Name of file containing root password for machines in

the list

-------------------------------------------------------------------------

usage: drop_db [options]

options:

-h, --help show this help message and exit

-d DB, --database=DB Database to be dropped

-------------------------------------------------------------------------

usage: stop_node [options]

options:

-h, --help show this help message and exit

-s NODES, --nodes=NODES

comma-separated list of nodes on which the vertica

prcoess is to be killed

-------------------------------------------------------------------------

usage: config_nodes [options]

options:

-h, --help show this help message and exit

-f NODEHOSTFILE, --file=NODEHOSTFILE

File containing list of nodes, hostnames, catalog

path, and datapath (node<whitespace>host<whitespace>ca

talogPath<whitespace>dataPath one per line)

-i, --install Attempt to install from RPM on all nodes in the list

-r RPMNAME, --rpm=RPMNAME

Fully qualified file name of the RPM to be used on

install

-p PASSWORD, --password=PASSWORD

Name of file containing Root password for machines in

the list

-c, --check Check all nodes to make sure they can interconnect

-s SKIPANALYZENODE, --skipanalyzenode=SKIPANALYZENODE

skipanalyzenode

-------------------------------------------------------------------------

usage: drop_node [options]

options:

-h, --help show this help message and exit

-s NODENAME, --node=NODENAME

Name of the node to be dropped

-------------------------------------------------------------------------

usage: restart_db [options]

options:

-h, --help show this help message and exit

-d DB, --database=DB Name of database to be restarted

-v VERSION, --version=VERSION

Catalog Version at which the database is to be

restarted. If 'last' is given as argument the db is

restarted from the last good catalog version. Either

Catalog version or Epoch must be specified.

-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. Either Catalog version or Epoch

must be specified.

-p DBPASSWORD, --password=DBPASSWORD

Database password

-------------------------------------------------------------------------

usage: restart_node [options]

options:

-h, --help show this help message and exit

-s NODES, --nodes=NODES

comma-separated list of nodes to be restarted

-d DB, --database=DB Name of database whose node is to be restarted

-p DBPASSWORD, --password=DBPASSWORD

Database password

-------------------------------------------------------------------------

usage: check_spread [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

-------------------------------------------------------------------------

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