Apache CloudStack 4.23.0.0 Root Admin API Reference
listFirewallRules
Lists all firewall rules for an IP address.
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 |
| fordisplay | List resources by display flag; only ROOT admin is eligible to pass this parameter | false |
| id | Lists rule with the specified ID. | false |
| ipaddressid | The ID of IP address of the firewall services | 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 |
| networkid | List firewall rules for certain network | false |
| page | false | |
| pagesize | false | |
| projectid | List objects by project; if projectid=-1 lists All Instances | false |
| tags | List resources by tags (key/value pairs) | 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 |
| vpcid | The VPC ID of 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 |