Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 40362 invoked by uid 99); 17 Nov 2015 13:52:51 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 17 Nov 2015 13:52:51 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 08EB9E0B39; Tue, 17 Nov 2015 13:52:51 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: pdion891@apache.org To: commits@cloudstack.apache.org Date: Tue, 17 Nov 2015 13:53:13 -0000 Message-Id: <9322a6123c984285945bc9806c4f0b7e@git.apache.org> In-Reply-To: <7cf16968534645638605a009c677cd10@git.apache.org> References: <7cf16968534645638605a009c677cd10@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [24/54] [partial] cloudstack-www git commit: 4.6.0 is out! http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateIso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateIso.html b/content/api/apidocs-4.6/domain_admin/updateIso.html new file mode 100644 index 0000000..7ef8a77 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateIso.html @@ -0,0 +1,250 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateIso

Updates an ISO file.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the image file	true
bootable	true if image is bootable, false otherwise; available only for updateIso API	false
details	Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61	false
displaytext	the display text of the image	false
format	the format for the image	false
isdynamicallyscalable	true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory	false
isrouting	true if the template type is routing i.e., if template is used to deploy router	false
name	the name of the image file	false
ostypeid	the ID of the OS type that best represents the OS of this image.	false
passwordenabled	true if the image supports the password reset feature; default is false	false
requireshvm	true if the template requres HVM, false otherwise; available only for updateTemplate API	false
sortkey	sort key of the template, integer	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the template ID
account	the account name to which the template belongs
accountid	the account id to which the template belongs
bootable	true if the ISO is bootable, false otherwise
checksum	checksum of the template
created	the date this template was created
crossZones	true if the template is managed across all Zones, false otherwise
details	additional key/value details tied with template
displaytext	the template display text
domain	the name of the domain to which the template belongs
domainid	the ID of the domain to which the template belongs
format	the format of the template.
hostid	the ID of the secondary storage host for the template
hostname	the name of the secondary storage host for the template
hypervisor	the hypervisor on which the template runs
isdynamicallyscalable	true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory
isextractable	true if the template is extractable, false otherwise
isfeatured	true if this template is a featured template, false otherwise
ispublic	true if this template is a public template, false otherwise
isready	true if the template is ready to be deployed from, false otherwise.
name	the template name
ostypeid	the ID of the OS type for this template.
ostypename	the name of the OS type for this template.
passwordenabled	true if the reset password feature is enabled, false otherwise
project	the project name of the template
projectid	the project id of the template
removed	the date this template was removed
size	the size of the template
sourcetemplateid	the template ID of the parent template if present
sshkeyenabled	true if template is sshkey enabled, false otherwise
status	the status of the template
templatetag	the tag of this template
templatetype	the type of the template
zoneid	the ID of the zone for this template
zonename	the name of the zone for this template
*tags()**	the list of resource tags associated with tempate
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
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateIsoPermissions.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateIsoPermissions.html b/content/api/apidocs-4.6/domain_admin/updateIsoPermissions.html new file mode 100644 index 0000000..bf1c781 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateIsoPermissions.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateIsoPermissions

Updates ISO permissions

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	the template ID	true
accounts	a comma delimited list of accounts. If specified, "op" parameter has to be passed in.	false
isextractable	true if the template/iso is extractable, false other wise. Can be set only by root admin	false
isfeatured	true for featured template/iso, false otherwise	false
ispublic	true for public template/iso, false for private templates/isos	false
op	permission operator (add, remove, reset)	false
projectids	a comma delimited list of projects. If specified, "op" parameter has to be passed in.	false

Response Tags

+ + + + + + + + + + +

Response Name	Description
displaytext	any text associated with the success or failure
success	true if operation is executed successfully

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateLBHealthCheckPolicy.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateLBHealthCheckPolicy.html b/content/api/apidocs-4.6/domain_admin/updateLBHealthCheckPolicy.html new file mode 100644 index 0000000..2b2f24e --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateLBHealthCheckPolicy.html @@ -0,0 +1,124 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateLBHealthCheckPolicy

Updates load balancer health check policy

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
id	ID of load balancer health check policy	true
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
fordisplay	an optional field, whether to the display the policy to the end user or not	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
account	the account of the HealthCheck policy
domain	the domain of the HealthCheck policy
domainid	the domain ID of the HealthCheck policy
lbruleid	the LB rule ID
zoneid	the id of the zone the HealthCheck policy belongs to
*healthcheckpolicy()**	the list of healthcheckpolicies
id	the LB HealthCheck policy ID
description	the description of the healthcheck policy
fordisplay	is policy for display to the regular user
healthcheckinterval	Amount of time between health checks
healthcheckthresshold	Number of consecutive health check success before declaring an instance healthy
pingpath	the pingpath of the healthcheck policy
responsetime	Time to wait when receiving a response from the health check
state	the state of the policy
unhealthcheckthresshold	Number of consecutive health check failures before declaring an instance unhealthy.

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateLBStickinessPolicy.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateLBStickinessPolicy.html b/content/api/apidocs-4.6/domain_admin/updateLBStickinessPolicy.html new file mode 100644 index 0000000..9614c66 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateLBStickinessPolicy.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateLBStickinessPolicy

