Apache CloudStack v4.4.0 Domain Admin API Reference

createPortForwardingRule

Creates a port forwarding rule

Request parameters

Parameter NameDescriptionRequired
ipaddressidthe IP address id of the port forwarding ruletrue
privateportthe starting port of port forwarding rule's private port rangetrue
protocolthe protocol for the port fowarding rule. Valid values are TCP or UDP.true
publicportthe starting port of port forwarding rule's public port rangetrue
virtualmachineidthe ID of the virtual machine for the port forwarding ruletrue
cidrlistthe cidr list to forward traffic fromfalse
fordisplayan optional field, whether to the display the rule to the end user or notfalse
networkidThe network of the vm the Port Forwarding rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)false
openfirewallif true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to truefalse
privateendportthe ending port of port forwarding rule's private port rangefalse
publicendportthe ending port of port forwarding rule's private port rangefalse
vmguestipVM guest nic Secondary ip address for the port forwarding rulefalse

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