================
Qumulo API Tools
================
This package contains the Qumulo Core Python SDK and the qq CLI utility, which
allow users to interact with the Qumulo REST API server.
Using the Python SDK
====================
To get started, import the `RestClient` class from the `qumulo.rest_client`
module and create an instance. The `RestClient` class contains attributes
that allow programmatic access to all of the Qumulo Core REST API endpoints.
For example::
from qumulo.rest_client import RestClient
# Create an instance of RestClient associated with the Qumulo Core file
system at qumulo.mycompany.net
rc = RestClient("qumulo.mycompany.net", 8000)
# Log in to Qumulo Core using local user or Active Directory credentials
rc.login("username", "password")
# Print all of the SMB share configuration information
print(rc.smb.smb_list_shares())
To inspect the various available properties, open a Python REPL and run the
following commands::
from qumulo.rest_client import RestClient
rc = RestClient("qumulo.mycompany.net", 8000)
# See REST API groups:
[p for p in dir(rc) if not p.startswith('_')]
# See SDK endpoints within a particular API group
[p for p in dir(rc.quota) if not p.startswith('_')]
Using qq
========
After installing the qumulo-api package, the `qq` CLI utility will be installed
in your system.
Note: On Windows, `qq.exe` can be found under the `Scripts\\` directory in your
Python installation. Adding this path your your `%%PATH%%` environment variable
will allow you to run `qq.exe` without prefixing it with the full path.
To see all commands available from the ``qq`` tool::
$ qq --help
To run most 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 <qumulo_host> network_poll
# Get the list of users
$ qq --host <qumulo_host> auth_list_users
# Get help with a specific command
$ qq --host <qumulo_host> auth_list_users --help
To see the information about the actual HTTP requests and responses sent over
the wire for a particular command, use the `--debug` flag::
$ qq --host <qumulo_host> --debug smb_settings_get
REQUEST: GET https://<qumulo_host>:8000/v1/smb/settings
REQUEST HEADERS:
User-Agent: qq
Content-Type: application/json
Content-Length: 0
Authorization: Bearer <token>
RESPONSE STATUS: 200
RESPONSE:
Date: Fri, 18 Mar 2022 22:15:47 GMT
ETag: "VNhqnQ"
Content-Type: application/json
Content-Length: 329
Strict-Transport-Security: max-age=31536000; includeSubdomain
{'session_encryption': 'NONE', 'supported_dialects': ['SMB2_DIALECT_2_002', 'SMB2_DIALECT_2_1', 'SMB2_DIALECT_3_0', 'SMB2_DIALECT_3_11'], 'hide_shares_from_unauthorized_users': False, 'hide_shares_from_unauthorized_hosts': False, 'snapshot_directory_mode': 'VISIBLE', 'bypass_traverse_checking': False, 'signing_required': False}
Notes
=====
For more information, visit our Knowledge Base site: https://care.qumulo.com
Raw data
{
"_id": null,
"home_page": "http://www.qumulo.com/",
"name": "qumulo-api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "Qumulo QFSD",
"author": "Qumulo, Inc.",
"author_email": "python@qumulo.com",
"download_url": null,
"platform": null,
"description": "================\nQumulo API Tools\n================\n\nThis package contains the Qumulo Core Python SDK and the qq CLI utility, which\nallow users to interact with the Qumulo REST API server.\n\nUsing the Python SDK\n====================\n\nTo get started, import the `RestClient` class from the `qumulo.rest_client`\nmodule and create an instance. The `RestClient` class contains attributes\nthat allow programmatic access to all of the Qumulo Core REST API endpoints.\n\nFor example::\n\n from qumulo.rest_client import RestClient\n\n # Create an instance of RestClient associated with the Qumulo Core file\n system at qumulo.mycompany.net\n rc = RestClient(\"qumulo.mycompany.net\", 8000)\n\n # Log in to Qumulo Core using local user or Active Directory credentials\n rc.login(\"username\", \"password\")\n\n # Print all of the SMB share configuration information\n print(rc.smb.smb_list_shares())\n\nTo inspect the various available properties, open a Python REPL and run the\nfollowing commands::\n\n from qumulo.rest_client import RestClient\n\n rc = RestClient(\"qumulo.mycompany.net\", 8000)\n\n # See REST API groups:\n [p for p in dir(rc) if not p.startswith('_')]\n\n # See SDK endpoints within a particular API group\n [p for p in dir(rc.quota) if not p.startswith('_')]\n\nUsing qq\n========\n\nAfter installing the qumulo-api package, the `qq` CLI utility will be installed\nin your system.\n\nNote: On Windows, `qq.exe` can be found under the `Scripts\\\\` directory in your\nPython installation. Adding this path your your `%%PATH%%` environment variable\nwill allow you to run `qq.exe` without prefixing it with the full path.\n\nTo see all commands available from the ``qq`` tool::\n\n $ qq --help\n\nTo run most commands against the REST API server, you must first login::\n\n $ qq --host host_ip login --user admin\n\nOnce authenticated, you can run other commands::\n\n # Get the network configuation of nodes in the cluster:\n $ qq --host <qumulo_host> network_poll\n\n # Get the list of users\n $ qq --host <qumulo_host> auth_list_users\n\n # Get help with a specific command\n $ qq --host <qumulo_host> auth_list_users --help\n\nTo see the information about the actual HTTP requests and responses sent over\nthe wire for a particular command, use the `--debug` flag::\n\n $ qq --host <qumulo_host> --debug smb_settings_get\n\tREQUEST: GET https://<qumulo_host>:8000/v1/smb/settings\n\tREQUEST HEADERS:\n\t\tUser-Agent: qq\n\t\tContent-Type: application/json\n\t\tContent-Length: 0\n\t\tAuthorization: Bearer <token>\n\tRESPONSE STATUS: 200\n\tRESPONSE:\n\tDate: Fri, 18 Mar 2022 22:15:47 GMT\n\tETag: \"VNhqnQ\"\n\tContent-Type: application/json\n\tContent-Length: 329\n\tStrict-Transport-Security: max-age=31536000; includeSubdomain\n\n\n\t{'session_encryption': 'NONE', 'supported_dialects': ['SMB2_DIALECT_2_002', 'SMB2_DIALECT_2_1', 'SMB2_DIALECT_3_0', 'SMB2_DIALECT_3_11'], 'hide_shares_from_unauthorized_users': False, 'hide_shares_from_unauthorized_hosts': False, 'snapshot_directory_mode': 'VISIBLE', 'bypass_traverse_checking': False, 'signing_required': False}\n\nNotes\n=====\n\nFor more information, visit our Knowledge Base site: https://care.qumulo.com\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Qumulo Python SDK",
"version": "7.3.1.2",
"project_urls": {
"Homepage": "http://www.qumulo.com/"
},
"split_keywords": [
"qumulo",
"qfsd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0eb45948fc89db3261c913af375c6794eff0a77b510a94d9ed44dbeb6717477f",
"md5": "973e49f3912aa47454c8a70184c5544c",
"sha256": "e8f39c7375c06eb8a032f8517323265226371a484271a7dcdd41130c446903de"
},
"downloads": -1,
"filename": "qumulo_api-7.3.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "973e49f3912aa47454c8a70184c5544c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 291765,
"upload_time": "2024-12-06T19:58:19",
"upload_time_iso_8601": "2024-12-06T19:58:19.132988Z",
"url": "https://files.pythonhosted.org/packages/0e/b4/5948fc89db3261c913af375c6794eff0a77b510a94d9ed44dbeb6717477f/qumulo_api-7.3.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 19:58:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "qumulo-api"
}
JSON