In-Reply-To: <22fd21d5896f4c5ebda5acb07bcadd93@git.apache.org> References: <22fd21d5896f4c5ebda5acb07bcadd93@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [22/53] [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/updateVMAffinityGroup.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateVMAffinityGroup.html b/content/api/apidocs-4.6/domain_admin/updateVMAffinityGroup.html new file mode 100644 index 0000000..b178e7b --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateVMAffinityGroup.html @@ -0,0 +1,508 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateVMAffinityGroup

Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.

+ +

Request parameters

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

Parameter Name	Description	Required
id	The ID of the virtual machine	true
affinitygroupids	comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter	false
affinitygroupnames	comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter	false

Response Tags

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

Response Name	Description
id	the ID of the virtual machine
account	the account associated with the virtual machine
cpunumber	the number of cpu this virtual machine is running with
cpuspeed	the speed of each cpu
cpuused	the amount of the vm's CPU currently used
created	the date when this virtual machine was created
details	Vm details in key/value pairs.
diskioread	the read (io) of disk on the vm
diskiowrite	the write (io) of disk on the vm
diskkbsread	the read (bytes) of disk on the vm
diskkbswrite	the write (bytes) of disk on the vm
diskofferingid	the ID of the disk offering of the virtual machine
diskofferingname	the name of the disk offering of the virtual machine
displayname	user generated name. The name of the virtual machine is returned if no displayname exists.
displayvm	an optional field whether to the display the vm to the end user or not.
domain	the name of the domain in which the virtual machine exists
domainid	the ID of the domain in which the virtual machine exists
forvirtualnetwork	the virtual network for the service offering
group	the group name of the virtual machine
groupid	the group ID of the virtual machine
guestosid	Os type ID of the virtual machine
haenable	true if high-availability is enabled, false otherwise
hostid	the ID of the host for the virtual machine
hostname	the name of the host for the virtual machine
hypervisor	the hypervisor on which the template runs
instancename	instance name of the user vm; this parameter is returned to the ROOT admin only
isdynamicallyscalable	true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.
isodisplaytext	an alternate display text of the ISO attached to the virtual machine
isoid	the ID of the ISO attached to the virtual machine
isoname	the name of the ISO attached to the virtual machine
keypair	ssh key-pair
memory	the memory allocated for the virtual machine
name	the name of the virtual machine
networkkbsread	the incoming network traffic on the vm
networkkbswrite	the outgoing network traffic on the host
ostypeid	OS type id of the vm
password	the password (if exists) of the virtual machine
passwordenabled	true if the password rest feature is enabled, false otherwise
project	the project name of the vm
projectid	the project id of the vm
publicip	public IP address id associated with vm via Static nat rule
publicipid	public IP address id associated with vm via Static nat rule
rootdeviceid	device ID of the root volume
rootdevicetype	device type of the root volume
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
servicestate	State of the Service from LB rule
state	the state of the virtual machine
templatedisplaytext	an alternate display text of the template for the virtual machine
templateid	the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatename	the name of the template for the virtual machine
userid	the user's ID who deployed the virtual machine
username	the user's name who deployed the virtual machine
vgpu	the vgpu type used by the virtual machine
zoneid	the ID of the availablility zone for the virtual machine
zonename	the name of the availability zone for the virtual machine
*affinitygroup()**	list of affinity groups associated with the virtual machine
id	the ID of the affinity group
account	the account owning the affinity group
description	the description of the affinity group
domain	the domain name of the affinity group
domainid	the domain ID of the affinity group
name	the name of the affinity group
type	the type of the affinity group
virtualmachineIds	virtual machine Ids associated with this affinity group
*nic()**	the list of nics associated with vm
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
deviceid	device id for the network when plugged into the virtual machine
gateway	the gateway of the nic
ip6address	the IPv6 address of network
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
ipaddress	the ip address of the nic
isdefault	true if nic is default, false otherwise
isolationuri	the isolation uri of the nic
macaddress	true if nic is default, false otherwise
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
secondaryip	the Secondary ipv4 addr of nic
traffictype	the traffic type of the nic
type	the type of the nic
virtualmachineid	Id of the vm to which the nic belongs
*securitygroup()**	list of security groups associated with the virtual machine
id	the ID of the security group
account	the account owning the security group
description	the description of the security group
domain	the domain name of the security group
domainid	the domain ID of the security group
name	the name of the security group
project	the project name of the group
projectid	the project id of the group
virtualmachinecount	the number of virtualmachines associated with this securitygroup
virtualmachineids	the list of virtualmachine ids associated with this securitygroup
*egressrule()**	the list of egress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
tags(*)	the list of resource tags associated with the rule
*ingressrule()**	the list of ingress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
tags(*)	the list of resource tags associated with the 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
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
*tags()**	the list of resource tags associated with vm
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/updateVPC.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateVPC.html b/content/api/apidocs-4.6/domain_admin/updateVPC.html new file mode 100644 index 0000000..5de7e75 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateVPC.html @@ -0,0 +1,406 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateVPC

Updates a VPC

+ +

Request parameters

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

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

Response Tags

Response Name	Description
id	the id of the VPC
account	the owner of the VPC
cidr	the cidr the VPC
created	the date this VPC was created
displaytext	an alternate display text of the VPC.
distributedvpcrouter	is VPC uses distributed router for one hop forwarding and host based network ACL's
domain	the domain name of the owner
domainid	the domain id of the VPC owner
fordisplay	is vpc for display to the regular user
name	the name of the VPC
networkdomain	the network domain of the VPC
project	the project name of the VPC
projectid	the project id of the VPC
redundantvpcrouter	if this VPC has redundant router
regionlevelvpc	true if VPC is region level
restartrequired	true VPC requires restart
state	state of the VPC. Can be Inactive/Enabled
vpcofferingid	vpc offering id the VPC is created from
zoneid	zone id of the vpc
zonename	the name of the zone the VPC belongs to
*network()**	the list of networks belongign to the VPC
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
provider(*)	the service provider name
*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
*service()**	the list of supported 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 the project
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/updateVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateVirtualMachine.html b/content/api/apidocs-4.6/domain_admin/updateVirtualMachine.html new file mode 100644 index 0000000..69d0c82 --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateVirtualMachine.html @@ -0,0 +1,535 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateVirtualMachine

Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.

+ +

Request parameters

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

Parameter Name	Description	Required
id	The ID of the virtual machine	true
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
details	Details in key/value pairs.	false
displayname	user generated name	false
displayvm	an optional field, whether to the display the vm to the end user or not.	false
group	group of the virtual machine	false
haenable	true if high-availability is enabled for the virtual machine, false otherwise	false
instancename	instance name of the user vm	false
isdynamicallyscalable	true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory	false
name	new host name of the vm. The VM has to be stopped/started for this update to take affect	false
ostypeid	the ID of the OS type that best represents this VM.	false
userdata	an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 32K of data after base64 encoding.	false

Response Tags

Response Name	Description
id	the ID of the virtual machine
account	the account associated with the virtual machine
cpunumber	the number of cpu this virtual machine is running with
cpuspeed	the speed of each cpu
cpuused	the amount of the vm's CPU currently used
created	the date when this virtual machine was created
details	Vm details in key/value pairs.
diskioread	the read (io) of disk on the vm
diskiowrite	the write (io) of disk on the vm
diskkbsread	the read (bytes) of disk on the vm
diskkbswrite	the write (bytes) of disk on the vm
diskofferingid	the ID of the disk offering of the virtual machine
diskofferingname	the name of the disk offering of the virtual machine
displayname	user generated name. The name of the virtual machine is returned if no displayname exists.
displayvm	an optional field whether to the display the vm to the end user or not.
domain	the name of the domain in which the virtual machine exists
domainid	the ID of the domain in which the virtual machine exists
forvirtualnetwork	the virtual network for the service offering
group	the group name of the virtual machine
groupid	the group ID of the virtual machine
guestosid	Os type ID of the virtual machine
haenable	true if high-availability is enabled, false otherwise
hostid	the ID of the host for the virtual machine
hostname	the name of the host for the virtual machine
hypervisor	the hypervisor on which the template runs
instancename	instance name of the user vm; this parameter is returned to the ROOT admin only
isdynamicallyscalable	true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.
isodisplaytext	an alternate display text of the ISO attached to the virtual machine
isoid	the ID of the ISO attached to the virtual machine
isoname	the name of the ISO attached to the virtual machine
keypair	ssh key-pair
memory	the memory allocated for the virtual machine
name	the name of the virtual machine
networkkbsread	the incoming network traffic on the vm
networkkbswrite	the outgoing network traffic on the host
ostypeid	OS type id of the vm
password	the password (if exists) of the virtual machine
passwordenabled	true if the password rest feature is enabled, false otherwise
project	the project name of the vm
projectid	the project id of the vm
publicip	public IP address id associated with vm via Static nat rule
publicipid	public IP address id associated with vm via Static nat rule
rootdeviceid	device ID of the root volume
rootdevicetype	device type of the root volume
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
servicestate	State of the Service from LB rule
state	the state of the virtual machine
templatedisplaytext	an alternate display text of the template for the virtual machine
templateid	the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatename	the name of the template for the virtual machine
userid	the user's ID who deployed the virtual machine
username	the user's name who deployed the virtual machine
vgpu	the vgpu type used by the virtual machine
zoneid	the ID of the availablility zone for the virtual machine
zonename	the name of the availability zone for the virtual machine
*affinitygroup()**	list of affinity groups associated with the virtual machine
id	the ID of the affinity group
account	the account owning the affinity group
description	the description of the affinity group
domain	the domain name of the affinity group
domainid	the domain ID of the affinity group
name	the name of the affinity group
type	the type of the affinity group
virtualmachineIds	virtual machine Ids associated with this affinity group
*nic()**	the list of nics associated with vm
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
deviceid	device id for the network when plugged into the virtual machine
gateway	the gateway of the nic
ip6address	the IPv6 address of network
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
ipaddress	the ip address of the nic
isdefault	true if nic is default, false otherwise
isolationuri	the isolation uri of the nic
macaddress	true if nic is default, false otherwise
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
secondaryip	the Secondary ipv4 addr of nic
traffictype	the traffic type of the nic
type	the type of the nic
virtualmachineid	Id of the vm to which the nic belongs
*securitygroup()**	list of security groups associated with the virtual machine
id	the ID of the security group
account	the account owning the security group
description	the description of the security group
domain	the domain name of the security group
domainid	the domain ID of the security group
name	the name of the security group
project	the project name of the group
projectid	the project id of the group
virtualmachinecount	the number of virtualmachines associated with this securitygroup
virtualmachineids	the list of virtualmachine ids associated with this securitygroup
*egressrule()**	the list of egress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
tags(*)	the list of resource tags associated with the rule
*ingressrule()**	the list of ingress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
tags(*)	the list of resource tags associated with the 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
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
*tags()**	the list of resource tags associated with vm
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/updateVpnConnection.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.6/domain_admin/updateVpnConnection.html b/content/api/apidocs-4.6/domain_admin/updateVpnConnection.html new file mode 100644 index 0000000..db42c3f --- /dev/null +++ b/content/api/apidocs-4.6/domain_admin/updateVpnConnection.html @@ -0,0 +1,145 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

updateVpnConnection

Updates site to site vpn connection

+ +

Request parameters

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

Parameter Name	Description	Required
id	id of vpn connection	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 vpn to the end user or not	false

Response Tags

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

Response Name	Description
id	the connection ID
account	the owner
cidrlist	guest cidr list of the customer gateway
created	the date and time the host was created
domain	the domain name of the owner
domainid	the domain id of the owner
dpd	if DPD is enabled for customer gateway
esplifetime	Lifetime of ESP SA of customer gateway
esppolicy	ESP policy of the customer gateway
fordisplay	is connection for display to the regular user
gateway	public ip address id of the customer gateway
ikelifetime	Lifetime of IKE SA of customer gateway
ikepolicy	IKE policy of the customer gateway
ipsecpsk	IPsec Preshared-Key of the customer gateway
passive	State of vpn connection
project	the project name
projectid	the project id
publicip	the public IP address
removed	the date and time the host was removed
s2scustomergatewayid	the customer gateway ID
s2svpngatewayid	the vpn gateway ID
state	State of vpn connection

+ +

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

+ +

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

updateVpnCustomerGateway

Update site to site vpn customer gateway

+ +

Request parameters

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

Parameter Name	Description	Required
id	id of customer gateway	true
cidrlist	guest cidr of the customer gateway	true
esppolicy	ESP policy of the customer gateway	true
gateway	public ip address id of the customer gateway	true
ikepolicy	IKE policy of the customer gateway	true
ipsecpsk	IPsec Preshared-Key of the customer gateway	true
account	the account associated with the gateway. Must be used with the domainId parameter.	false
domainid	the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.	false
dpd	If DPD is enabled for VPN connection	false
esplifetime	Lifetime of phase 2 VPN connection to the customer gateway, in seconds	false
ikelifetime	Lifetime of phase 1 VPN connection to the customer gateway, in seconds	false
name	name of this customer gateway	false

Response Tags

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

Response Name	Description
id	the vpn gateway ID
account	the owner
cidrlist	guest cidr list of the customer gateway
domain	the domain name of the owner
domainid	the domain id of the owner
dpd	if DPD is enabled for customer gateway
esplifetime	Lifetime of ESP SA of customer gateway
esppolicy	IPsec policy of customer gateway
gateway	public ip address id of the customer gateway
ikelifetime	Lifetime of IKE SA of customer gateway
ikepolicy	IKE policy of customer gateway
ipaddress	guest ip of the customer gateway
ipsecpsk	IPsec preshared-key of customer gateway
name	name of the customer gateway
project	the project name
projectid	the project id
removed	the date and time the host was removed

+ +

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

+ +

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

updateVpnGateway

Updates site to site vpn local gateway

+ +

Request parameters

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

Parameter Name	Description	Required
id	id of customer gateway	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 vpn to the end user or not	false

Response Tags

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

Response Name	Description
id	the vpn gateway ID
account	the owner
domain	the domain name of the owner
domainid	the domain id of the owner
fordisplay	is vpn gateway for display to the regular user
project	the project name
projectid	the project id
publicip	the public IP address
removed	the date and time the host was removed
vpcid	the vpc id of this gateway

+ +