VAST Database CLI Quick Start Guide

Follow the steps below to get started using VAST Database CLI. Use the CLI to access the VAST Catalog and Audit Log tables in the VAST Database.

System Requirements

Obtain the following from your VMS administrator:

S3 access key pair
Host IP(s). This should be one or more IPs belonging to one of the cluster's VIP pools.

Download the image from the Docker repository:
```
docker pull vastdataorg/vast-db-cli:<version>
```
where <version> is the VAST CLI version (eg 5.1.0).
Note
If you cannot pull from Docker, you can download a tar file with the image instead.
Download vast-db-cli from the VAST DB CLI repository.
Do one of the following:
- Move vast-db-cli into the bin/ directory.
- Make vast-db-cli executable: chmod +x vast-db-cli
Execute the script.
The VAST Database CLI is now installed.

To start using the VAST Database CLI, run the vast-db-cli configure command:

$ vast-db-cli configure
    Access Key: <access-key>
    Secret Access Key: <secret-key>
    Host IP: <Host IPs>
    Port: 80

Specify <Host IPs> as a one or more IP addresses, separated by commas.

VAST Database CLI is now installed and configured.

For information about how to use the VAST Database CLI, run the following command:

$ vast-db-cli --help

Use this syntax for the vast-db-cli:

vast-db-cli <VAST-database-table> command [--<options>]

where <VAST-database-table> is the table in the database. This can be audit-log for the Audit Log, or catalog for the Catalog.

These commands apply for the Catalog:

Command	Description	Usage
catalog query	Run queries on the VAST Catalog	vast-db-cli catalog query --path=/project/myProject
catalog snapshots	List snapshots of the VAST Catalog	vast-db-cli catalog snapshots
catalog columns	List the columns of the VAST Catalog	vast-db-cli catalog columns --list