You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

SDEWAN is implemented as CNF based on OpenWRT and it will support below functionalities:

  • Export Restful API interface to support configuration of MWAN3, Firewall & NAT, IpSec.
  • Site-to-Site tunnels across edges & edges & central orchestrators and application managers

SDEWAN Service

SDEWAN service restful API provides the capability to list available SDEWAN services, get service status and execute service operation.

Common Error code:

CodeDescription
400Bad request
401unauthorized -the security token is not provides or expired.

Error Response:

NameInTypeDescription
messagebodystringerror message

GET /cgi-bin/luci/sdewan/v1/services

Lists all available sdewan services supported by SDEWAN CNF

Request: N/A

Response

  • Normal response codes: 200
  • Response Parameters

    NameInTypeDescription
    servicesbodyarraya list of supported service
  • Response Example
    {
        "services": ["mwan3", "firewall", "ipsec"]
    }


GET /cgi-bin/luci/sdewan/v1/service/{service}
Get a service's status

Request: 

  • Request Parameters

    NameInTypeDescription
    servicepathstringservice name, valid value are "mwan3", "firewall", "ipsec"

Response

  • Normal response code: 200
  • Response Parameters

    NameInTypeDescription
    statusbodystringservice status 
  • Response Example

    {
        "status": "running"
    }


POST /cgi-bin/luci/sdewan/v1/service/{service}/

Execute a operation for a service

Request: 

  • Request Parameters

    NameInTypeDescription
    servicepathstringservice name, valid value are "mwan3", "firewall", "ipsec"
    actionbodystringaction to be executed. valid value are "start", "stop", "restart", "reload"
  • Response Example

    {
        "action": "start"
    }

Response

  • Normal response code: 200
  • Error response code: 400 (e.g. invalid action)
  • Response Parameters

    NameInTypeDescription
    resultbodystringoperation execution result 
  • Response Example

    {
        "result": "success"
    }


WAN3

SD-EWAN MWAN3 API provides support to get/create/update/delete MWAN3 Rule, Policy.


Firewall

SD-EWAN Firewall API provides support to get/create/update/delete Firewall Rule (include Firewall, SNAT, DNAT etc.).

  • No labels