QQ CLI: Install Command-Line Tools

Lindsie

Updated May 16, 2022 18:12

REQUIREMENTS

A cluster running Qumulo Core
Python 3.8 (or higher)

DETAILS

Qumulo Core offers Command-Line Tools in different forms based on your cluster's software version. The following sections give instructions for Qumulo Core 2.14.5 (and higher) and 2.14.4 (and lower).

QUMULO CORE 2.14.5 (OR HIGHER)

Log in to the Qumulo Core Web UI.
Click APIs & Tools > Download qq Command-Line Tool for Python 3.8+.
Your browser downloads the qq file.

Windows

On Windows, you can run a qq command using the python.exe interpreter. For example:

python.exe /Users/qumulo_user/qq

MacOS or Linux

On MacOS or Linux, you can run a qq command using the python interpreter.

python ~/qq

To run the file directly, configure its executable bit.

chmod +x ~/qq
~/qq

QUMULO CORE 2.14.4 (OR LOWER)

Log in to the Qumulo Core Web UI.
Click API & Tools > Download Command-Line Tools.
Your browser downloads the qumulo_api.zip file.
Extract the contents of the file.

To be able to execute the Command-Line Tools from anywhere, you must configure your system variables.

Windows

Add thequmulo_api, Python36, and Python36\scripts directories to your system's PATH variable.
Add the .PY extension to your system's PATHEXT variable.
Rename qq to qq.py.

MacOS or Linux

Run the sudo nano etc/paths command and enter your password.
Add the path to the qumulo_api directory to the bottom of the file.
To verify your configuration, run the echo $PATH command.

For more information about using Command-Line Tools, see QQ CLI: Get Started.

INSTALLING THE COMMAND-LINE TOOLS USING THE PYTHON SDK

You can also install the Qumulo API Tools using the Python SDK by running the following command.

pip install qumulo_api

The qq file (qq.exe for Qumulo Core 3.1.4 and higher) is installed in the Scripts directory, next to your Python installation (for example, C:\Python36\Scripts).

To allow qq.exe to be executed from anywhere, add this directory to your system's PATH.

RESOLUTION

You can now install and use the Qumulo Command-Line Tools.

ADDITIONAL RESOURCES

QQ CLI: Get Started

QQ CLI: Comprehensive List of Commands

Explore the API with qq raw

Like what you see? Share this article with your network!

Was this article helpful?

1 out of 3 found this helpful

Comments

4 comments

Lee Duckett
June 11, 2018 13:37

This utility seems to have a requirement not listed in the "REQUIREMENTS" section. I think that it also requires you to have Python installed.

0
Lindsie
June 11, 2018 17:29

Hi Lee!

Thanks for calling that missing requirement to our attention. Python 2.7 has been added to the section to ensure users know what they need to successfully install the qq command-line tools. Reach out if you need anything else!

0
Stefan Radtke
January 20, 2020 11:51
Lindsie, the command to verify the PATH variable has changes on MacOS is
```
echo $PATH
and not 
echo $PATHS
```
Appreciate if you can remove the S.

Thanks, Stefan
0
Lindsie
January 22, 2020 00:02

Thanks for the feedback Stefan! This change has been made in the documentation. Reach out with any additional suggestions you may have.

0