LearningSwitch.md

LearningSwitch

emulates a layer 2 switch.

---

REST APIs

• GET <base_uri>/property

• PUT <base_uri>/property

• GET <base_uri>/fdb

• DELETE <base_uri>/fdb

• DELETE <base_uri>/fdb/<mac>

• GET <base_uri>/settings/default_idle_timer

• PUT <base_uri>/settings/default_idle_timer

• GET <base_uri>/settings/default_hard_timer

• PUT <base_uri>/settings/default_hard_timer

  Here, <base_uri> is http://<hostname>:10080/systemmanager/components/learning_switch such as http://localhost:10080/systemmanager/components/learning_switch

---

GET <base_uri>/property

get Object property.

[Request]:

• Body : none

[Response]:

• Status Code : 200
• Body : ObjectProperty

---

PUT <base_uri>/property

update Object property.

[Request]:

• Body : ObjectProperty

[Response]:

• Status Code : 200
• Body : ObjectProperty

---

GET <base_uri>/fdb

get FDB entry.

[Request]:

• Body : none

[Response]:

• Status Code : 200
• Body : FDB

[FDB]

key	value
mac	["node_id" : <string> , "port_id" : <string> ]

example(JSON)

{
    "01:02:03:04:05:06": [ 
      "node_id" : "node1",
      "port_id" : "port1"
    ],
    "0A:0B:0C:0D:0E:0F": [
      "node_id" : "node2",
      "port_id" : "port1"
    ],
        …
}

---

DELETE <base_uri>/fdb

delete all FDB (Initialize FDB)

[Request]:

• Body : none

[Response]:

• Status Code : 200
• Body : none

---

DELETE <base_uri>/fdb/<mac>

delete FDB entry.
mac delimiter(Colon) is not used.

[Request]:

• Body : none

[Response]:

• Status Code : 200
• Body : none

---

GET <base_uri>/settings/default_idle_timer

get the flow "idle timeout"

[Request]:

• Body : none

[Response]:

• Status Code : 200
• Body : <integer>

---

PUT <base_uri>/settings/default_idle_timer

set the flow "idle timeout"

[Request]:

• Body : <integer>

[Response]:

• Status Code : 200
• Body : <integer>

---

GET <base_uri>/settings/default_hard_timer

get the flow "hard timeout"

[Request]:

• Body : none

[Response]:

• Status Code : 200
• Body : <integer>

---

PUT <base_uri>/settings/default_hard_timer

set the flow "hard timeout"

[Request]:

• Body : <integer>

[Response]:

• Status Code : 200
• Body : <integer>