ryuswitch

Object-orientated approach.

Provides the RyuSwitch class to instantiate the physical switches connected to the controller as objects.

ryufunc

Functional approach.

Allows you to call the RyuSwitch methods directly (although a switch Datapath ID (DPID) must be passed as an argument in most cases).

PyPi

$ pip install ryurest

You may wish to use sudo with this command.

From source

Alternatively you can either download or clone this repository, place the required ryufunc.py and/or ryuswitch.py modules into your project directory, and import them as per normal.

$ git clone https://github.com/nathancatania/ryurest

# imports the functional module
import ryufunc

# imports the object-orientated module
from ryuswitch import RySwitch

You may also need to install the requests library if it is not already on your machine:

$ pip install requests

1. Import the ryurest module and the RyuSwitch class into your script

from ryurest import RyuSwitch

2. Create one or more RyuSwitch objects

switch1 = RyuSwitch( DPID )

If you do not know any of the DPIDs of the connected switches, you can initialize with no arguments and call the .get_switches() method to return an array of DPIDs.

Be sure to assign any object created in this way a DPID manually:

# Create a switch
switch0 = RyuSwitch()

# Get an array of Datapath IDs (DPIDs) for all connected switches
DPID_list = switch0.get_switches()

# Assign a DPID manually to the switch created
switch0.DPID = DPID_list[0]

3. [OPTIONAL] Change the REST API URI

• The default location for the Ryu REST API is: http://localhost:8080

• If Ryu is running on the same PC as the module (localhost), then there is no need to change anything.

• If the Ryu controller is running on a different machine and/or port, you MUST set the API path within each RyuSwitch object created.

switch1 = RyuSwitch( DPID_list[0] )
switch1.API = "http://192.168.1.30:8080"

switch2 = RyuSwitch( DPID_list[1] )
switch2.API = "http://192.168.1.30:8080"

Warning! If altering the API path, DO NOT add a trailing ‘/’ at the end or the API call will fail!

4. Execute the class methods as required

# Gets all flows in flowtable
flows = switch1.get_flows()

• Some methods have optional filters as well.

• Consult the ryuswitch.py module or the Ryu REST API documentation for more info.

1. From the ryurest module, import ryufunc into your script

from ryurest import ryufunc

2. [OPTIONAL] Change the REST API URI

• The default location for the Ryu REST API is: http://localhost:8080

• If Ryu is running on the same PC as the module (localhost), then there is no need to change anything.

• If the Ryu controller is running on a different machine and/or port, you MUST set the API path. This is global for the entire ryufunc namespace.

print ryufunc.API
# prints: http://localhost:8080

# Change the default IP and Port
ryufunc.API = "http://192.168.0.30:8080"

Warning! If altering the API path, DO NOT add a trailing ‘/’ at the end or the API call will fail!

3. [OPTIONAL] Obtain a list of Datapath IDs (DPIDs)

• If you know the DPID(s) of the switch(es) you wish to interact with, you can skip this step.

• To return an array containing all of the DPIDs (switches) connected to the Ryu controller, use the get_switches() function:

DPID_list = ryufunc.get_switches()

# Prints a list of all DPIDs
for DPID in DPID_list:
   print DPID

# Access how you would any other array
switch1_dpid = DPID_list[0]
switch2_dpid = DPID_list[1]
# etc...

4. Execute the functions as required

• Once you know the DPID(s) of the connected switch(es), you can start to execute function calls.

# Gets all flows in flowtable
flows = ryufunc.get_flows( switch1_dpid )     # returns JSON

• Some methods have optional filters.

• Consult the ryufunc.py module or the Ryu REST API documentation for more info.