Skip to content

Latest commit

 

History

History
114 lines (80 loc) · 3.65 KB

README.md

File metadata and controls

114 lines (80 loc) · 3.65 KB
Raw

Abiquo API Command Line Tool

This project is a simple command line tool for the Abiquo Cloud Platform API, using Jython as a wrapper to the Official Java client. To understand the code and adapt it to your needs, you may want to take a look at the official Java client project page:

Prerequisites

To run the examples you will need to install Maven >= 2.2.1, JRE >= 1.6 and Jython >= 2.5.2.

Configuration

Since this project is currently in development process and we don't have any egg package ready, the $JYHTONPATH environment variable needs to be set manually:

export JYTHONPATH=$(YOUR_PROJECT_HOME_DIRECTORY)

You must also copy the examples/kahuna.conf file to $HOME/.kahuna/kahuna.conf and edit it to configure the connection to your Abiquo Platform. It is also a good choice to add the script to your PATH. You could simply create a symlink to the kahuna script in /usr/local/bin:

cd <kahuna source directory>
cp config/kahuna.conf ~/.kahuna/kahuna.conf  # The edit the file accordingly
chmod u+x kahuna.sh
ln -s $(pwd)/kahuna.sh /usr/local/bin/kahuna

Running

You can run now the command line as follows. If you run it without parameters, it will print the help with all the available options:

$ kahuna

Usage: kahuna.sh <plugin> <command> [<options>]
The following plugins are available:

Environment generator plugin usage:
  env create     Creates the environment. 
  env clean      Cleans up the environment. 

Interactive shell plugin usage:
  shell open     Opens an interactive shell. 

Virtual machine plugin usage:
  vm find        Find a virtual machine given its name. 
  vm list        List all virtual machines.

Use it interactively

You can also perform actions against the Api in an interactive way. You just need to use the 'shell' plugin as follows:

$ kahuna shell open
Jython 2.5.2 (Release_2_5_2:7206, Mar 2 2011, 23:12:06) 
[Java HotSpot(TM) Server VM (Sun Microsystems Inc.)] on java1.6.0_18
Type "help", "copyright", "credits" or "license" for more information.
>>> from kahuna.session import ContextLoader
>>> ctx = ContextLoader().load_context()
Using endpoint: http://10.60.1.222/api
>>> cloud = ctx.getCloudService()         
>>> cloud.listVirtualDatacenters()
[VirtualDatacenter [id=11, type=XENSERVER, name=Kaahumanu]]
>>> vdc = cloud.listVirtualDatacenters()[0]
>>> vdc.setName("Updated VDC")
>>> vdc.update()
>>> cloud.listVirtualDatacenters()         
[VirtualDatacenter [id=11, type=XENSERVER, name=Updated VDC]]
>>> ctx.close()
>>> exit()

Adding more plugins

Plugins are easy to create. Take a look at the Project Wiki to see how to create and add your own plugins.

Note on patches/pull requests

  • Fork the project.
  • Create a topic branch for your feature or bug fix.
  • Develop in the just created feature/bug branch.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit.
  • Send me a pull request.

Issue Tracking

If you find any issue, please submit it to the Bug tracking system and we will do our best to fix it.

License

This sowftare is licensed under the MIT license. See LICENSE file for details.