sandbox_subcluster

Sandboxes a subcluster in an Eon Mode database.

Sandboxes a subcluster in an Eon Mode database. All hosts in the subcluster must be up. When you sandbox a subcluster, its hosts immediately shut down and restart; the subcluster becomes sandboxed after the hosts start back up.

A sandbox can contain multiple subclusters, and subclusters in the sandbox can interact with each other. If you want to isolate subclusters, they must be in separate sandboxes.

Syntax

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

--sandbox string
The name of the sandbox. This string must conform to the format used for database names.
--subcluster string
The name of the subcluster to sandbox.

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

--read-password-from-prompt
Prompts the user to enter the password.
--verbose
Shows the details of VCluster run in the console.

Examples

To sandbox a subcluster sc1:

$ vcluster sandbox_subcluster --subcluster sc1 --sandbox sand \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 --db-name test_db