Isilon SDK v0.4.0

isilon_sdk/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dell EMC Isilon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

isilon_sdk/MANIFEST.in

@@ -0,0 +1 @@
+include version_config.json

isilon_sdk/README.rst

@@ -0,0 +1,74 @@
+About
+-----
+
+This package 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.
+
+Installation
+------------
+
+``pip install isilon_sdk``
+
+Example program
+---------------
+
+Please select the subpackage as applicable to the OneFS version of your
+cluster by referring to the below table:
+
+
+OneFS Version and respective subpackage name are as:
+
+9.4.0.0: v9_4_0
+9.5.0.0: v9_5_0     
+9.6.0.0: v9_6_0     
+9.7.0.0: v9_7_0     
+9.8.0.0: v9_8_0     
+9.9.0.0: v9_9_0     
+
+Here’s an example of using the Python PAPI bindings to retrieve a list
+of NFS exports from your clusters
+
+::
+
+   from __future__ import print_function
+
+   from pprint import pprint
+   import time
+   import urllib3
+
+   import isilon_sdk.v9_9_0
+   from isilon_sdk.v9_9_0.rest import ApiException
+
+   urllib3.disable_warnings()
+
+   # configure cluster connection: basicAuth
+   configuration = isilon_sdk.v9_9_0.Configuration()
+   configuration.host = 'https://10.205.228.161:8080'
+   configuration.username = 'root'
+   configuration.password = 'a'
+   configuration.verify_ssl = False
+
+   # create an instance of the API class
+   api_client = isilon_sdk.v9_9_0.ApiClient(configuration)
+   api_instance = isilon_sdk.v9_9_0.ProtocolsApi(api_client)
+
+   # get all exports
+   sort = 'description'
+   limit = 50
+   order = 'ASC'
+   try:
+       api_response = api_instance.list_nfs_exports(sort=sort, limit=limit, dir=order)
+       pprint(api_response)
+   except ApiException as e:
+       print("Exception when calling ProtocolsApi->list_nfs_exports: %s\n" % e)
+
+More Info
+---------------
+See the Github repo for more information:
+https://github.com/isilon/isilon_sdk
+