Apache CloudStack 4.20.0.0 Root Admin API Reference
createFirewallRule
Creates a firewall rule for a given IP address
Request parameters
| Parameter Name | Description | Required |
| ipaddressid | the IP address id of the port forwarding rule | true |
| protocol | the protocol for the firewall rule. Valid values are TCP/UDP/ICMP. | true |
| cidrlist | the CIDR list to forward traffic from. 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 |
| type | type of firewallrule: system/user | false |
Response Tags
| Response Name | Description |
| id | the ID of the firewall rule |
| cidrlist | the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,). |
| destcidrlist | the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,). |
| endport | the ending port of firewall rule's port range |
| fordisplay | is rule for display to the regular user |
| icmpcode | error code for this icmp message |
| icmptype | type of the icmp message being sent |
| ipaddress | the public ip address for the firewall rule |
| ipaddressid | the public ip address id for the firewall rule |
| networkid | the network id of the firewall rule |
| protocol | the protocol of the firewall rule |
| startport | the starting port of firewall rule's port range |
| state | the state of the rule |
| traffictype | the traffic type for the firewall 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 |