Articles

LTE Datapath Control Service Documentation

The REST API described in this document provides the ability to configure Base Station and datapath parameters prior to experimenting.

Datapath services

datapath/config/add?type=...&&vlan=...&&name=...&apn=...

Example: wget -qO- http://lterf:5054/lterf/datapath/config/add?type=geant&&vlan=10&&name=demo&&apn=default

Adds a datapath configuration. The user must provide certain arguments describing the configuration i.e. 'type' or 'interface', 'vlan', 'name' and 'apn'. As a result, a bridge is created bridging the VLAN and tap interfaces.

Note: The arguments'interface' and 'type' can be used interchangeably.

Arguments	type, interface, vlan, name, apn

type	Connection type. Possible values are “geant” and “internet”. If connection is “internet”, there is no use to need VLANs.
interface	Same as 'type'. These two arguments can be used interchangeably.
vlan	VLAN id to use, e.g. 10
name	Name of datapath configuration to be added, e.g. “demo”. The bridge created will also have the same name.
apn	Access point name (e.g. “default”) associating a user with an IP, tap interface and external VLAN id.

If the datapath configuration is added successfully, a suitable XML plain text response is returned. Otherwise, an error message is returned informing the user of the error or asking them to specify the arguments required.

datapath/config/delete?type=...&&vlan=...&&name=...&apn=...

Example: wget -qO- http://lterf:5054/lterf/datapath/config/delete?name=demo

Deletes a datapath configuration file specified by the argument 'name'.

Arguments	name

name	Name of datapath configuration file to be deleted, e.g. “demo”.

If the datapath configuration is deleted successfully, a suitable XML plain text response is returned. Otherwise, an error message is returned informing the user of the error (e.g. if the file does not exist) or asking them to specify the name of the configuration file to be deleted.

datapath/config/list

Example: wget -qO- http://lterf:5054/lterf/datapath/config/list

Lists available datapath configuration files.

Arguments

(none)

If the datapath configuration is deleted successfully, a suitable XML response is returned listing all available datapath configuration files, otherwise an error message is returned.

datapath/config/load?name=...

Example: wget -qO- http://lterf:5054/lterf/datapath/config/save?type=geant&&vlan=10&&name=demo&&apn=default

Restores a datapath configuration from a saved file.

Arguments	name

name	Name of datapath configuration file to be restored, e.g. “demo”.

If the datapath configuration is loaded successfully, a suitable XML plain text response is returned. Otherwise, an error message is returned informing the user of the error or asking them to specify the arguments required.

datapath/config/save?name=...

Example: wget -qO- http://lterf:5054/lterf/datapath/config/load?name=demo

Saves a datapath configuration to a file.

Arguments	type, interface, vlan, name, apn

type	Connection type. Possible values are “geant” and “internet”.
interface	Same as 'type'. These two arguments can be used interchangeably.
vlan	VLAN id to use, e.g. 10
name	Name of datapath configuration to be added, e.g. “demo”. The bridge created will also have the same name.
apn	Access point name (e.g. “default”) associating a user with an IP, tap interface and external VLAN id.

If the datapath configuration is saved successfully, a suitable XML plain text response is returned. Otherwise, an error message is returned informing the user of the error or asking them to specify the arguments required.

datapath/delete?name=...

Example: wget -qO- http://lterf:5054/lterf/datapath/delete?name=demo

Deletes the bridge (and the interfaces/ports/controller associated with that bridge) specified by the argument 'name' from the current datapath configuration.

Arguments	name

name	Name of bridge to be deleted, e.g. “demo”.

If the bridge is deleted successfully, a suitable XML plain text response is returned. Otherwise, an error message is returned informing the user of the error or asking them to specify the arguments required.

datapath/restart

Example: wget -qO- http://lterf:5054/lterf/datapath/restart

Restart the running datapath configuration.

Arguments

(none)

If the running datapath configuration fails to restart, an error message is returned.

datapath/stop

Example: wget -qO- http://lterf:5054/lterf/datapath/stop

Stops the Trema instance if it is running, does nothing otherwise.

Arguments

(none)