Apache CloudStack v4.8.0 User API Reference

createPortForwardingRule

Creates a port forwarding rule

Request parameters

Parameter Name	Description	Required
ipaddressid	the IP address id of the port forwarding rule	true
privateport	the starting port of port forwarding rule's private port range	true
protocol	the protocol for the port forwarding rule. Valid values are TCP or UDP.	true
publicport	the starting port of port forwarding rule's public port range	true
virtualmachineid	the ID of the virtual machine for the port forwarding rule	true
cidrlist	the cidr list to forward traffic from	false
fordisplay	an optional field, whether to the display the rule to the end user or not	false
networkid	the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).	false
openfirewall	if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true	false
privateendport	the ending port of port forwarding rule's private port range	false
publicendport	the ending port of port forwarding rule's private port range	false
vmguestip	VM guest nic secondary IP address for the port forwarding rule	false

Response Name	Description
id	the ID of the port forwarding rule
cidrlist	the cidr list to forward traffic from
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
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