stop_node

Stops one or more nodes in a database.

You must provide the host list with the --stop-hosts option followed by one or more hosts to stop as a comma-separated list.

Syntax

vcluster stop_node options

Required options

{ -c | --config } string

The path to the configuration 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

--stop-hosts string

Comma-separated list of host(s) to stop.

Options

--ca-cert-file string

The path to the trusted CA certificate file.

Default: /opt/vertica/config/https_certs/rootca.pem

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

--force-kill

Forces node termination using SIGKILL instead of a graceful shutdown (SIGTERM).

Caution

This option may cause data loss. Use it only if a graceful shutdown fails.

{ -h | --help }

Prints help text.

--hosts strings

A comma-separated list of hosts in the database.

--ipv6

Specifies if the hosts use IPv6 addresses.

Default: IPv4

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

--tls-mode string

Sets the TLS validation mode. Valid options are enable, verify-ca, verify-full.

Default: enable

--use-password-for-sql-client-only

Use the password for the NMA SQL client only.

--verbose

Shows the details of VCluster run in the console.

Examples

Stop the node on 192.0.2.0 and 192.0.2.1:

$ vcluster stop_node --stop-hosts 192.0.2.0,192.0.2.1 \
  --config /home/dbadmin/vertica_cluster.yaml