OMF

OMF Aggregate Manager - slicemgr service

========================================

The slicemgr service provides an XML-RPC bridge to an OMF testbed's

XMPP server.  It provides interfaces to add and remove PubSub nodes on

the XMPP server.  The service only allows manipulation of PubSub nodes

relating to the management of the resources of a slice.

The OMF PubSub nodes are organized as a tree (although XMPP does not

provide any support for hierarchical node structures).  A diagram of the

OMF PubSub node tree can be found here:

http://omf.mytestbed.net/wiki/omf/OMFControlPlanetLab

The top-level node is always called 'OMF'. Underneath the OMF node is

a node called OMF/system node, which is used for testbed management

functions, and is not accessible via this XML-RPC interface. Alongside

the OMF/system node are any number of siblings, each of which

corresponds to a PlanetLab slice.

For instance, a slice named 'foo' will have a PubSub node called

'OMF/foo'.

All slices will have a PubSub child node named like

'OMF/<slice_name>/resources'. The children of

'OMF/<slice_name>/resources' are PubSub nodes that correspond to the

slivers or resources of the slice. Experiments executed on a slice

will generate their own PubSub nodes under

'OMF/<slice_name>/<experiment_name>'.

This XML-RPC interface allows for creating and removing the following

PubSub nodes:

- OMF/<slice_name>

- OMF/<slice_name>/resources

- OMF/<slice_name>/resources/<resource_name>

The 'OMF' and 'resources' components of these PubSub node names are

literal; the terms in angle brackets '<','>' are substituted with the

actual name of the slice and the resource.

NOTE:  the PubSub node names are case sensitive.

NOTE:  the API does not yet support authentication.  Current proposal

is to handle SSL/TLS symmetric authentication using a reverse HTTP

proxy such as lighttpd.

The available XML-RPC interfaces are described below.  They are

provided by the OMF Aggregate Manager, mounted on the /slicemgr URI.

slicemgr.createSlice(slice_name)

--------------------------------

IN:

		slice_name -- string -- name of the slice to be created

Description: Creates the top-level PubSub nodes for a new slice. For

instance, if slice_name is 'foo', then the following two nodes will be

created:

- OMF/foo

- OMF/foo/resources

If either of these nodes already exist then the RPC succeeds as normal

(no indication is returned to the client that the node already

existed). If the slice_name is 'system' (or 'SYSTEM', or 'SYStem', or

'sYStem", etc.) then the RPC fails with fault code 1.

OUT:

		struct

				result => "OK"  (if the call succeeded)

				name => sliceid  -- string -- e.g. "OMF/foo"

slicemgr.addResource(slice_name, resource_name)

-----------------------------------------------

IN:

		slice_name -- string -- name of the slice

		resource_name -- string -- name of the new resource

Description: Add a new resource under the slice with the given

slice_name. The slice should already have been created using

slicemgr.createSlice. If slice_name is 'foo' and resource_name is

'onelab10.inria.fr', then the following PubSub node will be created:

- OMF/foo/resources/onelab10.inria.fr

If the node already exists then the RPC succeeds as normal (no

indication is returned to the client that the node already existed).

If the slice_name is 'system' (or 'SYSTEM', or 'SYStem', etc.), then

the RPC fails with fault code 1.

OUT:

		struct

				result => "OK" (if the call succeeded)

				slice => sliceid  -- string -- e.g. "OMF/foo"

				resource => resourceid -- string -- e.g. "OMF/foo/onelab10.inria.fr"

slicemgr.removeResource(slice_name, resource_name)

--------------------------------------------------

IN:

		slice_name -- string -- name of the slice

		resource_name -- string -- name of the resource

Description: Removes the resource called resource_name from the slice

called slice_name. If the slice_name is 'foo' and the resource name is

'onelab10.inria.fr', then the following PubSub node will be removed:

- OMF/foo/resources/onelab10.inria.fr

If this PubSub node does not exist then the call succeeds silently (no

indication is given to the client that the node did not exist

already). If the slice_name is 'system' (or 'SYSTEM', or 'SYStem',

etc.), then the RPC fails with fault code 1.

OUT:

		struct

				result => "OK" (if the call succeeded)

				slice => sliceid  -- string -- e.g. "OMF/foo"

				resource => resourceid -- string -- e.g. "OMF/foo/onelab10.inria.fr"

slicemgr.deleteSlice(slice_name)

--------------------------------

IN:

		slice_name -- string -- name of the slice to delete

Description:  Deletes the slice called slice_name.  If the slice_name

is 'foo' then the following PubSub nodes will be removed:

- OMF/foo

- OMF/foo/resources

- OMF/foo/resources/*

The wildcard "OMF/foo/resources/*" means that all PubSub nodes

corresponding to resources for slice 'foo' will also be removed by

this RPC.

If slice_name does not refer to an existing slice then this RPC

succeeds silently (no indication is given to the client that the node

did not exist already).  If the slice_name is 'system' (or 'SYSTEM, or

'SYStem', etc.) then the RPC fails with fault code 1.

OUT:

		struct

				result => "OK" (if the call succeeded)

				slice => sliceid -- string -- e.g. "OMF/foo"

				resources => resource_list -- array -- an array of the

																  resource nodes removed.

NOTES:

------

1.  This document describes the first prototype implementation of the

XML-RPC interface to the slice/resource creation functions.  The fact that

error indications are not returned for attempts to add existing

slices/resources or remove non-existing slices/resources is an artefact of the

current implementation environment and should be rectified in a

subsequent revision.