Apache CloudStack 4.23.0.0 Root Admin API Reference
listIpForwardingRules
List the IP forwarding rules
Request parameters
| Parameter Name | Description | Required |
| account | List resources by Account. Must be used with the domainId parameter. | false |
| domainid | List only resources belonging to the domain specified | false |
| id | Lists rule with the specified ID. | false |
| ipaddressid | List the rule belonging to this public IP address | false |
| isrecursive | Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| keyword | List by keyword | false |
| listall | If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| page | false | |
| pagesize | false | |
| projectid | List objects by project; if projectid=-1 lists All Instances | false |
| virtualmachineid | Lists all rules applied to the specified Instance. | 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 |