Apache CloudStack 4.15.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 (,). | 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 |
| 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 |
| vmguestip | the vm 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 |
| 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 |