Page Comparison

...

• 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:

...

Error Response:

...

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

Execute a operation for a service

Request: 

Request Parameters

...

Response Example

...

Response

...

Architecture

SDEWAN CNF enhances OpenWRT Luci web interface with SDEWAN controllers to provide Restful API for network functions' configuration and control.

Image Added

CNF includes below modules:

• MWAN3: mwan3 configuration for multiple WAN links’ management
• Firewall: fw3 configuration for firewall rule, NAT rule.
• IpSec: strongswan configuration to setup security tunnel between CNFs
• DNS/DHCP: dnsmasq configuration for DNS and DHCP (ip4) or odhcpd configuration for DHCP (ip6)
• BGP/OSPF: bird configuration for BGP/OSPF auto routing
• Service: manage (e.g. start, stop, restart etc.) lifecycle of network function applications (e.g. mwan3, fw3, strongswan etc.)
• Runtime States: exports system log for debugging

APIs

Common Error code:

Error Response:

SDEWAN Service

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

PUT /cgi-bin/luci/sdewan/v1/services/{service-name}/

Execute a operation for a service

Request: 

• Request Parameters

  Name	In	Type	Description
  service-name	path	string	service name, valid value are "mwan3", "firewall", "ipsec"
  action	body	string	action to be executed. valid value are "start", "stop", "restart", "reload"

  
  

• Request Example

  {     "action": "start" }

  
  

Response

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

• Response Parameters

  Name	In	Type	Description
  result	body	string	operation execution result

  
  

• Response Example

  {     "result": "success" }

  
  

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

  Name	In	Type	Description
  services	body	array	a list of supported service

  
  

• Response Example

  
  

  {     "services": ["mwan3", "firewall", "ipsec"] }

  
  

SDEWAN Interface

SDEWAN interface API provide network interfaces information and control to up/down a network interface

PUT /cgi-bin/luci/sdewan/v1/interfaces/{interface}/

Execute a operation for a service

Request: 

• Request Parameters

  Name	In	Type	Description
  interface	path	string	interface name, e.g. "eth0"
  action	body	string	action to be executed. valid value are "up", "down"

  
  

• Request Example

  {     "action": "up" }

  
  

Response

• Normal response code: 200
• Error response code: 400 (e.g. invalid action), 404 (e.g. interface not found)

• Response Parameters

  Name	In	Type	Description
  result	body	string	operation execution result

  
  

• Response Example

  {     "result": "success" }

  
  

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

Lists all available network interfaces of the SDEWAN CNF

Request: N/A

Response

• Normal response codes: 200

• Response Parameters

  Name	In	Type	Description
  interfaces	body	array	a list of available network interfaces
  ip_address	body	array	ip address of the interface
  ip6_address	body	array	ipv6 address of the interface
  mac_address	body	string	mac address of the interface
  status	body	string	interface status, valid value are "UP", "DOWN"
  received_packets	body	string	number of received packets
  send_packets	body	string	number of send packaets

  
  

