Chapter 5: vStor Command Line Interface Reference

Post-installation and initialization of vStor storage, you may need to configure and manage aspects like network settings or storage pools. The vStor CLI offers granular management, complementing the vStor Management Interface.

The vStor Command Line Interface

Attention! Executing vStor CLI commands without understanding their functions can lead to data loss. It is advised to use these commands primarily under the guidance of Catalogic Software Support to ensure safe and correct operation.

You can run vstor command as root or a user with administrative privileges.

Use the vstor user create command to create a new vStor user and assign it admin privileges.

For default access and credentials, see Initializing vStor.

Using the CLI

The CLI consists of several commands and subcommands that manage various aspects of your vStor instance.

To list all the available commands use:

vstor --help

[admin@someusername ~]$ vstor --help
Usage: vstor [OPTIONS] COMMAND [ARGS]...

Options:
  --json     Show output in JSON format.
  --summary  Show output in summary (tabular) format.
  --detail   Show output in detail (multiline) format.
  --help     Show this message and exit.

Commands:
  authenticator  Manage authenticators.
  disk           Manage disks.
  host           Manage volume host mappings.
  minio          Manage MinIO servers.
  ...

You can pass the --help flag to any command or subcommand to view usage help, for example:

vstor pool create --help

[admin@someusername ~]$ vstor pool create --help
Usage: vstor pool create [OPTIONS]

    Create a storage pool.
Options:
    --name TEXT           Pool name. [required]
    --pool_type TEXT      Pool type: raid0 (default), raid5, raid6.
    --compression         Enable compression: on (default) or off.
    ...

To use any of the options provided by the command, simply call the option and provide your value:

vstor pool create --name pool1

vstor pool create --name pool1                                                                                                                                                                                                                                                                                                                                                                      ID: 5                                                                                                 NAME: pool1                                                                                           POOL TYPE: raid0                                                                                      STATE: ONLINE                                                                                         HEALTH: 100                                                                                           COMPRESSION: Yes                                                                                      COMPRESSION RATIO: 1.00                                                                               DEDUPLICATION: No                                                                                     DEDUPLICATION RATIO: 1.00                                                                             SYNC WRITE: No                                                                                        TOTAL SPACE: 96.39GB                                                                                  FREE SPACE: 96.39GB                                                                                   USED SPACE: 156.50KB                                                                                  DATA SIZE BEFORE DEDUPLICATION: 117.00KB                                                              DATA SIZE BEFORE COMPRESSION: 43.00KB                                                                 CREATED: 2023-11-23 14:04:43 UTC                                                                      UPDATED: 2023-11-23 14:04:43 UTC                                                                      DISKS PER RAID GROUP: 1                                                                               DISKS IN POOL:                                                                                            RAID0:                                                                                                    /dev/sdb1