Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 04C1A1862F for ; Tue, 12 May 2015 07:23:34 +0000 (UTC) Received: (qmail 28592 invoked by uid 500); 12 May 2015 07:23:23 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 28516 invoked by uid 500); 12 May 2015 07:23:23 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 27895 invoked by uid 99); 12 May 2015 07:23:22 -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, 12 May 2015 07:23:22 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 88DBDE0B3F; Tue, 12 May 2015 07:23:22 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sebgoa@apache.org To: commits@cloudstack.apache.org Date: Tue, 12 May 2015 07:23:55 -0000 Message-Id: <3de3024768094905934d20b99519eb02@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [35/51] [partial] cloudstack-www git commit: Latest API build http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateNetwork.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateNetwork.html b/content/api/apidocs-4.0.0/domain_admin/updateNetwork.html new file mode 100644 index 0000000..b3d7712 --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateNetwork.html @@ -0,0 +1,250 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateNetwork

+

Updates a network

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the networktrue
changecidrForce update even if cidr type is differentfalse
displaytextthe new display text for the networkfalse
namethe new name for the networkfalse
networkdomainnetwork domainfalse
networkofferingidnetwork offering IDfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the network
accountthe owner of the network
acltypeacl type - access type to the network
broadcastdomaintypeBroadcast domain type of the network
broadcasturibroadcast uri of the network
canusefordeploylist networks available for vm deployment
cidrthe cidr the network
displaytextthe displaytext of the network
dns1the first DNS for the network
dns2the second DNS for the network
domainthe domain name of the network owner
domainidthe domain id of the network owner
gatewaythe network's gateway
isdefaulttrue if network is default, false otherwise
issystemtrue if network is system, false otherwise
namethe name of the network
netmaskthe network's netmask
networkdomainthe network domain
networkofferingavailabilityavailability of the network offering the network is created from
networkofferingdisplaytextdisplay text of the network offering the network is created from
networkofferingidnetwork offering id the network is created from
networkofferingnamename of the network offering the network is created from
physicalnetworkidthe physical network id
projectthe project name of the address
projectidthe project id of the ipaddress
relatedrelated to what other network configuration
restartrequiredtrue network requires restart
specifyiprangestrue if network supports specifying ip ranges, false otherwise
statestate of the network
subdomainaccesstrue if users from subdomains can access the domain level network
traffictypethe traffic type of the network
typethe type of the network
vlanthe vlan of the network
vpcidVPC the network belongs to
zoneidzone id of the network
zonenamethe name of the zone the network belongs to
service(*)the list of services
namethe service name
providerthe service provider name
capability(*)the list of capabilities
canchooseservicecapabilitycan this service capability value can be choosable while creatine network offerings
namethe capability name
valuethe capability value
tags(*)the list of resource tags associated with network
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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateProject.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateProject.html b/content/api/apidocs-4.0.0/domain_admin/updateProject.html new file mode 100644 index 0000000..6d3eb82 --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateProject.html @@ -0,0 +1,133 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateProject

+

Updates a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idid of the project to be modifiedtrue
accountnew Admin account for the projectfalse
displaytextdisplay text of the projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the project
accountthe account name of the project's owner
displaytextthe displaytext of the project
domainthe domain name where the project belongs to
domainidthe domain id the project belongs to
namethe name of the project
statethe state of the project
tags(*)the list of resource tags associated with vm
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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateProjectInvitation.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateProjectInvitation.html b/content/api/apidocs-4.0.0/domain_admin/updateProjectInvitation.html new file mode 100644 index 0000000..4ed930e --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateProjectInvitation.html @@ -0,0 +1,88 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateProjectInvitation

+

Accepts or declines project invitation

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
projectidid of the project to jointrue
acceptif true, accept the invitation, decline if false. True by defaultfalse
accountaccount that is joining the projectfalse
tokenlist invitations for specified account; this parameter has to be specified with domainIdfalse
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateResourceCount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateResourceCount.html b/content/api/apidocs-4.0.0/domain_admin/updateResourceCount.html new file mode 100644 index 0000000..d8022da --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateResourceCount.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateResourceCount

