Changes between Version 1 and Version 2 of Layer1Transport/Usage


Ignore:
Timestamp:
07/31/13 16:09:50 (11 years ago)
Author:
tupty@bbn.com
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Layer1Transport/Usage

    v1 v2  
    11[[PageOutline]]
    22
    3 = Introduction =
     3= GENI layer1transport service usage =
     4
     5== Introduction ==
    46This page describes how to use the layer1transport service.
    57
    6 = Variables =
     8== Variables ==
    79|| '''Name'''   || '''Description'''             || '''Default Values''' ||
    810|| <rest_port>  || REST API port for FL          || 18080                ||
    911|| <flow_name>  || Name of flow according to SFP ||                      ||
    1012
    11 = Using the Service =
     13== Using the Service ==
    1214The following is a brief description of how the service can be used.
    1315
    14 == Common Work flows ==
     16=== Common Work flows ===
    1517There are limitations to what this service can do at the moment, so below I will list some steps to take for various work flows.
    1618
    17 === Adding a new flow ===
     19==== Adding a new flow ====
    1820When adding a new connection in that needs a new flow defined in the switch:
    1921 1. Define the flows and put them into a new file under `/home/openflow/floodlight/flows.d/`
     
    2527This should push the new flows without disrupting connectivity for other existing connections.
    2628
    27 === Removing a flow ===
     29==== Removing a flow ====
    2830When removing a connection that relies on a specific flow:
    2931 1. Determine which flows should be removed and collect the names of the flows
     
    3537This should remove flows by name without disrupting connectivity for other existing connections.
    3638
    37 === Updating an existing flow ===
     39==== Updating an existing flow ====
    3840If you need to update a flow that has already been defined and pushed:
    3941 1. Update the flows file to use the new flow information
     
    4749  }}}
    4850
    49 === Restoring Static Flow Pusher (SFP) to a known state ===
     51==== Restoring Static Flow Pusher (SFP) to a known state ====
    5052If you believe that SFP may be out of sync with the desired state, but your are unsure what the specific problem is, then the best option may be to restart the service with:
    5153{{{
     
    5557This will briefly remove and reinstall all static flows, so this is disruptive to connectivity managed by this service.
    5658
    57 === Listing the flows that SFP knows about ===
     59==== Listing the flows that SFP knows about ====
    5860To list which flows SFP knows about, the most up-to-date information can be found in [http://docs.projectfloodlight.org/display/floodlightcontroller/Static+Flow+Pusher+API+%28New%29 the SFP documentation].
    5961
    60 === Listing the flows that a switch knows about ===
     62==== Listing the flows that a switch knows about ====
    6163To list which flows that a given switch knows about, the most up-to-date information can be found in [http://docs.projectfloodlight.org/display/floodlightcontroller/Floodlight+REST+API the REST API documentation] under the command for querying for flow statistics.
    6264
    6365
    64 == Defined Service Commands ==
    65 === start ===
     66=== Defined Service Commands ===
     67==== start ====
    6668The following command will cause the floodlight controller to start and it will push the flows that exist in the flows files.
    6769{{{
     
    6971}}}
    7072
    71 === stop ===
     73==== stop ====
    7274The following command will cause the flows that are defined in the flows files to be explicitly removed, and it will cause the floodlight controller to stop.  Floodlight's SFP module will not preserve flows when floodlight is shut down, so any remaining flows (whether they are inserted through other means, or if they are stale for some reason) will be removed.
    7375{{{
     
    7577}}}
    7678
    77 === reload ===
     79==== reload ====
    7880The following command will cause the floodlight module to read in the flows files, and add any flows which have names that are unknown to the floodlight SFP service.  Note that this '''will not''' remove flows that are removed from files, it '''will not''' remove flows if a file has been removed, and it '''will not''' update flows with a name that SFP already knows about.
    7981{{{
     
    8183}}}
    8284
    83 === restart ===
     85==== restart ====
    8486The following command will stop, pause, and then start the layer1transport service.
    8587{{{
     
    8789}}}
    8890
    89 === status ===
     91==== status ====
    9092The following command will return a non-zero value if floodlight is not running, or if there are some flows defined in `/home/openflow/floodlight/flows.d/` which the floodlight controller's SFP module doesn't know about.  It will return zero otherwise.
    9193{{{