The NAT Port Forward resource controls the SBC Edge system's NAT Port Forward configuration settings.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
PfDescriptionNoNostringnone64 - Max Length Assigns an operator-friendly description text configured by the operator for future reference. White-space characters are allowed.
PfExternalInterfaceYesYesstringnone20 - Max Length Specifies the name of the SBC Edge logical interface connected to the external network. Any of the Ethernet, VLAN or Loopback primary interfaces can be used.
PrivateHostIPYesYesstringnone20 - Max Length Specifies the IP address of the host on the private network that will be the port forward destination. Must be a IPv4 address.
IpProtocolYesYesEnum0Possible values:
  • 0 - NAT_PORT_FORWARD_TCP
  • 1 - NAT_PORT_FORWARD_UDP
Specifies the IP protocol allowed in the port forwarded connection.
ExternalPortStartYesYesintPossible values:
  • 0 - Minimum
  • 65535 - Maximum
Specifies the first IP port number to use on the external network. This will be checked to be sure it is not one of the SBC Edge reserved ports.
PrivatePortStartYesYesintPossible values:
  • 0 - Minimum
  • 65535 - Maximum
Specifies the first IP port number to use on the private network.
NumberOfPortsYesYesintPossible values:
  • 0 - Minimum
  • 65535 - Maximum
Specifies the number of ports to map from the external network to the private. This will be checked to be sure no members of the resulting range of ports are reserved by the SBC Edge.