+ Developer Guide Overview

From OSNEXUS Online Documentation Site
Revision as of 12:46, 23 August 2012 by Qadmin (Talk | contribs)

Jump to: navigation, search

QuantaStor was designed from the ground up so that you can develop your own applications to remotely manage your storage systems.

Supported Languages

You can use just about any programming language you like to communicate with QuantaStor via our RESTful API. Recommended tools:

  • C/C++ - libcurl [1]
  • Python - PyCurl [2]
  • Unix/Linux/VMware/XenServer scripting - curl [3]
  • PHP curl - [4]

Async vs. Sync API calls

Task Monitoring

Security

QuantaStor REST interface always uses SSL via HTTPS. You can change the pem keys on your system by replacing the qstorapi_server.pem file located in /opt/osnexus/quantastor/restsrv/. If you want to use plain HTTP without SSL you can rename or remove the qstorapi_server.pem and the RESTful service will automatically fall back to using HTTP. After removing the file just restart the RESTful service interface with: service restsrv restart

Supported SOAP / WebServices Implementations

  • gSOAP (C++, all platforms)
  • Apache Axis (Java, all platforms)
  • .NET (C# & Visual Basic, Windows)

API List

userAdd API

Adds a new user to the system. User accounts can access QuantaStor via the web management interface, remote scripting and via the qstorapi RESTful API.

Example

curl -U username:password -k https://hostname:8153/userAdd?username=tiger&password=passWORD1&firstName=Tiger&lastName=Woods&role=Administrator

Argument List

  • username: <xs:string>
  • defaultChapPassword: <xs:string>
  • alertSubscriptions: <xs:unsignedInt>
  • description: <xs:string>
  • firstName: <xs:string>
  • lastName: <xs:string>
  • flags: <xs:unsignedInt>
  • emailAddress: <xs:string>
  • role: <xs:string>
  • password: <xs:string>
  • defaultChapUsername: <xs:string>