Installing VSP One SDS Block 's CLI program

Install the CLI program so that you can run the VSP One SDS Block CLI. You can obtain a CLI package for installing a CLI program from the downloaded file.

CLI package file (.whl)

Package file for installing CLI in the controller node.

The file name is hsds_cli-<version>.<number>-py3-none-any.whl.

Example: hsds_cli-1.18.0.60.0000-py3-none-any.whl

To copy the CLI program on a controller node, you can, for example, copy the file from Cloud Storage by using a gcloud CLI. For details about example operations, see Example gcloud CLI operations.

Note:

The version of VSP One SDS Block is indicated in the following format: aa.bb.cc.dd.

The <version> value in the name of the CLI package (.whl) is indicated with the second zero (0) of aa, bb, cc, and dd (respectively) removed.
Prepare the CLI package file (.whl) of the same version as that of the storage cluster of VSP One SDS Block to be set up. Here, <number> is a four-digit user-specified numeric value.
When you create a new storage cluster or update (upgrade or downgrade) the storage software, verify that the CLI program version installed in the controller node matches the storage software version.

If you want to upgrade a CLI program, you can perform an update installation using the same procedure as that for a new installation.

If you want to downgrade a CLI program, first perform the uninstallation operation by using the following command, and then perform a new installation.
- For Windows:
```
> py -m pip uninstall hsds_cli
```
- For Linux:
```
# python3 -m pip uninstall hsds_cli
```
If you run the CLI when the CLI program version is older than the storage software version, a warning message that prompts you to upgrade the CLI program version to the same as or later than the storage software version will be output to the standard error output.

The CLI package must be downloaded.
When a virtual environment is used, venv must be installed.
The controller node should be able to access the python repository.

If the controller node cannot access the python repository, download all required dependent packages required by the CLI at another terminal that can access the python repository, transfer them to the controller node, and then install them in the controller node.

When a virtual environment is used, install the dependent packages in the virtual environment.

For the versions of the dependent packages of the CLI program, see Installing the prerequisite packages.

Log in to the Compute Engine instance for a controller node.
Switch to the root user.

When a virtual environment is used, following steps within the virtual environment.
Upgrade installed pip.
```
# python3 -m pip install --upgrade pip
```
Install the CLI package.
```
# python3 -m pip install <folder-to-which-the-CLI-package-is-to-be-downloaded>/hsds_cli-<version>.<number>-py3-none-any.whl
```
CAUTION:
- Verify that you install a CLI package as a root user. If you install a CLI package as a user other than a root user, uninstall the CLI package by running the following command as the user who installed the package.
```
# python3 -m pip uninstall hsds_cli
```
- If a warning message appears or failure occurs when installing the package as a root user, use the virtual environment.
Note:
If the controller node can access the python repository, the latest versions of dependent packages of the CLI program are automatically installed upon execution of the command.