Updates load balancer stickiness policy

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
id	id of lb stickiness policy	true
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
fordisplay	an optional field, whether to the display the policy to the end user or not	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
account	the account of the Stickiness policy
description	the description of the Stickiness policy
domain	the domain of the Stickiness policy
domainid	the domain ID of the Stickiness policy
lbruleid	the LB rule ID
name	the name of the Stickiness policy
state	the state of the policy
zoneid	the id of the zone the Stickiness policy belongs to
*stickinesspolicy()**	the list of stickinesspolicies
id	the LB Stickiness policy ID
description	the description of the Stickiness policy
fordisplay	is policy for display to the regular user
methodname	the method name of the Stickiness policy
name	the name of the Stickiness policy
params	the params of the policy
state	the state of the policy

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateLoadBalancer.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateLoadBalancer.html b/content/api/apidocs-4.6/domain_admin/updateLoadBalancer.html new file mode 100644 index 0000000..2be99cd --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateLoadBalancer.html @@ -0,0 +1,178 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateLoadBalancer

Updates a load balancer

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the load balancer	true
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
fordisplay	an optional field, whether to the display the rule to the end user or not	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the Load Balancer ID
account	the account of the Load Balancer
algorithm	the load balancer algorithm (source, roundrobin, leastconn)
description	the description of the Load Balancer
domain	the domain of the Load Balancer
domainid	the domain ID of the Load Balancer
fordisplay	is rule for display to the regular user
name	the name of the Load Balancer
networkid	Load Balancer network id
project	the project name of the Load Balancer
projectid	the project id of the Load Balancer
sourceipaddress	Load Balancer source ip
sourceipaddressnetworkid	Load Balancer source ip network id
*loadbalancerinstance()**	the list of instances associated with the Load Balancer
id	the instance ID
ipaddress	the ip address of the instance
name	the name of the instance
state	the state of the instance
*loadbalancerrule()**	the list of rules associated with the Load Balancer
instanceport	instance port of the load balancer rule
sourceport	source port of the load balancer rule
state	the state of the load balancer rule
*tags()**	the list of resource tags associated with the Load Balancer
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateLoadBalancerRule.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateLoadBalancerRule.html b/content/api/apidocs-4.6/domain_admin/updateLoadBalancerRule.html new file mode 100644 index 0000000..5df4058 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateLoadBalancerRule.html @@ -0,0 +1,178 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateLoadBalancerRule

Updates load balancer

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the load balancer rule to update	true
algorithm	load balancer algorithm (source, roundrobin, leastconn)	false
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
description	the description of the load balancer rule	false
fordisplay	an optional field, whether to the display the rule to the end user or not	false
name	the name of the load balancer rule	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the load balancer rule ID
account	the account of the load balancer rule
algorithm	the load balancer algorithm (source, roundrobin, leastconn)
cidrlist	the cidr list to forward traffic from
description	the description of the load balancer
domain	the domain of the load balancer rule
domainid	the domain ID of the load balancer rule
fordisplay	is rule for display to the regular user
name	the name of the load balancer
networkid	the id of the guest network the lb rule belongs to
privateport	the private port
project	the project name of the load balancer
projectid	the project id of the load balancer
protocol	the protocol of the loadbalanacer rule
publicip	the public ip address
publicipid	the public ip address id
publicport	the public port
state	the state of the rule
zoneid	the id of the zone the rule belongs to
*tags()**	the list of resource tags associated with load balancer
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateNetwork.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateNetwork.html b/content/api/apidocs-4.6/domain_admin/updateNetwork.html new file mode 100644 index 0000000..7241b32 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateNetwork.html @@ -0,0 +1,310 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateNetwork

