Apache CloudStack v4.2.0 User API Reference

updatePortForwardingRule

Updates a port forwarding rule. Only the private port and the virtual machine can be updated.

Request parameters

Parameter Name	Description	Required
ipaddressid	the IP address id of the port forwarding rule	true
privateport	the private port of the port forwarding rule	true
protocol	the protocol for the port fowarding rule. Valid values are TCP or UDP.	true
publicport	the public port of the port forwarding rule	true
privateip	the private IP address of the port forwarding rule	false
virtualmachineid	the ID of the virtual machine 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
ipaddress	the public ip address for the port forwarding rule
ipaddressid	the public ip address id for the port forwarding rule
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