RUNOS REST API 2.0¶

Common REST call:

http://<IP_runos>:<port_runos>/<REST Command>

Default RUNOS port for REST is 8000.

An example of REST call:

http://127.0.0.1:8000/switchesview/

An example of REST call using curl:

curl -X GET 'http://<IP_runos>:<port_runos>/switchesview/'

RUNOS Core API’s¶

#	URI	Method	Description	Arguments
1	/switch_type/<dpid>/	GET	Returns type of switch	Switch DPID
2	/switches/	GET	Returns list of connected switches	no
3	/switches/<dpid>/	GET	Returns detailed information about switch with DPID <dpid>	Switch DPID
4	/switches/<dpid>/ ports/<portid>/	GET	Returns port settings	Switch DPID Port ID
5	/switches/<dpid>/ ports/<portid>/ queues/<queueid>/ stats/	GET	Returns queue <queueid> statistics of port <portid> of switch <dpid>	Switch DPID Port ID Queue ID

#	URI	Method	Description	Arguments
1	/switches/<dpid>/ flow-tables/	GET	Returns rules of flow tables for switch with DPID	Switch DPID
2	/switches/<dpid>/ group-desc/	GET	Returns rules of group table for switch with DPID	Switch DPID
3	/switches/<dpid>/ group-stat/	GET	Returns rules statistics of group tables for switch with DPID	Switch DPID

#	URI	Method	Description	Arguments
1	/links/	GET	Returns list all links	no

#	URI	Method	Description	Arguments
1	/switchesview/	GET	Returns list of switches and its roles to each controller	no
2	/masterview/	GET	Returns list of controllers and its role for each switch	no
3	/recovery/	GET	Returns Recovery Manager state and settings	no

#	URI	Method	Description	Arguments
1	/switches/ports/stats/	GET	Returns port statistics of all switches	no
2	/switches/<dpid>/ ports/<portid>/ stats/	GET	Return statistic of port with <portid> of switch with <dpid>	Switch DPID Port ID

#	URI	Method	Description	Arguments
1	/l2switch/	GET	Returns list of pairs <MAC, port>	no

#	URI	Method	Description	Arguments
1	/hosts/	GET	Returns list of hosts	no