Updates a network

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the network	true
changecidr	Force update even if CIDR type is different	false
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
displaynetwork	an optional field, whether to the display the network to the end user or not.	false
displaytext	the new display text for the network	false
guestvmcidr	CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR	false
name	the new name for the network	false
networkdomain	network domain	false
networkofferingid	network offering ID	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the id of the network
account	the owner of the network
aclid	ACL Id associated with the VPC network
acltype	acl type - access type to the network
broadcastdomaintype	Broadcast domain type of the network
broadcasturi	broadcast uri of the network. This parameter is visible to ROOT admins only
canusefordeploy	list networks available for vm deployment
cidr	Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR
displaynetwork	an optional field, whether to the display the network to the end user or not.
displaytext	the displaytext of the network
dns1	the first DNS for the network
dns2	the second DNS for the network
domain	the domain name of the network owner
domainid	the domain id of the network owner
gateway	the network's gateway
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
isdefault	true if network is default, false otherwise
ispersistent	list networks that are persistent
issystem	true if network is system, false otherwise
name	the name of the network
netmask	the network's netmask
networkcidr	the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomain	the network domain
networkofferingavailability	availability of the network offering the network is created from
networkofferingconservemode	true if network offering is ip conserve mode enabled
networkofferingdisplaytext	display text of the network offering the network is created from
networkofferingid	network offering id the network is created from
networkofferingname	name of the network offering the network is created from
physicalnetworkid	the physical network id
project	the project name of the address
projectid	the project id of the ipaddress
related	related to what other network configuration
reservediprange	the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes
restartrequired	true network requires restart
specifyipranges	true if network supports specifying ip ranges, false otherwise
state	state of the network
strechedl2subnet	true if network can span multiple zones
subdomainaccess	true if users from subdomains can access the domain level network
traffictype	the traffic type of the network
type	the type of the network
vlan	The vlan of the network. This parameter is visible to ROOT admins only
vpcid	VPC the network belongs to
zoneid	zone id of the network
zonename	the name of the zone the network belongs to
zonesnetworkspans	If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans
*service()**	the list of services
name	the service name
*capability()**	the list of capabilities
canchooseservicecapability	can this service capability value can be choosable while creatine network offerings
name	the capability name
value	the capability value
*provider()**	the service provider name
id	uuid of the network provider
canenableindividualservice	true if individual services can be enabled/disabled
destinationphysicalnetworkid	the destination physical network
name	the provider name
physicalnetworkid	the physical network this belongs to
servicelist	services for this provider
state	state of the network provider
*tags()**	the list of resource tags associated with network
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateNetworkACLItem.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateNetworkACLItem.html b/content/api/apidocs-4.6/domain_admin/updateNetworkACLItem.html new file mode 100644 index 0000000..f8fc98d --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateNetworkACLItem.html @@ -0,0 +1,178 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateNetworkACLItem

Updates ACL item with specified ID

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the network ACL item	true
action	scl entry action, allow or deny	false
cidrlist	the cidr list to allow traffic from/to	false
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
endport	the ending port of ACL	false
fordisplay	an optional field, whether to the display the rule to the end user or not	false
icmpcode	error code for this ICMP message	false
icmptype	type of the ICMP message being sent	false
number	The network of the vm the ACL will be created for	false
protocol	the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number	false
startport	the starting port of ACL	false
traffictype	the traffic type for the ACL,can be Ingress or Egress, defaulted to Ingress if not specified	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the ACL Item
aclid	the ID of the ACL this item belongs to
action	Action of ACL Item. Allow/Deny
cidrlist	the cidr list to forward traffic from
endport	the ending port of ACL'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
number	Number of the ACL Item
protocol	the protocol of the ACL
startport	the starting port of ACL's port range
state	the state of the rule
traffictype	the traffic type for the ACL
*tags()**	the list of resource tags associated with the network ACLs
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updateNetworkACLList.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateNetworkACLList.html b/content/api/apidocs-4.6/domain_admin/updateNetworkACLList.html new file mode 100644 index 0000000..7baf6a6 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateNetworkACLList.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin API Reference + +

updateNetworkACLList

Updates network ACL list

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
id	the ID of the network ACL	true
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
fordisplay	an optional field, whether to the display the list to the end user or not	false

Response Tags

+ + + + + + + + + + +

Response Name	Description
displaytext	any text associated with the success or failure
success	true if operation is executed successfully

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/dc20554d/content/api/apidocs-4.6/domain_admin/updatePortForwardingRule.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updatePortForwardingRule.html b/content/api/apidocs-4.6/domain_admin/updatePortForwardingRule.html new file mode 100644 index 0000000..d6e7cd6 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updatePortForwardingRule.html @@ -0,0 +1,169 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.6.0 Domain Admin 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
id	the ID of the port forwarding rule	true
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
fordisplay	an optional field, whether to the display the rule to the end user or not	false
privateport	the private port of the port forwarding rule	false
virtualmachineid	the ID of the virtual machine for the port forwarding rule	false
vmguestip	VM guest nic Secondary ip address for the port forwarding rule	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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

+ +