Installing the Linux CLI Utility

HPE Cloud Volumes provides a Linux CLI utility called cvctl that enables you to:

  • Attach and detach volumes to and from a cloud VM
  • Connect and disconnect volumes to and from a cloud VM
  • Display a list of volumes that are connected to a cloud VM
  • Display information about specific volumes
  • Create and destroy volumes
  • Display, create, and manage replica stores, replica volumes, replica volume collections, and other replica artifacts.

To install the Linux CLI utility:

  1. Download the utility from the Downloads section of the HPE CV portal into your Cloud VM using either wget or by using the following command:

    curl -LO https://docs.cloudvolumes.hpe.com/tools/cvctl.tar.gz
    

    Note: You can also download the utility from the Downloads section of the HPE CV portal or the Cloud VM Attachment wizard and copy it to the VM separately.

  2. Extract the utility from the downloaded file using the following command:

    tar vxf cvctl.tar.gz
    
  3. Configure the utility by running the following command using your Access Key, Access Secret, and Geography code for your country:

    ./cvctl create config  --access-key <key> --access-secret <secret> --default-geo <geo>
    

    The geo value for the United States is us or US. To locate and copy your Access Key and Access Secret, click User Settings from the user icon menu.

    Note: If you just want to use the utility to connect to or disconnect from a cloud volume, add the --local-mode option to configure cvctl without an Access Key or an Access Secret.

    ./cvctl create config --local-mode
    
  4. (Optional) If you need to delete the configuration that you created in the previous step, run the following command

    ./cvctl delete config
    

    However, if you delete the configuration, you must configure the utility again in order to use it.

To display all available options for the cvctl command, type cvctl --help

Related Topics: