Apache CloudStack 4.23.0.0 Root Admin API Reference
createIpForwardingRule
Creates an IP forwarding rule
Request parameters
| Parameter Name | Description | Required |
| ipaddressid | The public IP address ID of the forwarding rule, already associated via associateIp | true |
| protocol | The protocol for the rule. Valid values are TCP or UDP. | true |
| startport | The start port for the rule | true |
| cidrlist | The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. | false |
| endport | The end port for the rule | false |
| openfirewall | If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. 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. Multiple entries are separated by a single comma character (,). |
| fordisplay | Is firewall for display to the regular user |
| ipaddress | The public IP address for the port forwarding rule |
| ipaddressid | The public IP address id for the port forwarding rule |
| networkid | The ID of the guest Network the port forwarding rule belongs to |
| networkname | The Name of the guest Network the port forwarding rule belongs to |
| 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 Instance display name for the port forwarding rule |
| virtualmachineid | The Instance ID for the port forwarding rule |
| virtualmachinename | The Instance name for the port forwarding rule |
| vmguestip | The Instance IP address for the port forwarding rule |
| tags(*) | The list of resource tags associated with the rule |
| account | The Account associated with the tag |
| customer | Customer associated with the tag |
| domain | The domain associated with the tag |
| domainid | The ID of the domain associated with the tag |
| domainpath | Path of the Domain associated with the tag |
| key | Tag key name |
| project | The project name where tag belongs to |
| projectid | The project ID the tag belongs to |
| resourceid | ID of the resource |
| resourcetype | Resource type |
| value | Tag value |