manage_config

• 1: manage_config recover
• 2: manage_config show

vcluster manage_config subcommand

1 - manage_config recover

Recreates the vcluster configuration file.

This file is automatically generated in /opt/vertica/config/vertica_cluster.yaml when you use create_db.

Syntax

vcluster manage_config recover options

Required options

--catalog-path string

The absolute path to the catalog directory.

{ -c | --config } string

The path to write the configuration file.

Default: /opt/vertica/config/vertica_cluster.yaml

--hosts strings

A comma-separated list of hosts in database.

Options

--after-revive

Recovers the configuration file after reviving the database. You should only use this if, after reviving the database, you modify the configuration file manually, which is not recommended.

--cert-file string

The absolute path to the certificate file. If you specify this option, you must also specify --key-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.

{ -d | --db-name } string

The name of the database. You should only use this option if you want to override the database name in your configuration file. This string must conform to the format used for database names.

--depot-path string

[Eon only] The absolute path to depot directory.

{ -h | --help }

Prints help text.

--ipv6

Whether the hosts use IPv6 addresses. Hostnames resolve to IPv4 by default.

--key-file string

Path to the key file. If you specify this option, you must also specify --cert-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.

{ -l | --log-path } string

The absolute path for debug logs.

Default: /opt/vertica/log/vcluster.log

--overwrite

Overwrites the existing /opt/vertica/config/vertica_cluster.yaml, if any. If a configuration file already exists and this flag is not specified, recover has no effect.

--verbose

Shows the details of VCluster run in the console.

Examples

Recrates the configuration file in the default location for an Eon Mode database:

$ vcluster manage_config recover --db-name vertica_db \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
  --catalog-path /data --depot-path /data

Recreates the configuration file to a specific path:

$ vcluster manage_config recover --db-name test_db \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
  --catalog-path /data --depot-path /data \
  --config /tmp/vertica_cluster.yaml

2 - manage_config show

Displays the contents of the vcluster configuration file.

This file is automatically generated in /opt/vertica/config/vertica_cluster.yaml when you use create_db.

Syntax

vcluster manage_config show options

Required options

{ -c | --config } string

The path to the config file. If a configuration file is present in the default location (automatically generated by create_db), you do not need to specify this option.

Default: /opt/vertica/config/vertica_cluster.yaml

Options

{ -h | --help }

Prints help text.

{ -l | --log-path } string

The absolute path for debug logs.

Default: /opt/vertica/log/vcluster.log

--verbose

Shows the details of VCluster run in the console.

Examples

Show the configuration file in the default location (/opt/vertica/config/vertica_cluster.yaml):

$ vcluster config show

Show the configuration file at the specified location:

$ vcluster config show --config /tmp/vertica_cluster.yaml