aerpawgw-client

This is Aerpaw gateway service to interact with Emulab

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/AERPAW-Platform-Control/aerpaw-gateway-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import aerpawgw_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import aerpawgw_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import aerpawgw_client
from aerpawgw_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = aerpawgw_client.ExperimentApi(aerpawgw_client.ApiClient(configuration))
body = aerpawgw_client.Experiment() # Experiment | Experiment Object

try:
    # create a experiment
    api_response = api_instance.create_experiment(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentApi->create_experiment: %s\n" % e)

# create an instance of the API class
api_instance = aerpawgw_client.ExperimentApi(aerpawgw_client.ApiClient(configuration))
experiment = 'experiment_example' # str | experiment to delete
username = 'username_example' # str | username for the request (optional)
project = 'project_example' # str | project name (optional)

try:
    # delete experiment
    api_instance.delete_experiment(experiment, username=username, project=project)
except ApiException as e:
    print("Exception when calling ExperimentApi->delete_experiment: %s\n" % e)

# create an instance of the API class
api_instance = aerpawgw_client.ExperimentApi(aerpawgw_client.ApiClient(configuration))
username = 'username_example' # str | username for the request (optional)

try:
    # get experiment(s) under user
    api_response = api_instance.get_experiments(username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentApi->get_experiments: %s\n" % e)

# create an instance of the API class
api_instance = aerpawgw_client.ExperimentApi(aerpawgw_client.ApiClient(configuration))
experiment = 'experiment_example' # str | experiment name to query
username = 'username_example' # str | username for the request (optional)
project = 'project_example' # str | project name (optional)

try:
    # get status of specific experiment
    api_response = api_instance.query_experiment(experiment, username=username, project=project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExperimentApi->query_experiment: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://0.0.0.0:8080/aerpawgateway/1.0.0

Class	Method	HTTP request	Description
ExperimentApi	create_experiment	POST /experiment	create a experiment
ExperimentApi	delete_experiment	DELETE /experiment	delete experiment
ExperimentApi	get_experiments	GET /experiments	get experiment(s) under user
ExperimentApi	query_experiment	GET /experiment/{experiment}	get status of specific experiment
ProfileApi	create_profile	POST /profile	create profile
ProfileApi	delete_profile	DELETE /profile	delete profile
ProfileApi	get_profiles	GET /profiles	get profiles under user
ProfileApi	query_profile	GET /profile	query specific profile
ReservationApi	create_reservation	POST /reservation	create reservation
ReservationApi	delete_reservation	DELETE /reservation	delete reservation
ReservationApi	get_reservation	GET /reservation	get reservation under user
ResourcesApi	list_resources	GET /resources	list resources
ResourcesApi	parse_resources	POST /resources/parse_script	Parse resources
UserApi	adduser	POST /user	add/update user and sshkey on experiment nodes
VersionApi	get_version	GET /version	API version

Documentation For Models

• ApiResponse
• Experiment
• Node
• Profile
• Reservation
• Resource
• Userkey
• Vnode

Documentation For Authorization

All endpoints do not require authorization.

Author

ericafu@renci.org