Skip to content

Latest commit

 

History

History
143 lines (103 loc) · 5.01 KB

Aggregator.md

File metadata and controls

143 lines (103 loc) · 5.01 KB

Aggregator

Aggregator provides the ability to create aggregated Network in a single Node that consolidates the original network topology.

Operating specifications of the Aggregator.

  • Topology
    Aggregated Network in a single Node that consolidates the original network Topology.
    Original network topology is composed of a single connected component. If more than one connected component exists, node of the aggregated Network is "oper_status":"down".
    Unconnected port is replicated to the aggregated network. Aggregator holds the correspondence between the topology, and performs the synchronization processing when there is a change.

  • Flows
    Creates original flow(shortest path) from aggregated flow(Point-to-Point)

  • Packets
    InPackets from the Unconnected port to transfer from the original network to the aggregated network.
    OutPackets from the Unconnected port to transfer from the aggregated network to the original network.

  • Create Instance of Aggregator.
    Generate an instance of Aggregator by performing a PUT (or POST) to the System Manager.

    PUT <base_uri>/components/<comp_id>

key value description
id <String> Unique Identifier in ODENOS.
type "Aggregator" ObjectType
cm_id <String> Specify the componentManager.Property.id to generate an instance. (Optional)

  • Component Connections
    Connection of Aggregator and Network by performing a PUT (or POST) to the System Manager.

    network | Connection possible number | connection_type -----------------|----------------------------|---------------------------------- original network | Only one | "original" aggregated network| Only one | "aggregated"

    PUT <base_uri>/connections/<conn_id>

key value description
id <String> Unique Identifier in ODENOS.
type 　　 　 "LogicAndNetwork"
connection_type "original" or "aggregated"
state none default "initializing"
logic_id <String> aggregator ID
network_id <String> Network ID

REST APIs

GET <base_uri>/property

  • get Object property.
[Request]:
  • Body : none
[Response]:

PUT <base_uri>/property

  • update Object property.
[Request]:
[Response]:

GET <base_uri>/aggregated_nw_port

Get relationship of the aggregated port id and original port id. (Key is original)

  • get Object settings info.
[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<original_node_id::original_port_id, (aggregated_node_id, aggregated_port_id)>

GET <base_uri>/original_nw_port

Get relationship of the aggregated port id and original port id. (Key is aggregated)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<aggregated_node_id::aggregated_port_id, (original_node_id, original_port_id)>

GET <base_uri>/aggregated_nw_flow

Get relationship of the aggregated flow id and original flow id. (Key is original)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<original_flow_id, aggregated_flow_id>

GET <base_uri>/original_nw_flow

Get relationship of the aggregated flow id and original flow id. (Key is aggregated)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<aggregated_flow_id, original_flow_id>