Introduction
SOS has been designed such that all configuration and interaction with the service can be done through a single point of contact -- namely the controller. The controller is the Floodlight OpenFlow controller outfitted with a special SOS module. All interaction is done over a REST API, which uses HTTP to facilitate high-level and well-defined data push and fetch.
By default, the SOS controller’s REST API runs at the controller’s IP on TCP port 8080. An HTTP client can be used to leverage the API. The popular utility curl is used throughout this document as an example HTTP client. For more information on curl, please refer to curl’s documentation. The following is a general example on how to use curl:
curl http://<controller-ip>:<tcp-port>/<uri-path> -X <http-command> -d ‘<data-string>’
where
- <controller-ip> is the IP address of the SOS controller
- <tcp-port> is the TCP port on which the REST server is running (default of 8080)
- <uri-path> is the URI of the API
- <http-command> is the HTTP command to use
- <data-string> is the (optional) data to send to the API
Specific examples of this generalized form will be provided for each SOS API discussed.
SOS REST API
The SOS controller has the following APIs defined to perform common SOS operations:
| Operation | API (<uri-path>) | HTTP Command (<http-command>) | JSON Input Data (<data-string>) | JSON Data Returned | About |
|---|---|---|---|---|---|
| Configure parameters | /wm/sos/config/json | POST or PUT | '{ "parallel-connections" : "<integer>", "buffer-size" : "<integer>", "queue-capacity" : "<integer>", "hard-timeout" : "<integer>", "idle-timeout" : "<integer>" }' | '{ "code" : "<integer>", "message" : "<string> }' | Modify the running configuration of SOS. User need not supply all data – only those parameters to set/change. Input data is a JSON object of key:value pairs. <integer> should be replaced with a zero or positive value. Returns 0 code for success; all others indicate failure. |
| Add/remove agent | /wm/sos/agent/add/json /wm/sos/agent/remove/json | POST or PUT POST or PUT | '{ "ip-address" : "<string>", "data-port" : "<integer>", "control-port" : "<integer>", "feedback-port" : "<integer>" }' | '{ "code" : "<integer>", "message" : "<string> }' | Specify the same data for add or remove. Input data is a JSON object of key:value pairs. <string> should be replaced with a dotted-decimal IP address, e.g. 192.168.1.1. <integer> should be replaced with the corresponding port number. Returns 0 code for success; all others indicate failure. |
| Add/remove whitelist entry | /wm/sos/whitelist/add/json /wm/sos/whitelist/remove/json | POST or PUT POST or PUT | '{ "server-ip-address" : "<string>", "server-tcp-port" : "<integer>", "client-ip-address" : "<string>", "start-time" : "<string>", "stop-time" : "<string>" }' | '{ "code" : "<integer>", "message" : "<string> }' | Specify the same data for add or remove. Input data is a JSON object of key:value pairs. <string> IP addresses should be replaced with a dotted-decimal IP address, e.g. 192.168.1.1. <integer> should be replaced with the corresponding port number. <string> date/time should be replaced with any valid date/time string or value. Note: Start/stop times are currently ignored. Returns 0 code for success; all others indicate failure. |
| Enable/disable | /wm/sos/module/enable/json /wm/sos/module/disable/json | POST or PUT POST or PUT | '' | '{ "code" : "<integer>", "message" : "<string> }' | Specify an empty string as the data. An empty string is given by two single quotes, one after the other, e.g. ''. Do not use a double quote. GET not used for security/safety reasons. Returns 0 code for success; all others indicate failure. |
| Query status | /wm/sos/status/json | GET | N/A | '{ "code" : "<integer>", "message" : "<string> }' | Omit -d parameter. Returns whether or not the agents are ready to accept another transfer. At present, each agent is allowed at most one transfer at a time. This can be used to detect when one transfer is "cleaned up" and the system is ready for another. Returns 0 code for ready; 6 for not ready; all others indicate failure. |
| Get statistics | /wm/sos/stats/json | GET | N/A | Non-trivial output. Gives agents, whitelist entries, active and past transfers, routes utilized, and more. | Omit -d parameter. Query past and present statistics. Does not include performance evaluation of transfers, although it will in the near future. |