Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 14 Next »

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

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

URL:

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

HTTP Method

PUT

Requires Authentication:

true



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. White-space characters are allowed.
PfExternalInterfaceYesYesstringnone20 - Max Length Specifies the name of the SBC1000/2000 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 SBC1000/2000 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 SBC1000/2000.

Usage Example: (about cURL | requires a session token)

Put code example here

Response:

Put Code response here
  • No labels