REST API Method: POST /rest/natportforward/{identifier}

Modifies a NAT Port Forward managed object given a specific ID.

URL:

https://192.168.0.111/rest/natportforward/{identifier}

HTTP Method

POST

Requires Authentication:

true

natportforward - REST API Methods

Parameters

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. Blank spaces are allowed.
PfExternalInterfaceYesYesstringnone20 - Max Length Specifies the name of the SBC 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 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.

Helpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

  • No labels