Creating a Circuit

To create a new circuit, go to the workgroup homepage, select the Actions tab, and click the Create a New VLAN link.

From there, the system will guide you through several steps, the culmination of which is a working circuit.

Step 1.1:  Basic Details

The description is a human-friendly bit of text for you to remember the purpose of the circuit and to look it up later. You should put something in the Description text box.

Step 1.2: Endpoints

On the same page where you set the circuit's description, you also choose the circuit's endpoints. A circuit must have at least two endpoint.

To choose an endpoint, click on one of the non-gray dots - these represent the switches that the workgroup can use for endpoints. Once selected, the list of available interfaces will display to the right.

Clicking on one of the interfaces in the list brings up a pop-up to set the VLAN tag you would like to use for the traffic to be transmitted/received on that interface. Once you select the VLAN tag and click Save, you can start on adding another endpoint.

Note that a circuit is either OpenFlow-based or MPLS-based; it can't use both. Which Control Type the circuit is depends on the interfaces you use for endpoints. The screenshots from here on out will be for an OpenFlow circuit; the steps for an MPLS circuit are similar, with differences noted.

Once you have the set of desired endpoints defined, click on Proceed to Next Step: Circuit Options (if this is an OpenFlow circuit) or Proceed to Next Step: Primary Path (if this is an MPLS circuit).

Step 2: Circuit Options (OpenFlow only)

For OpenFlow circuits, there are a couple of options that can be selected for the circuit.

Restore To Primary controls whether, if the circuit is using its backup path and the primary path becomes usable, OESS will automatically switch the circuit to use the primary path again. Clicking on the button toggles whether this is enabled or disabled; if enabled, you can set the length of time the primary path should be usable before the path restoration occurs.

Multipoint Static MAC Routing can be used to control which endpoint(s) a frame on the circuit is sent to based on the frame's destination MAC address. This is described in more detail in a different part of this documentation.

When you're done setting any options, click Proceed to Next Step: Primary Path.

Step 3: Primary Path

The primary path is the path you prefer you traffic to traverse. It is required for OpenFlow circuits, and optional for MPLS circuits - if not specified, the MPLS switches will use the path they determine to currently be the best. If you don't have particular requirements for the path an OpenFlow circuit should take, you can hit the Suggest Shortest Path button, and OESS will find the best path for you. Alternatvely, if you would like to define the exact path, you can click links to add or remove them from the path.  The path must connect all the endpoints, and it must be acyclic - it can't have loops.

Select Primary Path with Multiple Links

If there is more than one link between two nodes, you will have to choose one when manually specifying a path. To manually select a specific link, click the line representing the multiple links. The Select Link panel will appear with a selector containing all of the links between the two nodes. Choose the link you would like to use in your path and then click the Select button to add it to the path. Suggest Shortest Path will determine the shortest path in this situation by choosing the link where the sum of the circuits provisioned on the link and its metric is the smallest. (The metric of a link is set by the OESS administrators behind the scenes - it reflects the cost of using a circuit.)

When you're done specifying the primary path (or if this is an MPLS circuit that doesn't need a primary path), click the Proceed to Next Step: Backup Path (OpenFlow circuits) or Proceed to Next Step: Scheduling (MPLS circuits) button.

Step 4: Backup Path (OpenFlow circuits only)

Defining the backup path is the same as the primary. However, if you hit Suggest Shortest Path, the system will calculate the shortest backup path that doesn't re-use any of the links in the primary path. Backup paths are optional.

Step 5: Scheduling

You can either immediately provision a circuit or schedule it to be added at a later date and time. Similarly, you can schedule the circuit to be removed at a later date and time, or you can just let it persist indefinitely (you can always manually remove it later).

Shown is an example where we are asking to provision immediately and automatically remove later. 

When you're done with scheduling, click Proceed to Next Step: Review Design.

Step 6: Provisioning

In this final step, you are given the ability to review your design before asking the system to make it happen. Nothing will happen until you click Submit Circuit Request.

Once you click Submit Circuit Request, the system will try to create the circuit you requested, and inform you as to the results.