Apache CloudStack v4.4.0 Domain Admin API Reference

listIpForwardingRules

List the ip forwarding rules

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idLists rule with the specified ID.false
ipaddressidlist the rule belonging to this public ip addressfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
pagefalse
pagesizefalse
projectidlist objects by projectfalse
virtualmachineidLists all rules applied to the specified Vm.false

Response Tags

Response NameDescription
idthe ID of the port forwarding rule
cidrlistthe cidr list to forward traffic from
fordisplayis firewall for display to the regular user
ipaddressthe public ip address for the port forwarding rule
ipaddressidthe public ip address id for the port forwarding rule
networkidthe id of the guest network the port forwarding rule belongs to
privateendportthe ending port of port forwarding rule's private port range
privateportthe starting port of port forwarding rule's private port range
protocolthe protocol of the port forwarding rule
publicendportthe ending port of port forwarding rule's private port range
publicportthe starting port of port forwarding rule's public port range
statethe state of the rule
virtualmachinedisplaynamethe VM display name for the port forwarding rule
virtualmachineidthe VM ID for the port forwarding rule
virtualmachinenamethe VM name for the port forwarding rule
vmguestipthe vm ip address for the port forwarding rule
tags(*)the list of resource tags associated with the rule
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value