Description

Port Forward

REST Name
forward
Methods
list
List
create
Create
retrieve
Retrieve
update
Update
delete
Delete
Properties
Name Data Possible Values Description
port/from/begin

Type

  • string

Default

  • None

Rules

  • required
  • valid_port_number

From Port

object(stdClass)#96 (1) { ["From Port Begin"]=> array(1) { [0]=> string(35) "Forward from starting port for rule" } }

object(stdClass)#97 (1) { ["From Port end"]=> array(1) { [0]=> string(41) "Forward from last port for rule(optional)" } }

port/to/end

Type

  • string

Default

  • None

Rules

  • valid_port_number

:

protocol

Type

  • Enumeration

Default

  • any

Rules

  • required

Values

  • udp - UDP
  • any - UDP + TCP
  • tcp - TCP

Protocol

What protocol to consider in the rule

description

Type

  • string

Default

  • None

Description

port/to/begin

Type

  • string

Default

  • None

Rules

  • valid_port_number

To Port

object(stdClass)#103 (1) { ["To Port Begin"]=> array(1) { [0]=> string(95) "Forward to starting port for rule(optional), if not set then forward to same port as from port." } }

object(stdClass)#104 (1) { ["To Port end"]=> array(1) { [0]=> string(39) "Forward to last port for rule(optional)" } }

port/from/end

Type

  • string

Default

  • None

Rules

  • valid_port_number

:

to/ip

Type

  • string

Default

  • None

Rules

  • required
  • valid_ip

IP

The IP address to be forward

partial

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Partial port forwarding

Forward packets without changing the source address.

This option may be useful if the forwarded IP needs to have the exact source address at the IP level. However, proper operation requires the default route of the forwarded IP to be pointing to the SBC. For normal port forwarding scenarios, this option should be disabled.