Version 11 (modified by ibaldin, 8 years ago)


Configuring ORCA OSCARS/ION handler


ORCA OSCARS/ION handler provides Orca with the interface to control Internet2 ION and ESnet OSCARS dynamic circuit services which provide VLAN-like MPLS service between connected sites.


Orca invoked OSCARS/ION client API via shell scripts. The client API first must be installed under $ORCA_HOME and a properties file needs to be created to communicate the configuration to ORCA. The client API must be configured with user certificate issued by Internet2 or ESnet to the user that has rights to create circuit reservations.

Installing OSCARS/ION client software

  • Follow these instructions to install the software under $ORCA_HOME/oscars. Two subdirectories must be present after you're done: $ORCA_HOME/oscars/axis2-1.4.1 and $ORCA_HOME/oscars/OSCARS-client-api.
  • Get user credentials from Internet2 or ESnet and install your certificate into OSCARS.jks as described in the document above
  • Modify $ORCA_HOME/oscars/OSCARS-client-api/examples/repo/axis2.xml to point to $ORCA_HOME/oscars/OSCARS-client-api/examples/repo/rampConfig.xml
  • Modify $ORCA_HOME/oscars/OSCARS-client-api/examples/repo/rampConfig.xml to point to $ORCA_HOME/oscars/OSCARS-client-api/examples/repo/OSCARS.jks and use the user alias for the certificate that was installed.
  • Install the missing perfsonar.jar into $ORCA_HOME/oscars/OSCARS-client-api/lib (to support 'list' command)
  • Test the installation by running a reservation from the client using $ORCA_HOME/oscars/OSCARS-client-api/examples/ script as described in these instructions
  • Test the handler scripts in scripts directory. Set up the environment first by doing
    $ . ./settestenv.bash
    $ ./start-oscars.bash
    $ export OSCARS_UNIT_VLAN_TAG=<unit.vlan.tag from previous step>; ./query-oscars.bash
    $ export OSCARS_UNIT_VLAN_TAG=<tag from previous step>; ./stop-oscars.bash
    $ ./list-oscars.bash

Configure ORCA handler

Modify the following property file and install it under $ORCA_HOME/oscars/ Specify '' property to point to this file in the actor configuration. Example actor configuration file.

Handler details

The OSCARS handler accepts the following properties from the controller:

  • config.interface.1 - first interface name (URN)
  • config.interface.2 - second interface name (URN)
  • config.duration - duration of the reservation in seconds
  • resource.bandwidth - bandwidth in Bps
  • unit.vlan.tag - optional tag to use. If no tag is specified, OSCARS will issue it and it will be returned as part of unit.vlan.tag return property

Return properties:

  • unit.vlan.tag
  • unit.vlan.reservation in the form GRI|interfaceA|vlan tagA|interfaceZ|vlan tagZ