• Response Example

  
  

  {"interfaces": [     { "ip_address: ["10.0.0.1"],        "name":"eth0",        "status":"UP",        "send_packets":"19148",       "mac_address":"22:22:22:22:22:22",      "receive_packets":"20923" } ]}

  
  

GET /cgi-bin/luci/sdewan/v1/interfaces/{interface-name}

get information of a network interfaces of the SDEWAN CNF

Request: N/A

Response

• Normal response codes: 200

• Response Parameters

• Normal response codes: 200

• Response Parameters

  NameInTypeDescriptionservicesbodyarraya list of supported serviceResponse Example
  {
      "services": ["mwan3", "firewall", "ipsec"]
  result

  Name	In	Type	Description
  interface-name	path	string	interface name
  ip_address	body	array	ip address of the interface
  ip6_address	body	array	ipv6 address of the interface
  mac_address	body	string	mac address of the interface
  status	body	string	operation execution result

  Response Example

  {
      "result": "success"
  }

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

Lists all available sdewan services supported by SDEWAN CNF

Request: N/A

Response

• interface status, valid value are "UP", "DOWN"
  received_packets	body	string	number of received packets
  send_packets	body	string	number of send packaets

  
  

• Response Example

  
  

  { "ip_address: ["10.0.0.1"],        "name":"eth0",        "status":"UP",        "send_packets":"19148",       "mac_address":"22:22:22:22:22:22",      "receive_packets":"20923" }

  
  

MWAN3

OpenWRT MWAN3 configuration includes below sections:

...

• Normal response codes: 200

• Response Parameters

  Name	In	Type	Description
  policies	body	array	a list of defined policies

  
  

• Response Example

  
  

  {     "policies": [         {             "name":"balanced",             "members": [                 {                       "interface": "net1",                       "metric" 1,                       "weight": 2                 }                 {                       "interface": "net2",                       "metric" 1,                       "weight": 1                 }              ]         }     ] }

  
  

GET /cgi-bin/luci/sdewan/mwan3/v1/policies/{policy-name}

...

Request: N/A

• Request Parameters

  Name	In	Type	Description
  policy-name	path	string	policy name

  
  

Response

• Normal response codes: 200
• Error response code: 404

• Response Parameters

  Name	In	Type	Description
  name	body	string	policy name
  members	body	array	policy members
  interface	body	string	member interface name
  metric	body	int	(optional) default: 1, members within one policy with a lower metric have precedence over higher metric members
  weight	body	int	(optional) default: 1, members with same metric will distribute load based on this weight value

  
  

• Response Example

  
  

  {       "name": "balanced",        "members": [            {                "interface": "net1",                "metric" 1,                "weight": 2             }             {                 "interface": "net2",                 "metric" 1,                  "weight": 1             }        ] }

  
  

DELETE /cgi-bin/luci/sdewan/mwan3/v1/policies/{policy-name}

...

• Normal response codes: 200

• Response Parameters

  Name	In	Type	Description
  rules	body	array	a list of defined rules

  
  

• Response Example

  
  

  {     "rules": [         {             "name":"default_rule",             "dest_ip": "0.0.0.0/0"，             "policy": "balanced"         }      ] }

  
  

GET /cgi-bin/luci/sdewan/mwan3/v1/rules/{rule-name}

...

Request: N/A

• Request Parameters

  Name	In	Type	Description
  rule-name	path	string	rule name

  
  

Response

• Normal response codes: 200
• Error response code: 404

• Response Parameters

  Name	In	Type	Description
  name	body	string	rule name
  policy	body	string	policy used for the rule
  src_ip	body	string	(optional) source ip address
  src_port	body	string	(optional) source port or port range
  dest_ip	body	string	(optional) destination ip address
  dest_port	body	string	(optional) destination port or port range
  proto	body	string	(optional) protocol for the rule. Valid values: "tcp", "udp", "icmp", "all"
  family	body	string	(optional) address family. Valid values: "ipv4", "ipv6", "all"
  sticky	body	string	(optional) default: 0, allow traffic from the same source ip address within the timeout limit to use same wan interface as prior session
  timeout	body	int	(optional) default: 600,  Stickiness timeout value in seconds

  
  

• Response Example

  
  

  #ipv4 example {     "name":"default_rule",     "dest_ip": "0.0.0.0/0"，      "policy": "balanced" } #ipv6 example {     "name":"default_ipv6_rule",     "dest_ip": "fdca:f00:ba3::/64"，      "policy": "balanced" }

  
  

DELETE /cgi-bin/luci/sdewan/mwan3/v1/rules/{rule-name}

...

• Normal response codes: 200

• Response Parameters

  Name	In	Type	Description
  zones	body	array	a list of defined zones

  
  

• Response Example

  
  

  {     "zones": [         {             "name":"wan"，             "network":"wan"，             "input": "REJECT"，             "output": "ACCEPT"，             "forward": "REJECT"，             "masq": "1"，             "mtu_fix": "1"          }     ] }

  
  

GET /cgi-bin/luci/sdewan/firewall/v1/zones/{zone-name}

...

Request: N/A

• Request Parameters

  Name	In	Type	Description
  zone-name	path	string	zone name

  
  

Response

• Normal response codes: 200
• Error response code: 404

• Response Parameters

  Name	In	Type	Description
  name	body	string	(Required) zone name
  network	body	array	List of interfaces attached to this zone
  masq	body	boolean	Specifies whether outgoing zone traffic should be masqueraded. "0" or "1"
  masq_src	body	string	Limit masquerading to the given source subnets.
  masq_dest	body	string	Limit masquerading to the given destination subnets
  masq_allow_invalid	body	boolean	whether add DROP INVALID rules
  mtu_fix	body	boolean	Enable MSS clamping for outgoing zone traffic
  input	body	string	Default policy (ACCEPT, REJECT, DROP) for incoming zone traffic.
  forward	body	string	Default policy (ACCEPT, REJECT, DROP) for forwarded zone traffic.
  output	body	string	Default policy (ACCEPT, REJECT, DROP) for output zone traffic.
  family	body	string	The protocol family (ipv4, ipv6 or any) these iptables rules are for.
  subnet	body	string	List of IP subnets attached to this zone
  extra_src	body	string	Extra arguments passed directly to iptables for source classification rules.
  etra_dest	body	string	Extra arguments passed directly to iptables for destination classification rules.

  
  

• Response Example

  
  

  {       "name":"wan",        "network":"wan"，        "input": "REJECT"，        "output": "ACCEPT"，       "forward": "REJECT"，        "masq": "1"，        "mtu_fix": "1"， }

  
  

DELETE /cgi-bin/luci/sdewan/firewall/v1/zones/{zone-name}

...

• Normal response codes: 200

• Response Parameters

  Name	In	Type	Description
  redirects	body	array	a list of defined redirects

  
  

• Response Example

  
  

  {     "redirects": [         {             "name":"dnat_lan",             "src":"wan",             "src_dport":"19900",             "dest":"lan",             "dest_ip":"192.168.1.1",             "dest_port":"22",             "proto":"tcp",             "target":"DNAT"       }     ] }

  
  

GET /cgi-bin/luci/sdewan/firewall/v1/redirects/{redirect-name}

...

Request: N/A

• Request Parameters

  Name	In	Type	Description
  redirect-name	path	string	redirect name

  
  

Response

• Normal response codes: 200
• Error response code: 404

• Response Parameters

  Name	In	Type	Description
  name	body	string	(Required) forwarding name
  src	body	string	(Required for DNAT) traffic source zone
  src_ip	body	string	Match incoming traffic from the specified source ip address.
  src_dip	body	string	(Required for SNAT) For DNAT, match incoming traffic directed at the given destination ip address. For SNAT rewrite the source address to the given address.
  src_mac	body	string	Match incoming traffic from the specified mac address.
  src_port	body	port or range	Match incoming traffic originating from the given source port or port range on the client host.
  src_dport	body	port or range	For DNAT, match incoming traffic directed at the given destination port or port range on this host. For SNAT rewrite the source ports to the given value.
  proto	body	string	Match incoming traffic using the given protocol. Can be one of tcp, udp, tcpudp, udplite, icmp, esp, ah, sctp, or all
  dest	body	string	Specifies the traffic destination zone. Must refer to one of the defined zone names.
  dest_ip	body	string	For DNAT, redirect matches incoming traffic to the specified internal host. For SNAT, it matches traffic directed at the given address.
  dest_port	body	port or range	For DNAT, redirect matched incoming traffic to the given port on the internal host. For SNAT, match traffic directed at the given ports.
  mark	body	string	match traffic against the given firewall mark
  target	body	string	(Required) NAT target: SNAT, DNAT
  family	body	string	Protocol family (ipv4, ipv6 or any) to generate iptables rules for

  
  

• Response Example

  
  

  {     "name":"dnat_lan",     "src":"wan",     "src_dport":"19900",     "dest":"lan",     "dest_ip":"192.168.1.1",     "dest_port":"22",     "proto":"tcp",     "target":"DNAT" }

  
  

DELETE /cgi-bin/luci/sdewan/firewall/v1/redirects/{redirect-name}

...

• Normal response codes: 200

• Response Parameters

  Name	In	Type	Description
  rules	body	array	a list of defined rules

  
  

• Response Example

  
  

  {     "rules": [        {            "name":"reject_lan_80"            "src":"lan"，            "src_ip": "192.168.1.2",            "src_port": "80",            "proto":"tcp",            "target":"REJECT"       }     ] }

  
  

GET /cgi-bin/luci/sdewan/firewall/v1/rules/{rule-name}

...

Request: N/A

• Request Parameters

  Name	In	Type	Description
  rule-name	path	string	rule name

  
  

Response

• Normal response codes: 200
• Error response code: 404

• Response Parameters

  Name	In	Type	Description
  name	body	string	(Required) rule name
  src	body	string	(Required) traffic source zone
  src_ip	body	string	Match incoming traffic from the specified source ip address
  src_mac	body	string	Match incoming traffic from the specified mac address
  src_port	body	port or range	Match incoming traffic from the specified source port or port range
  proto	body	string	Match incoming traffic using the given protocol. Can be one of tcp, udp, tcpudp, udplite, icmp, esp, ah, sctp, or all
  icmp_type	body	string	For protocol icmp select specific icmp types to match.
  dest	body	string	traffic destination zone. Must refer to one of the defined zone names, or * for any zone
  dest_ip	body	string	Match incoming traffic directed to the specified destination ip address
  dest_port	body	port or range	Match incoming traffic directed at the given destination port or port range
  mark	body	string	If specified, match traffic against the given firewall mark
  target	body	string	(Required) Firewall action (ACCEPT, REJECT, DROP, MARK, NOTRACK) for matched traffic
  set_mark	body	string	Zeroes out the bits given by mask and ORs value into the packet mark.
  set_xmark	body	string	Zeroes out the bits given by mask and XORs value into the packet mark
  family	body	string	Protocol family (ipv4, ipv6 or any) to generate iptables rules for
  extra	body	string	Extra arguments to pass to iptables. Useful mainly to specify additional match options, such as -m policy --dir in for IPsec.

  
  

• Response Example

  
  

  {        "name":"reject_lan_80"        "src":"lan"，        "src_ip": "192.168.1.2",        "src_port": "80",        "proto":"tcp",        "target":"REJECT" }

  
  

DELETE /cgi-bin/luci/sdewan/firewall/v1/rules/{rule-name}

...

• Normal response codes: 200

• Response Parameters

  Name	In	Type	Description
  forwardings	body	array	a list of defined forwardings

  
  

• Response Example

  
  

  {     "forwardings": [         {           "name":"lan_wan",           "src":"lan"，           "dest": "wan"       }     ] }

  
  

GET /cgi-bin/luci/sdewan/firewall/v1/forwardings/{forwarding-name}

...

Request: N/A

• Request Parameters

  Name	In	Type	Description
  forwarding-name	path	string	forwarding name

  
  

Response

• Normal response codes: 200
• Error response code: 404

• Response Parameters

  Name	In	Type	Description
  name	body	string	(Required) forwarding name
  src	body	string	(Required) traffic source zone
  dest	body	string	(Required) traffic destination zone
  family	body	string	Protocol family (ipv4, ipv6 or any) to generate iptables rules for.

  
  

• Response Example

  
  

  {       "name":"lan_wan",       "src":"lan"，       "dest": "wan" }

  
  

DELETE /cgi-bin/luci/sdewan/firewall/v1/forwardings/{forwarding-name}

...