The NAT Port Forward resource controls the SBC's NAT Port Forward configuration settings.
REST API Methods for this Resource
- GET natportforward
- GET natportforward id
- POST natportforward id
- PUT natportforward id
- DELETE natportforward id
Resource Schema
Configuration
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| PfDescription | No | No | string | none | 64 - Max Length | Assigns an operator-friendly description text configured by the operator for future reference. Blank spaces are allowed. |
| PfExternalInterface | Yes | Yes | string | none | 20 - 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. |
| PrivateHostIP | Yes | Yes | string | none | 20 - 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. |
| IpProtocol | Yes | Yes | Enum | 0 | Possible values:
| Specifies the IP protocol allowed in the port forwarded connection. |
| ExternalPortStart | Yes | Yes | int | Possible values:
| 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. | |
| PrivatePortStart | Yes | Yes | int | Possible values:
| Specifies the first IP port number to use on the private network. | |
| NumberOfPorts | Yes | Yes | int | Possible values:
| 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. |
Overview
Content Tools