unsandbox_subcluster

Removes a subcluster from the sandbox, "unsandboxing" it. When you unsandbox a subcluster, its hosts immediately shut down and restart. When the hosts come back up, the subcluster is unsandboxed.

When a subcluster is unsandboxed, you should manually delete that subcluster's metadata in communal storage before attempting to add a subcluster to that sandbox again. For example, if you unsandbox subcluster sc1, you should delete the directory path_to_catalog_of_sc1/metadata/sandbox_name.

Syntax

$ vcluster unsandbox_subcluster 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

--subcluster string

The name of the subcluster to be unsandboxed.

Options

--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.

{ -h | --help }

Prints help text.

--hosts strings

A comma-separated list of hosts in the database. This must include at least one up host from the primary subcluster.

--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

{ -p | --password } string

The database password.

--password-file string

The absolute path to a file containing the database password.

If you pass a dash(-) (that is, `--password-file -`), the password is read from STDIN.

Important

Your database password cannot include single quotes.

--read-password-from-prompt

Prompts the user to enter the password.

--verbose

Shows the details of VCluster run in the console.

Examples

To unsandbox subcluster sc1:

$ vcluster unsandbox_subcluster --subcluster sc1 \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 --db-name vertica_db