Database management with VCluster
The VCluster CLI (or vcluster) is a tool for administering your database. This tool is bundled with Vertica installations. VCluster communicates with Vertica nodes by leveraging the REST APIs provided by Node Management Agent and HTTPS service.
Note
The VCluster CLI is targeted primarily for managing Eon Mode databases. While you can create and manage Enterprise Mode databases, the suite of commands for doing so is less complete. For a more complete set of Enterprise Mode management tools, see Administration tools reference.Prerequisites
To use the VCluster CLI, you must first configure the Node Management Agent (NMA), including running the following command on all nodes:
$ /opt/vertica/bin/manage_node_agent.sh start node_management_agent
Note
If the Vertica host is stopped and restarted, you must restart the NMA to ensure proper functionality.Best practices
The majority of vcluster commands use the configuration file, which is automatically created when you create a database. You should always use this configuration file when using vcluster, either by ensuring that the configuration file is in the default location (/opt/vertica/config/vertica_cluster.yaml) or specifying it with --config.
To recreate a configuration file, use manage_config recover. This can be useful if you lose your configuration file or if it becomes corrupted.
To view your current configuration file, use manage_config show.