IN THIS ARTICLE
Outlines how to install QQ Command-Line Tools from the Web UI of Qumulo Core
REQUIREMENTS
- Cluster running Qumulo Core
- Python 2.7 or Python 3.6 or above
- Admin privileges on the Qumulo cluster
DETAILS
Qumulo Core offers Command-Line Tools in different forms based on the software version your cluster is running. Refer to the section below that corresponds to your current version.
QUMULO CORE 2.14.5 OR ABOVE
- Log in to the Qumulo Core Web UI.
- Select APIs & Tools.
- Click the Download qq Command-Line Tool button.
- Copy the downloaded qq file to your home directory to ensure that only you are able to run the qq command on the computer where you are installing. If others need access, copy qq to one of the following:
- Apple and Linux computers - copy to /opt/
- Windows - copy to C:\Program Files (x86)\
Windows
On Windows, the qq file must be run with the python.exe 2.7 interpreter:
$ python.exe /Users/qumulo_user/qq
NOTE: You can also install the Qumulo API tools via the Python SDK by running the command below. The qq file (qq.exe for Qumulo Core 3.1.4 and higher) is installed in the Scripts directory next to your Python installation (e.g., C:\Python27\Scripts). Add that directory to your PATH to allow qq.exe to be executed from anywhere.
$ pip install qumulo_api
Mac/Linux
On Mac and Linux, the qq file can be run with the python 2.7 interpreter:
$ python ~/qq
Alternatively, you can configure the file's executable bit and run it directly:
$ chmod +x ~/qq
QUMULO CORE 2.14.4 OR BELOW
- Log in to the Qumulo Core Web UI.
- Select API & Tools.
- Click Download Command-Line Tools button.
- Unzip the downloaded file on your computer.
- Copy the qumulo_api directory to your home directory to ensure that only you are able to run the qq command on the computer where you are installing. If others need access, copy the qumulo_api directory to one of the following:
- Apple and Linux computers - copy to /opt/
- Windows - copy to C:\Program Files (x86)\
Lastly, you'll need copy the qumulo_api directory to your system's PATH to use the qq command from any location in the file system while in your CMD prompt or terminal.
Windows
- Go to Control Panel, select System, click Advanced System Settings, and select Environmental Variables
- Navigate to the System variables section and add the following paths to the Path System variable
- C:\Python27\
- C:\Python27\scripts
- C:\Program Files (x86)\qumulo_api
- Add the .PY Extension to the list of variable values in the PATHEXT System variable
- Click OK to close the Environment Variable dialogue box, then OK again to close the System Properties dialogue box
- Browse to C:\Program Files (x86)\qumulo_api
- Right click on the qq file and rename it to qq.py
You can now open up the Powershell or Command Prompt applications to interact with a Qumulo cluster from a windows workstation or server.
Mac
- Open a Terminal window
- Run the following command:
sudo nano etc/paths - Enter your password when prompted
- Enter the path of the qumulo_api folder at the bottom of the file:
- Type control-X to exit
- Type Y and hit Enter to save the change
- Launch a new Terminal window and run the following command to verify:
echo $PATH
You can now open up a Terminal window and interact with a Qumulo cluster from a Mac workstation.
For additional details for using command-line tools, reference the QQ CLI: Get Started article for more information.
RESOLUTION
You should now be able to successfully install QQ Command-Line Tools in Qumulo Core
ADDITIONAL RESOURCES
QQ CLI: Comprehensive List of Commands
Like what you see? Share this article with your network!
Comments
5 comments
This utility seems to have a requirement not listed in the "REQUIREMENTS" section. I think that it also requires you to have Python installed.
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!
Lindsie, the command to verify the PATH variable has changes on MacOS is
echo $PATHand not
echo $PATHS
Appreciate if you can remove the S.
Thanks, Stefan
Thanks for the feedback Stefan! This change has been made in the documentation. Reach out with any additional suggestions you may have.
The documentation for Windows deployment does not work. I've tried it running Windows 10 several times now and the documentation does not provide the appropriate steps to get qq operating locally on a system. This is both for versions running Python 2.7 & for Python 3.6.
It might be good to separate these instructions so that there are a Windows, Mac & Linux based version of these instructions.
I'm working on trying to complete a step-by-step w/ Pre-requisites for Windows 10 right now, but I error out at Step 4 running the Python Interpreter:
python.exe /Users/qumulo_user/qq
I've been told there may be a requirement for WSL (WIndows Subsystem for Linux) to be installed first, but that is not called out in the Install documentation above. As I mentioned above, having clear documentation that calls out Prerequisites, How-To, & then a section on keeping qq client tools up to date (Since the commands may change due to updated Qumulo Core Updates) would be outstanding.
Please sign in to leave a comment.