Version 33 (modified by, 11 years ago) (diff)


This page will guide you through running a simple non-IP experiment in GENI, using the Omni command line tool. We are going to take advantage of the Layer 2 links between nodes and run a non-IP experiment. The only thing you will need is a GENI account. If you don't already have one, sign up!

1. Configure Omni with your GENI account

Omni is a command-line tool that will help you reserve resources in GENI. Follow these steps to download and configure Omni.

Omni web page
  1. Download Omni.The Omni client is part of the GENI Control Framework (GCF) software package. Start with downloading GCF .
  2. Install and Configure Omni using these instructions . Unless you have a specific reason not to, please follow the instructions about automatically configuring Omni. For the rest of the instructions, it is assumed that you followed the default configuration of omni. If you have customized it in any way, please adjust the instructions accordingly.
  3. Optional - Add your key to the ssh agent. If there is an ssh agent running on your host add you key to the ssh agent by running:
    ssh-add ~/.ssh/geni_key
  1. Verify that you have the necessary credential and key files . Run:
         ls ~/.ssh ~/.ssl
    The output looks like :
    geni@geni-vm:~$ ls ~/.ssh ~/.ssl
    config  geni_key
    geni_cert_enc.pem  geni_cert.pem

geni_cert.pem Cleartext certificate, i.e. does not require any passphrase
geni_cert_enc.pem Encrypted certificate
geni_key The private key that you will use to login to the nodes The corresponding public key that will be uploaded to the nodes

Note: Depending on the setup of your host you might see more files than the ones listed above.

  1. Optional - Look around the omni_config file Open the file ~/.gcf/omni_config using either vim or emacs. Close to the top of the file you will see two parameters called default_cf and users. Your username should be at least listed in the user section. Look for the sections in the file that are named [pg] and [<username>].

In the [<username>] section, the information need for logging-in to reserved compute resources are provided. It includes your unique user URN and a public key that would be uploaded to the hosts that you reserve.

In the [pg] section you configure Omni to use your personal information. The cert and the key attribute point to files that we have manually downloaded from This is equivalent to the Download action of Flack.

Another interesting section to look at is the [aggregate-nicknames] sections. Flack already knows the URL for all the AMs and present you a list of AMs to choose from using a short, descriptive name. In Omni a user is required to pass the URL for each call to the GENI AM API. In this section the user gets a chance to provide short descriptive names to the URLs that are easier to memorize and use.

2. Launch your experiment

Now that you have configured Omni we are ready to design our experiment, which going over most of the Omni commands.

  1. Create a slice. The first thing to do when preparing to run a GENI experiment is to create a slice. Name your slice something like xxxomni (where xxx are your initials). Type createslice <slicename>
  2. Verify that your slice was created. Use the listmyslices command, of omni: listmyslices <username>
  3. Renew your slice. To extend the lifetime of your slice type: renewslice <slicename> <YYYYMMDD>
  4. See available resources. For this experiment we are going to use the Aggregate manager of ProtoGENI in Utah. In order to see what each AM offers you can use the listresources command. Type: listresources -a pg-utah -o
    The -o option will save the output to a file. The filename is chosen by Omni and printed as part of the output. The output will look like :
    geni@geni-VirtualBox:~$ listresources -a pg-utah -o
    INFO:omni:Loading config file /home/geni/.gcf/omni_config
    INFO:omni:Using control framework pg
    INFO:omni:Saving output to a file.
    INFO:omni:Substituting AM nickname pg-utah with URL, URN unspecified_AM_URN
    INFO:omni:Listed resources on 1 out of 1 possible aggregates.
    INFO:omni:Writing to 'rspec-www-emulab-net-protogeniv2.xml'
    INFO:omni: ------------------------------------------------------------
    INFO:omni: Completed listresources:
      Options as run:
    		aggregate: ['pg-utah']
    		framework: pg
    		output: True
      Args: listresources
      Result Summary: Queried resources from 1 of 1 aggregate(s).
    Wrote rspecs from 1 aggregate(s) to 1 file(s)
    Saved listresources RSpec at 'unspecified_AM_URN' (url '') to file rspec-www-emulab-net-protogeniv2.xml;  
    INFO:omni: ============================================================
    In the last line of the output Omni will tell you the name of the file that output is saved at. In the example above this would be rspec-www-emulab-net-protogeniv2.xml. Open the file that Omni saved and just take a look to see how an advertisement RSpec looks like. In order to see only available resources type: listresources -a pg-utah --available -o
  5. Reserve resources. To be able to reserve resources you will need to craft a request rspec. For this example we have created the rspec and made it available for you to use. Type: createsliver -a pg-utah <slicename>
  6. See the reserved resources. You can use the listresources command, to see what resources are reserved at an Aggregate. listresources -a pg-utah <slicename>
  7. Optional- Extend the lifetime of your reservation. The lifetime of your reservation can never exceed the lifetime of your slice and is usually set to a default value. For the purpose of this exercise you don't need to renew your reservation. But if you wanted to do this this is what the command would look like: renewsliver -a pg-utah <slicename> <YYYYMMDD>
  8. Check the status of your resources. Type: sliverstatus -a pg-utah <slicename>
    The sliverstatus command reports the status of your overall GENI slice. When the status is ready we are ready to continue to the next step.

3. View your results

For this example experiment we used the install script facility to automatically install the necessary software and kick-off the experiment. In this very simple setup, we have installed and launched a web server as well as an iperf server, on the server host. On the client, we have started some processes to test both of these services. To view the results of this experiment:

  1. After the sliverstatus command tells you that your resources are ready. ''Login to your nodes'''. Depending on the Aggregate the login information are either part of the sliverstatus call, or as part of the manifest rspec, i.e. returned from the listresources call. Omni comes with a script that makes it easy to gather all this information. In the terminal run: -a pg-utah <slicename>
    The script will return the actual command that you would need to use for logging in. Login to both nodes by copy-paste the commands from the output of the script.
readyToLogin snapshot
Hello GENI index
  1. Click the webserver statistics link to look at statistics. Refresh the page a couple of times to see how the statistics change as the client requests documents.
  2. Click the iperf logs link to see the statistics from the iperf transfers.

4. Cleanup

Although all your reservations, have expiration times, you should always release your resources once you have completed your experiment to make them available to other experimenters.

  1. In the terminal, where you have been running your omni commands do: deletesliver -a  pg-utah <slicename>