This collection gathers the documentation of the REST API provided by the UOWM SDN Controller, based on the Ryu SDN framework.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12079040","collectionId":"d9c19a88-0f46-4a56-906a-4acb00b51a1d","publishedId":"T1DjkfXx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-19T18:22:00.000Z"},"item":[{"name":"rest_topology API","item":[{"name":"Get all datapaths","id":"18a6066b-452a-4bb2-958f-86fbc12adeab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://electron-sdn.trsc-ppc.gr:10443/v1.0/topology/switches","description":"Returns the ports of all datapaths that are connected with the Ryu controller. Each port has the same typical structure (Note that this structure applies for all commands of the rest_topology API):
dpid is the datapath ID that the port belongs to in decimal form.hw_addr refers to the MAC address of the switch port.name is the friendly name of the corresponding port. port_no is the OpenFlow port number of the same port in decimal form.Returns all end devices (hosts) that are connected with all connected SDN switches. Note that the hosts list is populated only when the corresponding controller is in EQUAL or MASTER role. In addition, OpenFlow discriminates the Openflow-controlled devices (datapaths) and the non-OpenFlow devices (all the rest devices). Therefore, you may notice that a router or a non-OpenFlow switch is marked as a host. Response explanation:
mac is the MAC address of the host. Any host is uniquely identified by a MAC address. To this end, if a device has multiple interfaces or uses multiple MAC addresses, it will apprear as seperate devices.ipv4 is a list containing all known IP addresses that the host uses (obtained by ARP replies or by the source IPv4 address field).ipv6 includes all known IPv6 addresses.port is the JSON object that describes the switch port that the host is attached to.Returns all links between the SDN switches. These links are discovered by LLDP frames that the SDN-C floods via Packet-Out messages and then receives back from the datapaths.
\nEach link object defines a single communication direction and includes two parts, src and dst, each of them contains a JSON object of the corresponding port. Hence, two link objects can define a bidirectional communication link. Moreover, the delay of that link is also included in the response, measured in milliseconds.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Filters the results of \"Get all datapaths\" by a specific datapath id (dpid). Note that the the datapath id should be specified at the end of the URL in its decimal form (e.g. 2876467493016320).
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Filters the results of \"Get all hosts\" for a specific datapath id. Note that the the datapath id should be specified at the end of the URL in its decimal form (e.g. 2876467493531616).
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Filters the results of \"Get all links\" for a specific datapath id. Note that the the datapath id should be specified at the end of the URL in its decimal form (e.g. 2876467493531616).
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Note that the original implementation of the rest_topology API receives and displays the dpids and the port numbers in hexadecimal form. Although, the rest_topology app provided by UOWM, converts these number to decimal form in order to be compliant with the ofctl_rest API.
\n","event":[{"listen":"prerequest","script":{"id":"f17eca9d-fb97-40b7-be7e-05745e18a905","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9d58305f-5bb2-4ea8-bc3f-878d1b2ed5c9","type":"text/javascript","exec":[""]}}],"_postman_id":"fc1b04c3-0536-41f0-892b-e0b30f7ce1c4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns a list with the IDs of all datapaths connected to the SDN controller in decimal form. This command will not be necessary since the the REST API with SCS should be used instead.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Retrieves a description for the specified datapath. This command corresponds to the OFPDescStatsRequest OpenFlow command. Note that the the datapath id should be specified at the end of the URL in its decimal form (e.g. 35628848924874). Response explanation:
mfr_desc: String that specifies the manufacturer of the switch. Aruba will be returned for Aruba switches and Nicira, Inc. is returned for OVS.hw_desc: String that represents the hardware model of the switch.sw_desc: String that specifies the software version of the switch.serial_num: String that specifies the serial number of the switch.dp_desc: String that specifies a friendly name for the specified datapath (openflow instance in the switch) connected to the controller.Returns information about each port controlled by the datapath. The datapath id should be specified at the end of the URL in its decimal form (e.g. 35628848924874). Response explanation:
\nhw_addr: MAC address of the switch port.name: Name of the port, assigned outside of OpenFlow.config: Behaviour of the physical port (OFPPC_*). 0 means that no config has been applied, 1 indicates that the port is administratively down, 4 indicates that all ingress traffic to this port is dropped, 32 indicates that all egress traffic from this port is dropped and 64 specifies that packet_in messages will not be generated from this port. This config is only applied by the controller and default value is 0.state: State of the physical port (OFPPS_*). 1 means that no link is presented (cable disconnected), 2 indicates that the port is blocked (for example, by STP) and 4 means that the port is active.port_no: Openflow port number, assigned by the OpenFlow instance. This number should be used by REST API commands to identify or apply action to this port.curr_speed: Bit-rate of current switch port measured in kbps.max_speed: Maximum bit-rate of current switch port measured in kbps.Get statistics for all ports controlled of the specified datapath. The datapath id should be specified at the end of the URL in its decimal form (e.g. 35628848924874). Response explanation:
\nrx_packets: Number of received packets from the respective port.tx_packets: Number of transmitted packets from the respective port.rx_bytes: Number of received bytes from the respective port.tx_bytes: Number of transmitted bytes from the reactive port. rx_dropped: Number of the packets dropped in the respective port (ingress). tx_dropped: Number of the packets dropped in the respective port (egress). rx_errors: Number of packet errors in the respective port (ingress). tx_errors: Number of packet errors in the respective port (egress). rx_frame_err: Frame alignment errors. Shows the number of frames received whose size in bits was not a multiple of eight. Occasionally, extra bits of data are inadvertently attached to a transmitted packet, causing a frame alignment error. rx_over_err: The total number of good frames received by the respective port greater than the supported maximum length of 1522 bytes.rx_crc_err: Number of CRC errors in the respective port.collisions: Number of collisions in the respective port.port_no: OpenFlow number (identifier) of the corresponding port.Get statistics from all tables of a specific datapath. The datapath id should be specified at the end of the URL in its decimal form (e.g. 35628848924874). Response explanation:
\ntable_id: The table ID that the statistics refer to.active_count: Indicates the number of active OpenFlow entries in the specific table ID.lookup_count: Number of total look-ups in the specific table ID.matched_count: Number of total packets that matched any entry in the specific table ID.Retrieve all flows from a specific datapath. The datapath id should be specified at the end of the URL in its decimal form (e.g. 35628848924874). Response explanation:
\npriority: (Provided in the description of the \"Add a custom flow\" command)cookie: (Provided in the description of the \"Add a custom flow\" command)idle_timeout: (Provided in the description of the \"Add a custom flow\" command)hard_timeout: (Provided in the description of the \"Add a custom flow\" command)byte_count: Number of matched packets in terms of bytes.duration_sec: Time the flow is alive in seconds.duration_nsec: Time the flow is alive in nanoseconds beyond duration_sec.packet_count: Number of matched packets.length: Length of this entry (TBD)flags: (Provided in the description of the \"Add a custom flow\" command)actions: (Provided in the description of the \"Add a custom flow\" command)match: (Provided in the description of the \"Add a custom flow\" command)table_id: Table ID that the flow is in.Filter the response of \"Get flow stats\" by matching specific criteria. The datapath id of the switch should be specified at the end of the URL in its decimal form (e.g. 35628848924874). Body request explanation:
\ntable_id: (Optional) Filters by OpenFlow table. Defaults to OFPTT_ALL (any table) if not specifiedcookie: (Optional) Filters by cookie ID. Defaults to 0 if not specified.cookie_mask: (Mandatory if cookie specified) Bit mask specifying how many bits of the cookie should be matched. Defaults to 0 if not specified. 65535 indicates that all bits should be matched.match: (Optional) The contents of this dictionary is provided in the description of the command \"Add a custom flow\". If not specified, then all possible values will be considered.priority: (Optional) Flow priority. If not specified, then all priorities will be considered.Sends an OFPMP_AGGREGATE in order to retrieve aggregate statistics from all flows
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"These commands are used to retrieve information from the SDN switches.
\n","_postman_id":"5a61482c-0575-4732-8b5e-6c3052997d90","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Modifies the behaviour of the port by altering the OFPPC value of a specific port. Body's parameters explanation:
config: 1 means OFPPC_PORT_DOWN (Port administratively down), 4 means OFPPC_NO_RECV (Drop all packets received by port), 16 translates to OFPPC_NO_FWD (Drop packets forwarded to port) and 32 equals to OFPPC_NO_PACKET_IN (Do not send packet-in messages for this port).mask: Is used to select bits in the config field to change (int).port_no: Identifier of the OpenFlow port (int).Delete the flow that matches exactly the fields specified. Possible options:
\ndpid (Mandatory) The datapath ID (int)cookie: (Explained in the description of the command Add a custom flow). Defaults to 0.cookie_mask (Mandatory, if cookie is specified) (Explained in the description of the command Add a custom flow). Defaults to 0.table_id: Specifies the table that the flow is located Defaults to 0.idle_timeout: (Explained in the description of the command Add a custom flow). Defaults to 0.hard_timeout: (Explained in the description of the command Add a custom flow). Defaults to 0.priority: (Explained in the description of the command Add a custom flow). Defaults to 0.out_port: Matches the output port in the actions field. Defaults to OFPP_ANY.match (Explained in the description of the command Add a custom flow). If not specified, then the match field is wildcarded.actions (Explained in the description of the command Add a custom flow). Defaults to [] (which is interpreted as DROP action).Create a new flow entry in a specific table of a specific datapath. Body explanation:
\ndpid: Integer that specifies the datapath ID (OpenFlow instance of the switch connected to the controller)cookie: Custom controller-issued ID of a flow. Each SDN app should include a specific cookie that is provided by the maintainer of the SDN-C.table_id: Table ID to insert the flow in. Defaults to 0 if not specified.idle_timeout: The absolute timeout during which if there are no packets matching the flow for this period, then the flow is removed from the datapath. Defaults to 0. Setting this to zero, the flow entry is permanent.hard_timeout: The absolute timeout after which the flow is removed from the datapath. Defaults to 0. Setting this to zero, the flow entry is permanent.priority: Priority level of the flow entry. Higher priority means that that the flow will be evaluated first.flags: Bitmap of OFPFF_* flags. In particular, 1 will make the datapath send a “flow removed” event when the flow is removed, 2 will check for overlappings before inserting the flow, 4 will reset all byte and packet counters, 8 will force the datapath not to count matched packers and 16 will force the datapath not to count matched bytes.actions: Instruction set provided as a list of dictionaries. If not specified, it is implied that all matched packets will be dropped. Possible action types:OUTPUT: Forward packet to a specific port (e.g. {\"type\": \"OUTPUT\", \"port\": 3}). This implies an APPLY_ACTION.GOTO_TABLE: Forward matching flows to a specific table of the same datapath (e.g. {\"type\": \"GOTO_TABLE\", \"table_id\": 8}).WRITE_ACTION entry: {\"type\": \"WRITE_ACTIONS\", actions\":[{\"type\":\"POP_VLAN\",},{ \"type\":\"OUTPUT\", \"port\": 2}]}match: Fields to match (dict). If not specified, then all packets will be matched. Note that if you need to match any field in the network layer (e.g. source IP address), then the eth_type should be specified, as provided in the first example (2048 in this example specifies the IPv4 protocol). In the same vein, if any attribute in the transport layer should be specified, then both eth_type (for network layer) and ip_proto (for transport layer) should be specified. All match fields:in_port: (int) Switch input port (e.g. {\"in_port\": 7})in_phy_port: (int) Switch physical input port. Not clear yet what is the difference with in_port. (e.g. {\"in_phy_port\": 5, \"in_port\": 3})eth_dst: (string) Ethernet destination address, optionally specified with a mask (e.g. {\"eth_dst\":\"aa:bb:cc:11:22:33/00:00:00:00:ff:ff\"})eth_src: (string) Ethernet source address (e.g. {\"eth_src\":\"aa:bb:cc:11:22:33\"})eth_type: (int) Ethernet frame type. The full list of Ethernet types is provided by IANA: https://www.iana.org/assignments/ieee-802-numbers/ieee-802-numbers.xhtml#ieee-802-numbers-1 (e.g. {\"eth_type\": 2048})ip_proto: (int) IP protocol, the full list of ip protocols is provided by IANA: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml (e.g. {\"ip_proto\": 5, \"eth_type\": 34525})ipv4_src: (string) IPv4 source address (e.g. {\"ipv4_src\": \"192.168.0.1\", \"eth_type\": 2048})ipv4_dst: (string) IPv4 destination address (e.g. {\"ipv4_dst\": \"192.168.10.10/255.255.255.0\", \"eth_type\": 2048})tcp_src: (int) TCP source port (e.g. {\"tcp_src\": 80, \"ip_proto\": 6, \"eth_type\": 2048})tcp_dst: (int) TCP destination port (e.g. {\"tcp_dst\": 5, \"ip_proto\": 6, \"eth_type\": 2048})udp_src: (int) UDP source port (e.g. {\"udp_src\": 2, \"ip_proto\": 17, \"eth_type\": 2048})udp_dst: (int) UDP destination port (e.g. {\"udp_dst\": 6, \"ip_proto\": 17, \"eth_type\": 2048})icmpv4_type: (int) ICMP type. All ICMP types are provided by IANA: https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xml (e.g. {\"icmpv4_type\": 5, \"ip_proto\": 1, \"eth_type\": 2048})icmpv4_code: (int) ICMP code. All ICMP codes are provided by IANA: https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xml (e.g. {\"icmpv4_code\": 6, \"ip_proto\": 1, \"eth_type\": 2048})arp_op: (int) ARP operational code. All opcodes are provided by IANA: https://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml (e.g. {\"arp_op\": 3, \"eth_type\": 2054})arp_spa: (string) ARP source IPv4 address (e.g. {\"arp_spa\": \"192.168.0.11\", \"eth_type\": 2054})arp_tpa: (string) ARP target IPv4 address (e.g. {\"arp_tpa\": \"192.168.0.44/24\", \"eth_type\": 2054})arp_sha: (string) ARP source hardware address (e.g. {\"arp_sha\": \"aa:bb:cc:11:22:33\", \"eth_type\": 2054})arp_tha: (string) ARP target hardware address (e.g. {\"arp_tha\": \"aa:bb:cc:11:22:33/00:00:00:00:ff:ff\", \"eth_type\": 2054})Removes all flows of the specific datapath. The datapath id should be specified at the end of the URL in its decimal form (e.g. 35628848924874)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Delete all flows matching specific criteria. Possible options:
\ndpid (Mandatory) The datapath ID (int)cookie: (Explained in the description of the command Add a custom flow). Defaults to 0.cookie_mask (Mandatory, if cookie is specified) (Explained in the description of the command Add a custom flow). Defaults to 0.table_id: Specifies the table that the flow is located Defaults to 0.flags: (Explained in the description of the command Add a custom flow). Defaults to 0.idle_timeout: (Explained in the description of the command Add a custom flow). Defaults to 0.hard_timeout: (Explained in the description of the command Add a custom flow). Defaults to 0.priority: (Explained in the description of the command Add a custom flow). Defaults to 0.out_port: Matches the output port in the actions field. Defaults to OFPP_ANY.match (Explained in the description of the command Add a custom flow). If not specified, then the match field is wildcarded.actions (Explained in the description of the command Add a custom flow). Defaults to [] (which is interpreted as DROP action).Modifies all matching flows by replacing the instruction set (actions) with the dictionary specified in the body request. Possible options:
\ndpid (Mandatory) The datapath ID (int)cookie: (Explained in the description of the command Add a custom flow). Defaults to 0.cookie_mask (Mandatory, if cookie is specified) (Explained in the description of the command Add a custom flow). Defaults to 0.table_id: Specifies the table that the flow is located Defaults to 0.idle_timeout: (Explained in the description of the command Add a custom flow). Defaults to 0.hard_timeout: (Explained in the description of the command Add a custom flow). Defaults to 0.priority: (Explained in the description of the command Add a custom flow). Defaults to 0.flags: (Explained in the description of the command Add a custom flow). Defaults to 0.match (Explained in the description of the command Add a custom flow). If not specified, then the match field is wildcarded.actions (Explained in the description of the command Add a custom flow). Defaults to [] (which is interpreted as DROP action).Modifies the flow that strictly matches the criteria by replacing the instruction set (actions) with the dictionary specified in the body request. Possible options:
\ndpid (Mandatory) The datapath ID (int)cookie: (Explained in the description of the command Add a custom flow). Defaults to 0.cookie_mask (Mandatory, if cookie is specified) (Explained in the description of the command Add a custom flow). Defaults to 0.table_id: Specifies the table that the flow is located Defaults to 0.idle_timeout: (Explained in the description of the command Add a custom flow). Defaults to 0.hard_timeout: (Explained in the description of the command Add a custom flow). Defaults to 0.priority: (Explained in the description of the command Add a custom flow). Defaults to 0.flags: (Explained in the description of the command Add a custom flow). Defaults to 0.match (Explained in the description of the command Add a custom flow). If not specified, then the match field is wildcarded.actions (Explained in the description of the command Add a custom flow). Defaults to [] (which is interpreted as DROP action).The ofctl_rest API is provided by the Ryu SDN controller to retrieve information and update configuration of SDN switches, utilising OpenFlow protocols. In particular, any command of this REST API is translated to a corresponding OpenFlow command by the REST service and then is instructed to the relevant SDN switch.
Retrieves all SDN switches discovered by the connected SDN-Cs. To retrieve the datapath IDs, look into the childrens list.
Retrieves all SDN-Cs connected to the SDN switch, specified by its datapath ID at the end of the URL. All SDN-Cs are included in the childrens list. To extract the znode that represents the master SDN-C, the consumer needs to split each znode name based on the __ character and take the smallest value. In the example provided, the master SDN-C is represented by the 991038f3f3c54b268279603ccd9c2d27__lock__0000000204 znode.
Retrieves the data (data field) of the znode specified at the end of the URL (aka the full identity of the SDN-C, including IP, OpenFlow port and NBI port in the form: 192.168.1.1:6633:8080).
Note that the data field is returned in base64 format, therefore, should be converted to UTF-8 by the consumer.
The SCS folder gathers the API endpoints for the interaction with ZooREST, the REST server provided by SCS.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"dc7cf95f-906e-42ef-901c-3a89a93e1c47","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6af717f3-909b-4725-8fbd-528efb442651","type":"text/javascript","exec":[""]}}],"_postman_id":"c08355c4-b7d0-4797-8732-3e7637632d2a"},{"name":"HaaS","item":[{"name":"HaaS - Add Redirection to Honeypot","id":"2970ae99-dfbb-45ef-b692-2fac20a00209","protocolProfileBehavior":{"disableBodyPruning":true,"strictSSL":false},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"victim_ip\": \"10.250.100.70\",\r\n \"attacker_ip\": \"192.168.21.225\",\r\n \"datapath_id\": 2876467493016320\r\n}","options":{"raw":{"language":"json"}}},"url":"https://electron-sdn.trsc-ppc.gr:10443/haas/redirection/add/","description":"Returns a list with the IDs of all datapaths connected to the SDN controller in decimal form. This command will not be necessary since the the REST API with SCS should be used instead.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns a list with the IDs of all datapaths connected to the SDN controller in decimal form. This command will not be necessary since the the REST API with SCS should be used instead.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns a list with the IDs of all datapaths connected to the SDN controller in decimal form. This command will not be necessary since the the REST API with SCS should be used instead.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"