Apache CloudStack 4.20.0.0 Root Admin API Reference
createRoutingFirewallRule
Creates a routing firewall rule in the given network in ROUTED mode
Request parameters
| Parameter Name | Description | Required |
| networkid | The network of the VM the firewall rule will be created for | true |
| protocol | the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number | true |
| cidrlist | the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). | false |
| destcidrlist | the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). | false |
| endport | the ending port of firewall rule | false |
| fordisplay | an optional field, whether to the display the rule to the end user or not | false |
| icmpcode | error code for this ICMP message | false |
| icmptype | type of the ICMP message being sent | false |
| startport | the starting port of firewall rule | false |
| traffictype | the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified | 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 |
| 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 |