Version 26 (modified by Aaron Helsinger, 8 years ago) (diff)



The GENI API is an effort to enable interoperability within GENI through standard APIs.

The GENI Aggregate Manager API

The GENI AM API defines a key interface of the SFA 2.0 Draft, providing a common interface to Aggregate Managers.The GENI AM API has been implemented by PlanetLab, ProtoGENI, and OpenFlow. Furthermore, through the sharing of root certificates, these implementations are now interoperable. Researchers with a ProtoGENI account can use PlanetLab resources, and researchers with a PlanetLab account can use ProtoGENI resources. Many OpenFlow aggregates also trust the PlanetLab and ProtoGENI root certificates. Initial implementations of the GENI AM API were demonstrated at GEC 8 and interoperability was demonstrated via the GEC 9 plenary session demos.

Experimenters can begin designing and conducting experiments that take advantage of the broad variety of resources now available to them. Contact Mark Berman and the Experimentation Working Group with questions.


The PlanetLab implementation is live on PLC and PLE. ProtoGENI and PLC have also swapped root certificates, meaning that ProtoGENI users can use the API to reserve PlanetLab resources at PLC. To run the GENI API on your MyPLC instance, simply install the latest release of SFA. Use the mailing list: for questions.

The ProtoGENI implementation is live in Utah and Kentucky, and is part of emulab-stable. ProtoGENI has trusted the PlanetLab root certificate (it is included in their standard certificate bundle that all ProtoGENI installs receive), meaning that PlanetLab users can use the GENI API to reserve ProtoGENI resources. Contact the mailing list ( with questions on using the API at ProtoGENI.

The OpenFlow team has built an aggregate manager called FOAM, which is currently in beta testing. FOAM will be available for wide use in late November 2011. FOAM will replace an OpenFlow combined client/clearinghouse/aggregate manager called Expedient. Expedient exposes the GENI API to reserve OpenFlow slivers. To learn more about Expedient, see the Expedient developer's site. Expedient has been installed at multiple campuses. Contact OpenFlow for further availability information.

The ORCA team implements the GENI AM API in a plug-in controller for the ORCA Slice Manager (SM), which exports various XMLRPC interfaces to external tools. An SM running the XMLRPC controller exposes all resources visible to that SM as a single GENI aggregate. The native AM protocol in ORCA depends on features that are not yet available in the GENI AM API: it uses tickets and leases for resource management, supports multiple slivers per slice, and uses property lists to drive various configuration options.

The GPO has developed a reference implementation of the GENI AM API, particularly demonstrating the use of certificates, credentials and credential verification. Also provided is a reference client, omni. Omni communicates with each clearinghouse in its 'native tongue', and then calls the Aggregate Manager API at any compliant Aggregate. These packages are available together for download. Documentation is available on the gcf wiki along with source code and open tickets.

API Evolution

The current version of the Aggregate Manager API is documented on the GENI Aggregate Manager API Wiki Page. The API will evolve over time as issues, gaps, or new requirements are identified. Those changes are documented on the Draft API Changes wiki page. The API will also be the subject of periodic sessions at GEC conferences, as needed. There was an AM API session at GEC12, whose wiki page contains slides and session notes. That session defined version 2 of the API.



Useful Links


Questions? Comments? Suggestions? Contact Tom Mitchell (tmitchell) or Aaron Helsinger (ahelsing) or Sarah Edwards (sedwards) at