GENI Experimenters How-to Using Omni tools

This page provides an overview of the actions required by an experimenter to run a GENI experiment using resources from multiple resource aggregates. While working through these examples, you may need to interact with the GENI Infrastructure group to setup specific resources for you (e.g. VLAN or OF VLAN), at a high level, the steps to run a GENI Experiment include:

  • Get credentials from one Clearinghouse, this allows you to access multiple aggregates.
  • Install and configure Omni tools
  • Use the Omni tools to create a slice
  • Request resources from one or more aggregates to add to the slice
  • and of course, run the experiment.

This page focuses on resource allocation with Omni tools, other tools exists to assist the experimenter with resource allocation but are not covered here.


Two supporting examples are provided to illustrate the steps needed to run an experiment with GENI resources, each example has a unique scope:

  • GENI Experiment Example 1 covers how to configure and use Omni tools to reserve compute resources from multiple resource aggregates (PG & PL). This example has no specific network requirement, it simply focuses on getting host resources allocated for an experiment.
  • GENI OpenFlow Experiment Example 2 covers how to use Omni tools to request OpenFlow resources as part of an experiment that also uses PG & MyPLC compute resources. The scenario assumes that the experimenter is running an OF controller.

1. Get GENI Credentials

To access GENI resources, an experimenter must have GENI credentials! If you don't have credentials, follow the instructions at SignMeUp.

2. Get Omni Tools

To get access to the GENI resources you can use the OMNI client which is part of the GENI Control Framework (GCF) software package. Get the latest release of the GCF package at the GPO Software Release page or the latest development version of the GCF package at this GCF location and install it using the Quick Start instructions.

Once the Omni tool is installed, follow the configuration instructions.

3. Define Required Resources

You are now ready to define the resources required for your experiment. For an overview of available GENI resource see the Available Aggregates page. the The Omni tools can be used to query a Aggregate Managers that support the GENI AM API to get a list of available resources. In GENI we use Resource Specification (RSpec) documents to describe resources. In the supporting examples it is explained how to create and use rspecs.

If while you are gathering your resources you believe you need a layer 2 connection between different sites, then please contact us at You can also skim through the connectivity overview page that provides a summary of connectivity options between sites, or take a look at this Section, but if you do not know where to start please email us.

4. Get Resources

The Omni tool can help you reserve resources. In the supporting GENI Experiment Example 1 page, examples are provides that show how to:

Similarly, for an experiment using OpenFlow resources, see the GENI OpenFlow Experiment Example 2 page, which also provides examples as in the above.

5. Run Experiment

Once your resources are ready, you may now run your experiment.

Remember to monitor the expiration time for your slice for each of the resource aggregates with the Omni sliverstatus option and to extend expiration as needed with the renewsliver option. An example for checking the sliverstatus and renewsliver can be found here.

When your experiment is completed, you should delete slivers to release your resources from each resource aggregate used.

Email for GENI support or email me with feedback on this page!
Last modified 4 years ago Last modified on 09/25/19 14:07:43

Attachments (1)

Download all attachments as: .zip