stop_subcluster

Stops a subcluster and all its hosts.

Syntax

vcluster stop_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 stop.

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.

--drain-seconds int

[Eon only] The time to wait, in seconds, for user connections to close on their own. When the time expires, user connections are automatically closed and the database is shut down. If set to 0, VCluster closes all user connections immediately. If the value is negative, VCluster waits indefinitely until all user connections close.

Default: 60

--force

Shut down the subcluster immediately even if users are connected.

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

Default: "" (None)

--password-file string

The absolute path to a file containing the database password.

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

--read-password-from-prompt

Prompt the user to enter the password.

--verbose

Show the details of VCluster run in the console

Examples

Stops the subcluster sc1, waiting 10 seconds for user connections to close:

$ vcluster stop_subcluster --subcluster sc1 --drain-seconds 10 \
  --config /opt/vertica/config/vertica_cluster.yaml