list_all_nodes

Returns the following information on all nodes:

Returns the following information on all nodes:

  • IP address
  • Name
  • State
  • Catalog path
  • Subcluster
  • Sandbox
  • Whether the subcluster is primary
  • Database version

The major states a node can be in are UP and DOWN. Other states are largely transitional.

Syntax

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

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

{ -o | --output-file } string
Writes the output to the specified file instead of STDOUT.

Default: STDOUT

{ -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 list the status of nodes for a password-protected database:

$ vcluster list_allnodes --password testpassword \
  --config /opt/vertica/config/vertica_cluster.yaml