Metadata-Version: 2.1
Name: qumulo-api
Version: 3.0.1
Summary: API for the Qumulo file system
Home-page: http://www.qumulo.com/
Author: Qumulo, Inc.
Author-email: api@qumulo.com
License: UNKNOWN
Keywords: Q,u,m,u,l,o, ,Q,F,S,D
Platform: UNKNOWN
Description-Content-Type: text/x-rst
Requires-Dist: future (>=0.15.0)
Requires-Dist: tqdm (>=4.24.0)

================
Qumulo API Tools
================

This directory contains a collection of tools and libraries that will help
the user interact with the Qumulo REST API server.

It includes the following:

  - ``qumulo/``: a directory of libraries that can be used to interact with the
    REST API server
  - ``qq``: a comprehensive tool that implements the libraries in ``qumulo/``
    and provides for typical Qumulo CLI control functionality

Using qq
========

To see all commands available from the ``qq`` tool::

    $ ./qq --help

To run commands against the REST API server, you must first login::

    $ ./qq --host host_ip login --user admin

Once authenticated, you can run other commands::

    # Get the network configuation of nodes in the cluster:
    $ ./qq --host host_ip network_poll

    # Get the list of users
    $ ./qq --host host_ip auth_list_users

    # Get help with a specific command
    $ ./qq command --help

Notes
=====

These tools require Python 2.7; they will not run under Python 3.

For more information, visit our Knowledge Base site: https://care.qumulo.com