+

Recalculate and update resource count for an account or domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
domainidIf account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.true
accountUpdate resource count for a specified account. Must be used with the domainId parameter.false
projectidUpdate resource limits for projectfalse
resourcetypeType of resource to update. If specifies valid values are 0, 1, 2, 3, and 4. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountthe account for which resource count's are updated
domainthe domain name for which resource count's are updated
domainidthe domain ID for which resource count's are updated
projectthe project name for which resource count's are updated
projectidthe project id for which resource count's are updated
resourcecountresource count
resourcetyperesource type. Values include 0, 1, 2, 3, 4. See the resourceType parameter for more information on these values.
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateResourceLimit.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateResourceLimit.html b/content/api/apidocs-4.0.0/domain_admin/updateResourceLimit.html new file mode 100644 index 0000000..8b5e51d --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateResourceLimit.html @@ -0,0 +1,106 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateResourceLimit

+

Updates resource limits for an account or domain.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
resourcetypeType of resource to update. Values are 0, 1, 2, 3, and 4. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.true
accountUpdate resource for a specified account. Must be used with the domainId parameter.false
domainidUpdate resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.false
max Maximum resource limit.false
projectidUpdate resource limits for projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountthe account of the resource limit
domainthe domain name of the resource limit
domainidthe domain ID of the resource limit
maxthe maximum number of the resource. A -1 means the resource currently has no limit.
projectthe project name of the resource limit
projectidthe project id of the resource limit
resourcetyperesource type. Values include 0, 1, 2, 3, 4. See the resourceType parameter for more information on these values.
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateTemplate.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateTemplate.html b/content/api/apidocs-4.0.0/domain_admin/updateTemplate.html new file mode 100644 index 0000000..466b0e1 --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateTemplate.html @@ -0,0 +1,232 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateTemplate

+

Updates attributes of a template.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the image filetrue
bootabletrue if image is bootable, false otherwisefalse
displaytextthe display text of the imagefalse
formatthe format for the imagefalse
namethe name of the image filefalse
ostypeidthe ID of the OS type that best represents the OS of this image.false
passwordenabledtrue if the image supports the password reset feature; default is falsefalse
sortkeysort key of the template, integerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe template ID
accountthe account name to which the template belongs
accountidthe account id to which the template belongs
bootabletrue if the ISO is bootable, false otherwise
checksumchecksum of the template
createdthe date this template was created
crossZonestrue if the template is managed across all Zones, false otherwise
detailsadditional key/value details tied with template
displaytextthe template display text
domainthe name of the domain to which the template belongs
domainidthe ID of the domain to which the template belongs
formatthe format of the template.
hostidthe ID of the secondary storage host for the template
hostnamethe name of the secondary storage host for the template
hypervisorthe hypervisor on which the template runs
isextractabletrue if the template is extractable, false otherwise
isfeaturedtrue if this template is a featured template, false otherwise
ispublictrue if this template is a public template, false otherwise
isreadytrue if the template is ready to be deployed from, false otherwise.
namethe template name
ostypeidthe ID of the OS type for this template.
ostypenamethe name of the OS type for this template.
passwordenabledtrue if the reset password feature is enabled, false otherwise
projectthe project name of the template
projectidthe project id of the template
removedthe date this template was removed
sizethe size of the template
sourcetemplateidthe template ID of the parent template if present
statusthe status of the template
templatetagthe tag of this template
templatetypethe type of the template
zoneidthe ID of the zone for this template
zonenamethe name of the zone for this template
tags(*)the list of resource tags associated with tempate
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
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateTemplatePermissions.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateTemplatePermissions.html b/content/api/apidocs-4.0.0/domain_admin/updateTemplatePermissions.html new file mode 100644 index 0000000..364df34 --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateTemplatePermissions.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateTemplatePermissions

