Skip to content

WIM Adaptor API Reference

Jump to bottom
Dario Valocchi edited this page Aug 30, 2017 · 4 revisions

Add a WIM

Register a WIM to the WIM-Adaptor.

  • topic: infrastructure.management.wan.add
  • data: `{wim_vendor: String, wim_address: String, username: String, pass: String}``, allowed values for wim_vendor is "VTN" and "MOCK", when one wants a deployment without WAN configuration.
  • return: {request_status: String, uuid: String, message: String}, when request_status is "COMPLETED", uuid fields carries the UUID of the registered WIM and message field is null, when request_status is "ERROR", message field carries a string with the error message, and the uuid field is empty.

List WIMs

Retrieve a list of the WIMs registered to the WIM-Adaptor.

  • topic: infrastructure.management.wan.list
  • data: null
  • return: [{uuid: String, name: String, attached_vims: [Strings]}]

Link VIM to WIM

Store in the WIM repository the connection information of a NFVI-PoP (i.e. Compute VIM) to a specific WIM.

  • topic: infrastructure.management.wan.attach
  • data: {wim_uuid: String, vim_uuid: String, vim_address: String}
  • return: {request_status: String, message: String}, when request_status is "COMPLETED", message field is empty, when request_status is "ERROR", message field carries a string with the error message.

Configure WAN for service instance

Configure the WAN to allow traffic flow defined by the pair (''ingress_nap'',''egress_nap'') to be steered through the NFVI-PoP where VNFs of the relevant service instance are deployed.

  • topic: infrastructure.service.wan.configure
  • data: {service_instance_id: String, vim_list: [{uuid: String, order:int}], nap:{ingresses: [{location: String, nap: String}], egresses: [{location: String, nap: String}] }}
  • return: {request_status: String, message: String}, when request_status is "COMPLETED", message field is empty, when request_status is "ERROR", message field carries a string with the error message.

Deconfigure WAN for service instance

Remove the WAN configuration associated with a Network Service instance.

  • topic: infrastructure.service.wan.deconfigure
  • data: {service_instance_id: [String]}
  • return: {request_status: String, message: String}, when request_status is "COMPLETED", message field is empty, when request_status is "ERROR", message field carries a string with the error message.

Clone this wiki locally