list_packages

Lists all available packages and their installation status.

Lists all available packages and their installation status. It automatically detects the database state:

Database UP: Displays the installation status of each package.
Database DOWN: Lists only the packages available on the filesystem.

Syntax

vcluster list_packages options

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 path to the certificate file.
Default: /opt/vertica/config/https_certs/{username}.pem

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

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

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

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

--package string: Select packages using all, default, specific package name, or comma-separated list of package names.
Default: all

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

To list all the available packages:

vcluster list_packages

To list all the packages with installation status for a database:

vcluster list_packages --db-name test_db \
    --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
    --password <PASSWORD>

To list specfic packages with status:

vcluster list_packages \
    --package default \
    --config <config_file_path> \
    --password <PASSWORD>