+

Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A priviledged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe template IDtrue
accountsa comma delimited list of accounts. If specified, "op" parameter has to be passed in.false
isextractabletrue if the template/iso is extractable, false other wise. Can be set only by root adminfalse
isfeaturedtrue for featured template/iso, false otherwisefalse
ispublictrue for public template/iso, false for private templates/isosfalse
oppermission operator (add, remove, reset)false
projectidsa comma delimited list of projects. If specified, "op" parameter has to be passed in.false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateVPC.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateVPC.html b/content/api/apidocs-4.0.0/domain_admin/updateVPC.html new file mode 100644 index 0000000..50b36f2 --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateVPC.html @@ -0,0 +1,337 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateVPC

+

Updates a VPC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
displaytextthe display text of the VPCfalse
idthe id of the VPCfalse
namethe name of the VPCfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the VPC
accountthe owner of the VPC
cidrthe cidr the VPC
createdthe date this VPC was created
displaytextan alternate display text of the VPC.
domainthe domain name of the owner
domainidthe domain id of the VPC owner
namethe name of the VPC
networkdomainthe network domain of the VPC
projectthe project name of the VPC
projectidthe project id of the VPC
restartrequiredtrue VPC requires restart
statestate of the VPC. Can be Inactive/Enabled
vpcofferingidvpc offering id the VPC is created from
zoneidzone id of the vpc
zonenamethe name of the zone the VPC belongs to
network(*)the list of networks belongign to the VPC
idthe id of the network
accountthe owner of the network
acltypeacl type - access type to the network
broadcastdomaintypeBroadcast domain type of the network
broadcasturibroadcast uri of the network
canusefordeploylist networks available for vm deployment
cidrthe cidr the network
displaytextthe displaytext of the network
dns1the first DNS for the network
dns2the second DNS for the network
domainthe domain name of the network owner
domainidthe domain id of the network owner
gatewaythe network's gateway
isdefaulttrue if network is default, false otherwise
issystemtrue if network is system, false otherwise
namethe name of the network
netmaskthe network's netmask
networkdomainthe network domain
networkofferingavailabilityavailability of the network offering the network is created from
networkofferingdisplaytextdisplay text of the network offering the network is created from
networkofferingidnetwork offering id the network is created from
networkofferingnamename of the network offering the network is created from
physicalnetworkidthe physical network id
projectthe project name of the address
projectidthe project id of the ipaddress
relatedrelated to what other network configuration
restartrequiredtrue network requires restart
specifyiprangestrue if network supports specifying ip ranges, false otherwise
statestate of the network
subdomainaccesstrue if users from subdomains can access the domain level network
traffictypethe traffic type of the network
typethe type of the network
vlanthe vlan of the network
vpcidVPC the network belongs to
zoneidzone id of the network
zonenamethe name of the zone the network belongs to
service(*)the list of services
namethe service name
providerthe service provider name
capability(*)the list of capabilities
tags(*)the list of resource tags associated with network
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
service(*)the list of supported services
namethe service name
providerthe service provider name
capability(*)the list of capabilities
canchooseservicecapabilitycan this service capability value can be choosable while creatine network offerings
namethe capability name
valuethe capability value
tags(*)the list of resource tags associated with the project
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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateVirtualMachine.html b/content/api/apidocs-4.0.0/domain_admin/updateVirtualMachine.html new file mode 100644 index 0000000..7435931 --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateVirtualMachine.html @@ -0,0 +1,418 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating 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 NameDescriptionRequired
idThe ID of the virtual machinetrue
displaynameuser generated namefalse
groupgroup of the virtual machinefalse
haenabletrue if high-availability is enabled for the virtual machine, false otherwisefalse
ostypeidthe ID of the OS type that best represents this VM.false
userdataan 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. Currently only HTTP GET is supported. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the virtual machine
accountthe account associated with the virtual machine
cpunumberthe number of cpu this virtual machine is running with
cpuspeedthe speed of each cpu
cpuusedthe amount of the vm's CPU currently used
createdthe date when this virtual machine was created
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
domainthe name of the domain in which the virtual machine exists
domainidthe ID of the domain in which the virtual machine exists
forvirtualnetworkthe virtual network for the service offering
groupthe group name of the virtual machine
groupidthe group ID of the virtual machine
guestosidOs type ID of the virtual machine
haenabletrue if high-availability is enabled, false otherwise
hostidthe ID of the host for the virtual machine
hostnamethe name of the host for the virtual machine
hypervisorthe hypervisor on which the template runs
instancenameinstance name of the user vm; this parameter is returned to the ROOT admin only
isodisplaytextan alternate display text of the ISO attached to the virtual machine
isoidthe ID of the ISO attached to the virtual machine
isonamethe name of the ISO attached to the virtual machine
keypairssh key-pair
memorythe memory allocated for the virtual machine
namethe name of the virtual machine
networkkbsreadthe incoming network traffic on the vm
networkkbswritethe outgoing network traffic on the host
passwordthe password (if exists) of the virtual machine
passwordenabledtrue if the password rest feature is enabled, false otherwise
projectthe project name of the vm
projectidthe project id of the vm
publicippublic IP address id associated with vm via Static nat rule
publicipidpublic IP address id associated with vm via Static nat rule
rootdeviceiddevice ID of the root volume
rootdevicetypedevice type of the root volume
serviceofferingidthe ID of the service offering of the virtual machine
serviceofferingnamethe name of the service offering of the virtual machine
statethe state of the virtual machine
templatedisplaytext an alternate display text of the template for the virtual machine
templateidthe ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatenamethe name of the template for the virtual machine
zoneidthe ID of the availablility zone for the virtual machine
zonenamethe name of the availability zone for the virtual machine
nic(*)the list of nics associated with vm
idthe ID of the nic
broadcasturithe broadcast uri of the nic
gatewaythe gateway of the nic
ipaddressthe ip address of the nic
isdefaulttrue if nic is default, false otherwise
isolationurithe isolation uri of the nic
macaddresstrue if nic is default, false otherwise
netmaskthe netmask of the nic
networkidthe ID of the corresponding network
networknamethe name of the corresponding network
traffictypethe traffic type of the nic
typethe type of the nic
securitygroup(*)list of security groups associated with the virtual machine
idthe ID of the security group
accountthe account owning the security group
descriptionthe description of the security group
domainthe domain name of the security group
domainidthe domain ID of the security group
namethe name of the security group
projectthe project name of the group
projectidthe project id of the group
egressrule(*)the list of egress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
ingressrule(*)the list of ingress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group 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
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
tags(*)the list of resource tags associated with vm
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
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/domain_admin/updateVpnCustomerGateway.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/domain_admin/updateVpnCustomerGateway.html b/content/api/apidocs-4.0.0/domain_admin/updateVpnCustomerGateway.html new file mode 100644 index 0000000..aa81101 --- /dev/null +++ b/content/api/apidocs-4.0.0/domain_admin/updateVpnCustomerGateway.html @@ -0,0 +1,157 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

+

updateVpnCustomerGateway

+

Update site to site vpn customer gateway

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idid of customer gatewaytrue
cidrlistguest cidr of the customer gatewaytrue
esppolicyESP policy of the customer gatewaytrue
gatewaypublic ip address id of the customer gatewaytrue
ikepolicyIKE policy of the customer gatewaytrue
ipsecpskIPsec Preshared-Key of the customer gatewaytrue
accountthe account associated with the gateway. Must be used with the domainId parameter.false
domainidthe domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.false
dpdIf DPD is enabled for VPN connectionfalse
esplifetimeLifetime of phase 2 VPN connection to the customer gateway, in secondsfalse
ikelifetimeLifetime of phase 1 VPN connection to the customer gateway, in secondsfalse
namename of this customer gatewayfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe vpn gateway ID
accountthe owner
cidrlistguest cidr list of the customer gateway
domainthe domain name of the owner
domainidthe domain id of the owner
dpdif DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyIPsec policy of customer gateway
gatewaypublic ip address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of customer gateway
ipaddressguest ip of the customer gateway
ipsecpskIPsec preshared-key of customer gateway
namename of the customer gateway
projectthe project name
projectidthe project id
removedthe date and time the host was removed
+
+
+
+
+
+ +
+
+ +