The Qumulo API on GitHub
Qumulo's scale-out data storage solution is enhanced with our RESTful API. The API is built right into our file system. It's the foundation used behind the Qumulo web application and is used internally by our engineering team for testing, automation, and more. As a storage admin or storage user, you can use this programmatic power to:
- Automate tasks like creating shares, quotas, or snapshots
- Streamline your workflow with scripted automation
- Dive deeper into analytics to understand how your storage is being used
This page summarizes Qumulo's current offerings on GitHub that compliment and enhance the power of your scale-out storage system. Visit our introduction, or dive into some of the deeper applications and examples below.
Getting started with the Qumulo API
Qumulo API Introduction - Read about the basic architecture of Qumulo's API and try out the following intros:
- python bindings - Our main supported method for programmatically interacting with the Qumulo API.
- qq command line tool - A wrapper that provides a streamlined, command-line interface to the API.
- curl commands - Illustrative example of the raw REST elements backing the API.
Deploying Qumulo in the Cloud
Qumulo Cloud Deployment Samples - Use these samples to get started creating a Qumulo cluster in the cloud, leveraging your favorite Orchestration technology.
Qumulo's Github repositories
Our GitHub repositories are organized into 3 categories. Each category includes code examples that demonstrate a variety of uses of the Qumulo API.
- SNMP agent - A small SNMP agent that reports on node and drive states for a Qumulo cluster.
- File upload web app - Flask-based Python application that enables user home directories, file upload, and management.
- Daily storage reports web app - Store/present/alert on capacity & IOPS usage by path over time with this Flask-based app.
- Capacity email alerts - Small python application that sends email when paths exceed capacity thresholds.
- API metrics to Splunk - A Splunk app/plugin for Qumulo workload data including: paths, clients, IOPS, throughput.
- Disk usage (du) - Leverage the power of Qumulo's aggregates to see usage of a full file tree in real time.
- Parallel copy w/ rsync - Use capacity aggregates to divide up a large data copy job to be run with rsync.
- Capacity by user - Use the file samples API to provide quick estimates of storage usage by user, with estimated costs.
- ACLs management - Manage ACLs with this tool.
Python Jupyter notebooks
- Qumulo API Jupyter notebooks - Explore the API with the data scientist's tool of choice, Python Jupyter notebooks.