ArcaPix GPFS C Library Python API

ArcaPix’s GPFS C Library Python API supports IBM’s GPFS (Spectrum Scale) platform. ArcaPix’s GPFS C Library Python API is licensed under the ArcaPix License API 1.0

Please consult the CHANGELOG.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

An Introduction to the ArcaPix GPFS C Library Python API

The ArcaPix GPFS C Library Python API provides a Pythonic wrapper of the GPFS C API.

ArcaPix’s GPFS C Library Python API closely mirrrors the IBM’s C API. I.E. one to one mappings of IBM’s GPFS C API functions are presented in a Pythonic manner. Familiarity with IBM’s GPFS C API is useful for context, but not required.

Various utility functions are also offered.

ArcaPix’s GPFS C Library Python API is intended to be distributed with the ArcaPix GPFS Python API, but can also be used as a standalone library. CLib offers some functionality not currently available in the Python API.

BETA DISCLAIMER

THE BETA SOFTWARE LICENSED HERE UNDER IS STILL IN TESTING PHASE AND IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS AND IS BELIEVED TO CONTAIN DEFECTS AND A PRIMARY PURPOSE OF THIS BETA TESTING LICENSE IS TO OBTAIN FEEDBACK ON SOFTWARE PERFORMANCE AND THE IDENTIFICATION OF DEFECTS. LICENSEE IS ADVISED TO SAFEGUARD IMPORTANT DATA, TO USE CAUTION AND NOT TO RELY IN ANY WAY ON THE CORRECT FUNCTIONING OR PERFORMANCE OF THE BETA LICENSED SOFTWARE AND/OR ACCOMPANYING MATERIALS.

Bugs, feature requests and patches

Please submit all such items to support@[arcastream|pixitmedia].com.

Obtaining the API

The GPFS C Library Python API is available only to ArcaStream and Pixit Media (‘ArcaPix’) customers. Existing customers can install the API via applying updates or by contacting the support team.

Setup

The API is compatible with Python >= 2.7.6 and IBM GPFS (Spectrum Scale) 3.5.x, 4.0.x, 4.1.x and 4.2.x

Important

It is important on CentOS 6 systems to only use the supplied Python 2.7, not the system python, which is only version 2.6.

The API is provided as a RPM package to be installed on all server nodes in the cluster or via ArcaPix’s PIP repository.

Getting started

To use the API interactively, simply start Python, then import a CLib module’s function(s):

$ python2.7
Python 2.7.9 (default, May 15 2015, 14:50:45)
[GCC 4.4.7 20120313 (Red Hat 4.4.7-11)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from arcapix.fs.gpfs.clib.fssnap import get_fssnaphandle_by_path, get_fsname_from_fssnaphandle
>>>
>>> # Create FssnapHandle object
... fs = get_fssnaphandle_by_path('/gpfs/fs1/testfile.txt')
>>>
>>> # Get Filesystem name
... print get_fsname_from_fssnaphandle(fs)
'fs1'

Licensing

ArcaPix’s GPFS Python API is proprietary commercial software.

You may not distribute the API to any third party.

For further information, please consult the LICENSE file included.

Queries regarding licensing should be forwarded to support@[arcastream|pixitmedia].com.

Indices and tables

Module Index Index Search Page
quick access to all modules all functions, classes, terms search this documentation