Language bindings for the OneFS API and tools for building them
This repository is part of the Isilon SDK. It includes language bindings for easier programmatic access to the OneFS API for cluster configuration (on your cluster this is the REST API made up of all the URIs underneath https://[cluster]:8080/platform/*, also called the "Platform API" or "PAPI"). The SDK also includes language bindings for the OneFS RAN (i.e. RESTful Access to Namespace) interface, which provides access to the OneFS filesystem namespace.
You can download the language bindings for Python from the "releases" page of this repo (the link is on the main "code" tab on the bar of links just below the project description). If you just want to access PAPI more easily from your Python programs, these language bindings may be all you need, and you can follow the instructions and example below to get started.
This repository also includes tools to build PAPI bindings yourself for a large range of other programming languages. For more info see the readme.dev.md file in this directory.
| Cluster Version | Install Instruction |
|---|---|
| OneFS 8.1.1 and later | pip install isi_sdk_8_1_1 |
| OneFS 8.1.0 and later | pip install isi_sdk_8_1_0 |
| OneFS 8.0.1 and later | pip install isi_sdk_8_0_1 |
| OneFS 8.0 and later | pip install isi_sdk_8_0 |
| OneFS 7.2 and later | pip install isi_sdk_7_2 |
Installation will default to using binary distribution wheel (i.e. bdist). Source distributions (i.e. sdist) are also available on pip beginning with v0.1.6 and can be installed with pip install --no-binary :all: <pkg name>
See the generated packages on PyPI for example code:
The most up-to-date documentation for the language bindings is included in the root directory of your downloaded release package (or of your own generated bindings if you've generated your own using the instructions at readme.dev.md). It is a set of markdown files starting with the README.md in the root directory of the package. Otherwise, the documentation for the Python language bindings can be found in the isilon_sdk_python repository where the branch names are associated with the OneFS release that the bindings were built against.
- For OneFS API reference documents, discussions, and blog posts, refer to the Isilon SDK Info Hub.
- To browse the Isilon InsightIQ statistics API, refer to the Stat Key Browser Github repository.