CloudStack v2.2.13 - 2.2.14 User API Reference
createPortForwardingRule
Creates a port forwarding rule
Request parameters
| Parameter Name | Description | Required |
| ipaddressid | the IP address id of the port forwarding rule | true |
| privateport | the starting port of port forwarding rule's private port range | true |
| protocol | the protocol for the port fowarding rule. Valid values are TCP or UDP. | true |
| publicport | the starting port of port forwarding rule's public port range | true |
| virtualmachineid | the ID of the virtual machine for the port forwarding rule | true |
| cidrlist | the cidr list to forward traffic from | false |
| openfirewall | if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default | false |
Response Tags
| Response Name | Description |
| id | the ID of the port forwarding rule |
| cidrlist | the cidr list to forward traffic from |
| ipaddress | the public ip address for the port forwarding rule |
| ipaddressid | the public ip address id for the port forwarding rule |
| privateendport | the ending port of port forwarding rule's private port range |
| privateport | the starting port of port forwarding rule's private port range |
| protocol | the protocol of the port forwarding rule |
| publicendport | the ending port of port forwarding rule's private port range |
| publicport | the starting port of port forwarding rule's public port range |
| state | the state of the rule |
| virtualmachinedisplayname | the VM display name for the port forwarding rule |
| virtualmachineid | the VM ID for the port forwarding rule |
| virtualmachinename | the VM name for the port forwarding rule |