管理工具（即“admintools”）使用开源 vertica-python 客户端对数据库执行操作。
以下几节详细介绍了通过 Vertica 管理工具可以执行的所有步骤：
管理工具参考
- 1: 查看数据库群集状态
- 2: 连接到数据库
- 3: 在主机上重新启动 Vertica
- 4: 配置菜单 (Configuration Menu) 选项
- 4.1: 创建数据库
- 4.2: 删除数据库
- 4.3: 查看数据库
- 4.4: 设置重新启动策略
- 4.5: 安装外部过程可执行文件
- 5: 高级菜单 (Advanced Menu) 选项
- 5.1: 将数据库回退至上一个完好的时期
- 5.2: 在主机上停止 Vertica
- 5.3: 在主机上终止 Vertica 进程
- 5.4: 升级 Vertica 许可证密钥
- 5.5: 管理群集
- 5.6: 获得有关管理工具的帮助
- 5.7: 管理工具元数据
- 6: 管理工具连接行为和要求
- 7: 编写管理工具脚本
1 - 查看数据库群集状态
此工具显示数据库中节点的当前状态。
-
在“主菜单 (Main Menu)”上，选择查看数据库群集状态 (View Database Cluster State)，然后单击确定 (OK)。
正在运行的数据库的正常状态为“全部开启 (ALL UP)”。已停止的数据库的正常状态为“全部关闭 (ALL DOWN)”。 -
如果某些主机处于“开启 (UP)”状态，而某些主机处于“关闭 (DOWN)”状态，请使用管理工具中的在主机上重新启动 Vertica (Restart Vertica on Host) 重新启动已关闭的特定主机，或者可以按照启动和停止数据库中所述启动数据库（除非您有已知的节点故障，并希望以该状态继续运行）。
显示为“正在初始化 (INITIALIZING)”或“正在恢复 (RECOVERING)”的节点指示正在进行故障恢复。
处于其他状态（例如 NEEDS_CATCHUP）的节点为过渡节点，除非永久存在，否则可以忽略。
另请参阅
2 - 连接到数据库
此工具使用 vsql 连接到正在运行的 数据库。当登录到具有访问权限的任何用户帐户时，可以从数据库中的任何节点使用管理工具连接到数据库。无法从不是数据库节点的主机使用管理工具进行连接。要从其他主机进行连接，请按照从命令行进行连接中所述运行 vsql。
-
在“主菜单 (Main Menu)”上，单击连接到数据库 (Connect to Database)，再单击确定 (OK)。
-
提供数据库密码（如果要求）：
Password:在使用 CREATE USER 命令创建新用户时，可以配置密码，也可以将其留空。如果在创建用户时配置了密码，则无法绕开密码。可以使用 ALTER USER 命令更改用户的密码。
管理工具连接到数据库，并将控制权移交给 vsql。
Welcome to vsql, the Vertica Analytic Database interactive terminal. Type: \h or \? for help with vsql commands \g or terminate with semicolon to execute query \q to quit =>
有关详细信息，请参阅使用 vsql。
注意
输入密码后，如果密码已过期，系统可能会提示您更改密码。有关密码安全性的详细信息，请参阅配置客户端身份验证。另请参阅
3 - 在主机上重新启动 Vertica
此工具在正在运行的数据库中的一个或多个主机上重新启动 Vertica 进程。如果 Vertica 进程在主机上停止或被终止，请使用此工具。
-
要查看群集中节点的当前状态，请在“主菜单 (Main Menu)”上选择查看数据库群集状态 (View Database Cluster State)。
-
单击确定 (OK) 返回到“主菜单 (Main Menu)”。
-
如果一个或多个节点关闭，请选择在主机上重新启动 Vertica (Restart Vertica on Host)，然后单击确定 (OK)。
-
选择包含要重新启动的主机的数据库，然后单击确定 (OK)。
-
选择要重新启动的一个或多个主机，然后单击确定 (OK)。
-
输入数据库密码。
-
再次选择查看数据库群集状态 (View Database Cluster State) 以验证是否所有节点都已启动。
4 - 配置菜单 (Configuration Menu) 选项
“配置菜单 (Configuration Menu)”可用于执行以下任务：
4.1 - 创建数据库
使用以下过程通过 admintools 创建企业模式或 Eon 模式数据库。要在管理控制台中使用浏览器内向导创建数据库，请参阅使用 MC 创建数据库。
创建企业模式数据库
-
在“配置菜单 (Configuration Menu)”上，单击“创建数据库 (Create Database)”。单击 OK。
-
选择“企业模式 (Enterprise Mode)”作为数据库模式。
-
输入数据库名称和可选注释。单击 OK。
-
输入密码。有关规则，请参阅创建数据库名称和密码。
如果未输入密码，系统会提示您进行确认：“是 (Yes)”表示输入超级用户密码，“否 (No)”表示创建没有超级用户密码的数据库。
当心
如果此时不输入密码，超级用户密码将设置为空。除非数据库用于评估或学术目的，否则 Vertica 强烈建议您输入超级用户密码。 -
如果输入了密码，请再次输入密码。
-
选择要包括在数据库中的主机。此列表中的主机是安装时 (
install_vertica -s) 指定的主机。
-
指定用于存储编录和数据文件的目录。
注意
编录和数据路径只能包含字母数字字符，不能有前置空格字符。如果不能遵守这些限制条件，可能会导致数据库创建失败。注意
请勿将一个共享目录用于多个节点。每个节点的数据目录和编录目录必须不同。多个节点不能写入相同的数据目录和编录目录。 -
检查当前数据库定义是否正确。单击“是 (Yes)”以继续。
-
将显示一条消息，指示您已成功创建数据库。单击 OK。
创建 Eon 模式数据库
注意
目前，admintools 菜单界面不支持在 Google Cloud Platform 上创建 Eon 模式数据库。请改为使用 MC 或 admintools 命令行来创建 Eon 模式数据库。-
在“配置菜单 (Configuration Menu)”上，单击“创建数据库 (Create Database)”。单击 OK。
-
选择“Eon 模式 (Eon Mode)”作为数据库模式。
-
输入数据库名称和可选注释。单击 OK。
-
输入密码。有关规则，请参阅创建数据库名称和密码。
仅限 AWS： 如果未输入密码，系统会提示您进行确认：“是 (Yes)”表示输入超级用户密码，“否 (No)”表示创建没有超级用户密码的数据库。
当心
如果此时不输入密码，超级用户密码将设置为空。除非数据库用于评估或学术目的，否则 Vertica 强烈建议您输入超级用户密码。 -
如果输入了密码，请再次输入密码。
-
选择要包括在数据库中的主机。此列表中的主机是安装时 (
install_vertica -s) 指定的主机。 -
指定用于存储编录和存储库的目录、存储库大小、公共存储位置以及分片数量。
-
存储库大小： 使用后跟 %、K、G 或 T 的整数。默认值为存储相应存储库的文件系统的总磁盘空间的 60%。
-
公共存储： 在您的实例所在的同一区域中使用现有的 Amazon S3 存储桶。指定新的子文件夹名称，Vertica 将在现有的 S3 存储桶中动态创建该名称。例如，s3://existingbucket/newstorage1。您可以在现有子文件夹中创建新的子文件夹，但如果未指定任何新的子文件夹名称，数据库创建将回退。
-
分片数量： 使用整数。默认值等于节点数。为了获得最佳性能，分片数量不应大于节点数量的 2 倍。当节点数量大于分片数量（使用 ETS）时，仪表板查询的吞吐量会提高。当分片数量超过节点数量时，您可以在将来扩展群集以提高长分析查询的性能。
注意
编录和存储库路径必须只能包含字母数字字符，不能有前置空格字符。如果不能遵守这些限制条件，可能会导致数据库创建失败。 -
-
检查当前数据库定义是否正确。单击“是 (Yes)”以继续。
-
将显示一条消息，指示您已成功创建数据库。单击 OK。
4.2 - 删除数据库
此工具将删除现有的 数据库。只有 数据库超级用户可以删除数据库。
-
在配置菜单 (Configuration Menu) 上，单击删除数据库 (Drop Database)，再单击确定 (OK)。
-
选择要删除的数据库，然后单击确定 (OK)。
-
单击是 (Yes) 以确定要删除数据库。
-
键入是 (yes)，然后单击确定 (OK)，再次确认您确实要删除数据库。
-
将显示一条消息，指示您已成功删除数据库。单击确定 (OK)。
当 Vertica 删除数据库时，它还会自动删除引用该数据库的节点定义。以下情况除外：
-
另一个数据库使用节点定义。如果另一个数据库引用了其中任何节点定义，则不会删除任何节点定义。
-
节点定义是为主机定义的唯一节点。（Vertica 使用节点定义来查找可用于创建数据库的主机，因此移除为主机定义的唯一节点可能会导致该主机对新数据库不可用。）
4.3 - 查看数据库
此工具显示现有 数据库的特征。
-
在配置菜单 (Configuration Menu) 上，选择查看数据库 (View Database)，然后单击确定 (OK)。
-
选择要查看的数据库。
-
Vertica 会显示有关数据库的以下信息：
-
数据库的名称。
-
数据库日志文件的名称和位置。
-
数据库群集中的主机。
-
重新启动策略设置的值。
注意： 此设置确定 K-Safe 数据库中的节点在数据库重新启动时是否重新启动。请参阅设置重新启动策略。
-
数据库端口。
-
编录目录的名称和位置。
-
4.4 - 设置重新启动策略
通过重新启动策略，可以确定 K-Safe 数据库中的节点在数据库重新启动时是否自动重新启动。由于整个数据库处于关闭状态时此功能不会自动重新启动节点，因此对非 K-Safe 的数据库无用。
要设置数据库的重新启动策略：
-
打开管理工具。
-
在“主菜单 (Main Menu)”上，选择配置菜单 (Configuration Menu)，然后单击确定 (OK)。
-
在“配置菜单 (Configuration Menu)”中，选择设置重新启动策略 (Set Restart Policy)，然后单击确定 (OK)。
-
选择要设置重新启动策略的数据库，然后单击确定 (OK)。
-
为数据库选择以下策略之一：
-
从不 (Never) — 节点从不自动重新启动。
-
K-Safe — 如果数据库群集仍处于开启状态，则节点将自动重新启动。这是默认设置。
-
始终 (Always) — 单节点数据库上的节点将自动重新启动。
注意
如果单个节点数据库未完全关闭或已崩溃，则“始终 (Always)”将无法生效。
-
-
单击确定 (OK)。
按照下述过程进行操作可防止 Vertica 将磁盘缺失或挂载错误的情况错误地诊断为数据损坏，进而避免发生耗时的全节点恢复。
如果服务器因硬件问题（例如磁盘错误或控制器故障）而发生故障，请在修复硬件时：
-
将计算机重启至运行级别 1，这是仅适用于控制台的 root 模式。
运行级别 1 可禁止网络连接并阻止 Vertica 尝试重新连接到群集。
-
在运行级别 1 中，验证硬件是否已得到修复，控制器是否处于联机状态，以及是否可以继续执行任何 RAID 恢复操作。
注意
在运行级别 1 中，无需初始化 RAID 恢复；只需验证其是否可以恢复。 -
只有在确认硬件一致之后才能重启至运行级别 3 或更高级别。
此时将激活网络，同时 Vertica 会重新加入群集并自动恢复任何缺失的数据。请注意，在单节点数据库中，如果与投影关联的任何文件被删除或损坏，Vertica 将删除与该投影关联的所有文件，这可能会导致数据丢失。
4.5 - 安装外部过程可执行文件
-
运行 管理工具。
$ /opt/vertica/bin/adminTools -
在管理工具主菜单 (Main Menu) 上，单击配置菜单 (Configuration Menu)，再单击确定 (OK)。
-
在配置菜单 (Configuration Menu) 上，单击安装外部过程 (Install External Procedure)，再单击确定 (OK)。
-
选择要在其上安装外部过程的数据库。
-
选择要安装的文件或手动键入完整文件路径，然后单击确定 (OK)。
-
如果不是超级用户，则会提示您输入密码，然后单击确定 (OK)。
管理工具会自动在数据库中的每个节点上创建
database-name/procedures目录，并在这些目录中为您安装外部过程。 -
单击对话框中的确定 (OK)，这表示安装已成功完成。
5 - 高级菜单 (Advanced Menu) 选项
“高级菜单 (Advanced Menu)”选项可用于执行以下任务：
5.1 - 将数据库回退至上一个完好的时期
Vertica 提供了将整个数据库回退至特定 时期的功能，主要用于帮助更正数据加载或其他意外中断期间的人为错误。例如，假设您已执行批量加载，且群集在特定 COPY 命令期间无法运行。您可能要放弃所有时期并回退到提交上一个 COPY 命令的点，并再次运行未结束的命令。您可以通过检查日志文件确定该点（请参阅监控日志文件）。
-
在“高级 (Advanced)”菜单上，选择将数据库回退至上一个完好的时期 (Roll Back Database to Last Good Epoch)。
-
选择要回退的数据库。该数据库必须已停止。
-
接受建议的重新启动时期或指定其他时期。
-
确认要放弃指定时期之后的更改。
数据库成功重新启动。
5.2 - 在主机上停止 Vertica
此命令尝试在单个节点上正常关闭 Vertica 进程。
当心
请勿使用此命令关闭整个群集。相反，请改用停止数据库执行正常关闭，从而最大限度地减少数据丢失。-
在“高级菜单 (Advanced Menu)”上，选择在主机上停止 Vertica (Stop Vertica on Host)，然后单击确定 (OK)。
-
选择要停止的主机。
-
确认要停止这些主机。
如果命令成功，查看数据库群集状态将显示选定的主机状态为“关闭 (DOWN)”。
如果该命令无法停止任何选定节点，请继续执行在主机上终止 Vertica 进程。
5.3 - 在主机上终止 Vertica 进程
此命令会向节点上的 Vertica 进程发送终止信号。
-
在“高级菜单 (Advanced Menu)”上，选择在主机上终止 Vertica 进程 (Kill Vertica Process on Host)，然后单击确定 (OK)。
-
选择要在其上终止 Vertica 进程的主机。
-
确认要停止进程。
-
如果命令成功，查看数据库群集状态 (View Database Cluster State) 将显示选定的主机状态为“关闭 (DOWN)”。
5.4 - 升级 Vertica 许可证密钥
以下步骤适用于获得许可的 Vertica 用户。完成这些步骤会将许可证密钥文件复制到数据库中。有关详细信息，请参阅管理许可证。
-
在“高级菜单 (Advanced Menu)”上，选择升级许可证密钥 (Upgrade License Key)。单击确定 (OK)。
-
选择要升级许可证密钥的数据库。
-
输入下载的许可证密钥文件的绝对路径名（例如
/tmp/vlicense.dat）。单击确定 (OK)。 -
当您看到一条指示升级成功的消息时，单击“确定 (OK)”。
注意
如果使用的是 Vertica 社区版，请按照 Vertica 许可证更改中的说明操作，以获取升级到 Vertica 高级版许可证密钥的说明。5.5 - 管理群集
群集管理可用于在数据库群集中添加、替换或删除主机。这些过程通常是添加、删除或替换数据库节点这一较大过程的一部分。
使用群集管理
要使用群集管理：
-
在主菜单 (Main Menu) 上，选择“高级菜单 (Advanced Menu)”，然后单击确定 (OK)。
-
在“高级菜单 (Advanced Menu)”上，选择群集管理 (Cluster Management)，然后单击确定 (OK)。
-
选择以下选项之一，然后单击确定 (OK)。
5.6 - 获得有关管理工具的帮助
使用管理工具的帮助 (Help Using the Administration Tools) 命令会显示有关使用管理工具的帮助屏幕。
管理工具中的大多数联机帮助都是上下文相关的。例如，如果使用向上/向下箭头选择一个命令，请按 Tab 键移动到“帮助 (Help)”按钮，然后按 Return，此时将看到与选定命令相关的帮助。
5.7 - 管理工具元数据
管理工具配置数据（元数据）包含数据库启动所需的信息，例如数据库群集中每个参与主机的主机名/IP 地址。
为了便于在管理工具中解析主机名，在命令行和安装实用程序中，Vertica 将强制通过管理工具提供的所有主机名使用 IP 地址：
-
安装期间
Vertica 会立即将通过命令行选项
--hosts、-add-hosts或--remove-hosts提供的任何主机名转换为其等效 IP 地址。-
如果在安装期间提供解析为多个 IP 地址的主机名（例如在多宿主系统中），安装程序将提示您选择一个 IP 地址。
-
Vertica 保留您提供的名称只是为了将其用于消息和提示；在内部，这些主机名会被存储为 IP 地址。
-
-
在管理工具中
所有主机都使用 IP 形式以便直接比较（例如 db = database = database.example.com）。
-
在命令行中
Vertica 会将任何主机名值转换为用于在配置元数据中查找主机的 IP 地址。如果主机具有已解析的多个 IP 地址，Vertica 将测试每个 IP 地址以确认其是否在元数据中，并选择第一个匹配项。没有匹配项表示主机不是数据库群集的一部分。
元数据的可移植性更高，因为当您安装或升级数据库时，Vertica 不需要群集中的主机名完全相同。
6 - 管理工具连接行为和要求
admintools 在连接到数据库并对数据库执行操作时的行为可能因配置而异。特别是，admintools 会考虑它与其他节点的连接、这些节点的状态以及 dbadmin 使用的身份验证方法。
连接要求和身份验证
-
admintools 会在群集主机之间使用无密码 SSH 连接进行大多数操作，这是在安装期间使用 install_vertica 脚本配置或确认的
-
在大多数情况下，当向数据库发出命令时，admintools 倾向于使用其与目标主机的 SSH 连接，并使用 localhost 客户端连接到 Vertica 数据库
-
传入 IP 地址决定了所使用的身份验证方法。也就是说，客户端连接的行为可能与本地连接的行为不同，默认情况下本地连接可能是受信任的
-
dbadmin 应该具有本地信任或基于密码的身份验证方法
-
当决定使用哪个主机进行多步操作时，admintools 首选 localhost，然后重新连接到已知良好的节点
K-safety 支持
管理工具允许对 K-Safe 数据库执行某些操作，即使某些节点没有响应也是如此。
数据库必须已使用 MARK_DESIGN_KSAFE 函数标记为 K-Safe。
管理工具中的以下管理功能在某些节点没有响应时可以操作。
注意
Vertica 用户可以使用管理控制台界面执行以下大部分功能。有关详细信息，请参阅管理控制台和管理工具。-
查看数据库群集状态
-
连接到数据库
-
启动数据库（包括手动恢复）
-
停止数据库
-
替换节点（假设已关闭的节点为被替换的节点）
-
查看数据库参数
-
升级许可证密钥
管理工具中的以下管理功能要求所有节点都已启动才能正常运行：
-
创建数据库
-
运行 Database Designer
-
删除数据库
-
设置重新启动策略
-
将数据库回退至 上一个完好的时期
7 - 编写管理工具脚本
可以从命令行或 shell 脚本调用大部分管理工具。
语法
/opt/vertica/bin/admintools {
{ -h | --help }
| { -a | --help_all}
| { [--debug ] { -t | --tool } toolname [ tool-args ] }
}
注意
为方便起见，请将/opt/vertica/bin 添加到您的搜索路径中。
参数
工具
若要返回所有可用工具的列表，请在命令提示符中输入 admintools -h。
注意
要创建数据库或密码，请参阅创建数据库名称和密码了解命名规则。若要显示特定工具及其选项或命令的帮助，请用 --help 或 -h 限定指定工具的名称，如下例所示：
$ 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
若要在单个帮助文本中列出所有可用工具及其命令和选项，请输入 admintools -a。
Usage:
adminTools [-t | --tool] toolName [options]
Valid tools are:
command_host
connect_db
create_db
db_add_node
db_add_subcluster
db_remove_node
db_remove_subcluster
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
re_ip
rebalance_data
restart_db
restart_node
restart_subcluster
return_epoch
revive_db
set_restart_policy
set_ssl_params
show_active_db
start_db
stop_db
stop_host
stop_node
stop_subcluster
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
-F, --force Provide the force cleanup flag. Only applies to start,
restart, condrestart. For other options it is ignored.
-------------------------------------------------------------------------
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 HOSTS, --hosts=HOSTS
comma-separated list of hosts to participate in
database
--shard-count=SHARD_COUNT
[Eon only] Number of shards in the database
--communal-storage-location=COMMUNAL_STORAGE_LOCATION
[Eon only] Location of communal storage
-x COMMUNAL_STORAGE_PARAMS, --communal-storage-params=COMMUNAL_STORAGE_PARAMS
[Eon only] Location of communal storage parameter file
--depot-path=DEPOT_PATH
[Eon only] Path to depot directory
--depot-size=DEPOT_SIZE
[Eon only] Size of depot
--force-cleanup-on-failure
Force removal of existing directories on failure of
command
--force-removal-at-creation
Force removal of existing directories before creating
the database
--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).
Setting this implies a timeout of 20 min.
-------------------------------------------------------------------------
Usage: db_add_node [options]
Options:
-h, --help show this help message and exit
-d DB, --database=DB Name of the database
-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
-c SCNAME, --subcluster=SCNAME
Name of subcluster for the new node
--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).
Setting this implies a timeout of 20 min.
--compat21 (deprecated) Use Vertica 2.1 method using node names
instead of hostnames
-------------------------------------------------------------------------
Usage: db_add_subcluster [options]
Options:
-h, --help show this help message and exit
-d DB, --database=DB Name of database to be modified
-s HOSTS, --hosts=HOSTS
Comma separated list of hosts to add to the subcluster
-p DBPASSWORD, --password=DBPASSWORD
Database password in single quotes
-c SCNAME, --subcluster=SCNAME
Name of the new subcluster for the new node
--is-primary Create primary subcluster
--is-secondary Create secondary subcluster
--control-set-size=CONTROLSETSIZE
Set the number of nodes that will run spread within
the subcluster
--like=CLONESUBCLUSTER
Name of an existing subcluster from which to clone
properties for the new subcluster
--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).
Setting this implies a timeout of 20 min.
-------------------------------------------------------------------------
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
--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).
Setting this implies a timeout of 20 min.
--compat21 (deprecated) Use Vertica 2.1 method using node names
instead of hostnames
--skip-directory-cleanup
Caution: this option will force you to do a manual
cleanup. This option skips directory deletion during
remove node. This is best used in a cloud environment
where the hosts being removed will be subsequently
discarded.
-------------------------------------------------------------------------
Usage: db_remove_subcluster [options]
Options:
-h, --help show this help message and exit
-d DB, --database=DB Name of database to be modified
-c SCNAME, --subcluster=SCNAME
Name of subcluster to be removed
-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).
Setting this implies a timeout of 20 min.
--skip-directory-cleanup
Caution: this option will force you to do a manual
cleanup. This option skips directory deletion during
remove subcluster. This is best used in a cloud
environment where the hosts being removed will be
subsequently discarded.
-------------------------------------------------------------------------
Usage: db_replace_node [options]
Options:
-h, --help show this help message and exit
-d DB, --database=DB Name of the database
-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
--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).
Setting this implies a timeout of 20 min.
-------------------------------------------------------------------------
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: logrotateconfig [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: re_ip [options]
Replaces the IP addresses of hosts and databases in a cluster, or changes the
control messaging mode/addresses of a database.
Options:
-h, --help show this help message and exit
-f MAPFILE, --file=MAPFILE
A text file with IP mapping information. If the -O
option is not used, the command replaces the IP
addresses of the hosts in the cluster and all
databases for those hosts. In this case, the format of
each line in MAPFILE is: [oldIPaddress newIPaddress]
or [oldIPaddress newIPaddress, newControlAddress,
newControlBroadcast]. If the former,
'newControlAddress' and 'newControlBroadcast' would
set to default values. Usage: $ admintools -t re_ip -f
<mapfile>
-O, --db-only Updates the control messaging addresses of a database.
Also used for error recovery (when Re-IP encounters
some certain errors, a mapfile is auto-generated).
Format of each line in MAPFILE: [NodeName
AssociatedNodeIPaddress, newControlAddress,
newControlBrodcast]. 'NodeName' and
'AssociatedNodeIPaddress' must be consistent with
admintools.conf. Usage: $ admintools -t re_ip -f
<mapfile> -O -d <db_name>
-i, --noprompts System does not prompt for the validation of the new
settings before performing the Re-IP. Prompting is on
by default.
-T, --point-to-point Sets the control messaging mode of a database to
point-to-point. Usage: $ admintools -t re_ip -d
<db_name> -T
-U, --broadcast Sets the control messaging mode of a database to
broadcast. Usage: $ admintools -t re_ip -d <db_name>
-U
-d DB, --database=DB Name of a database. Required with the following
options: -O, -T, -U.
-------------------------------------------------------------------------
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
-k, --allow-fallback-keygen
Generate spread encryption key from Vertica. Use under
support guidance only.
--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).
Setting this implies a timeout of 20 min.
-------------------------------------------------------------------------
Usage: restart_node [options]
Options:
-h, --help show this help message and exit
-s HOSTS, --hosts=HOSTS
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
--new-host-ips=NEWHOSTS
comma-separated list of new IPs for the hosts to be
restarted
--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).
Setting this implies a timeout of 20 min.
-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
--waitfordown-timeout=WAITTIME
Seconds to wait until nodes to be restarted are down
-------------------------------------------------------------------------
Usage: restart_subcluster [options]
Options:
-h, --help show this help message and exit
-d DB, --database=DB Name of database whose subcluster is to be restarted
-c SCNAME, --subcluster=SCNAME
Name of subcluster to be restarted
-p DBPASSWORD, --password=DBPASSWORD
Database password in single quotes
-s NEWHOSTS, --hosts=NEWHOSTS
Comma separated list of new hosts to rebind to the
nodes
--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).
Setting this implies a timeout of 20 min.
-F, --force Force the nodes in the subcluster to start and auto
recover if necessary
-------------------------------------------------------------------------
Usage: return_epoch [options]
Options:
-h, --help show this help message and exit
-d DB, --database=DB Name of database
-p PASSWORD, --password=PASSWORD
Database password in single quotes
-------------------------------------------------------------------------
Usage: revive_db [options]
Options:
-h, --help show this help message and exit
-s HOSTS, --hosts=HOSTS
comma-separated list of hosts to participate in
database
-n NODEHOST, --node-and-host=NODEHOST
pair of nodename-hostname values delimited by "|" eg:
"v_testdb_node0001|10.0.0.1"Note: Each node-host pair
has to be specified as a new argument
--communal-storage-location=COMMUNAL_STORAGE_LOCATION
Location of communal storage
-x COMMUNAL_STORAGE_PARAMS, --communal-storage-params=COMMUNAL_STORAGE_PARAMS
Location of communal storage parameter file
-d DBNAME, --database=DBNAME
Name of database to be revived
--force Force cleanup of existing catalog directory
--display-only Describe the database on communal storage, and exit
--strict-validation Print warnings instead of raising errors while
validating cluster_config.json
-------------------------------------------------------------------------
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).
Setting this implies a timeout of 20 min.
-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.
-k, --allow-fallback-keygen
Generate spread encryption key from Vertica. Use under
support guidance only.
-s HOSTS, --hosts=HOSTS
comma-separated list of hosts to be started
--fast Attempt fast startup on un-encrypted eon db. Fast
startup will use startup information from
cluster_config.json
-------------------------------------------------------------------------
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).
Setting this implies a timeout of 20 min.
-------------------------------------------------------------------------
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: stop_subcluster [options]
Options:
-h, --help show this help message and exit
-d DB, --database=DB Name of database whose subcluster is to be stopped
-c SCNAME, --subcluster=SCNAME
Name of subcluster to be stopped
-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).
Setting this implies a timeout of 20 min.
-------------------------------------------------------------------------
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