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 9428618CD2 for ; Tue, 19 Apr 2016 14:42:23 +0000 (UTC) Received: (qmail 61324 invoked by uid 500); 19 Apr 2016 14:41:46 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 61111 invoked by uid 500); 19 Apr 2016 14:41:46 -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 60107 invoked by uid 99); 19 Apr 2016 14:41:45 -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, 19 Apr 2016 14:41:45 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 1671EDFE65; Tue, 19 Apr 2016 14:41:45 +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, 19 Apr 2016 14:42:30 -0000 Message-Id: <799525561d574b5db7d7bd7e25cefbc3@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [49/53] [partial] cloudstack-www git commit: update event section for 2016 events http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/TOC_User.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/TOC_User.html b/content/api/apidocs-4.8/TOC_User.html new file mode 100644 index 0000000..76aaf8b --- /dev/null +++ b/content/api/apidocs-4.8/TOC_User.html @@ -0,0 +1,1089 @@ + + + + + + + +CloudStack API Reference + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+

Apache CloudStack API Documentation (v4.8.0)

+ +
+
+

Using the CloudStack API

+

For information about how the APIs work, and tips on how to use them, see the + Developer's Guide.

+
+
+
+

User API

+Commands available through the developer API URL and the integration API URL. +
+

+(A) implies that the command is asynchronous.

+

(*) implies element has a child.

+
+
+ + + + +
+ + + + +
+ + +
+
Quota
+ +
+
+
Pool
+ +
+
+
+ +
+
Event
+ +
+ +
+
Resource tags
+ +
+
+
+
+
Limit
+ +
+
+
Guest OS
+ +
+
+
Configuration
+ +
+
+
Async job
+ +
+
+
+
+
Zone
+ +
+
+
Service Offering
+ +
+
+
Resource metadata
+ +
+
+
Region
+ +
+
+
+
+
Nuage VSP
+ +
+
+
Network Offering
+ +
+
+
Hypervisor
+ +
+
+
Disk Offering
+ +
+
+
+
+
Cloud Identifier
+ +
+
+
API Discovery
+ +
+
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/domain_admin/activateProject.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/activateProject.html b/content/api/apidocs-4.8/domain_admin/activateProject.html new file mode 100644 index 0000000..8945e5d --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/activateProject.html @@ -0,0 +1,232 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

activateProject

+

Activates a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idid of the project to be modifiedtrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the project
accountthe account name of the project's owner
cpuavailablethe total number of cpu cores available to be created for this project
cpulimitthe total number of cpu cores the project can own
cputotalthe total number of cpu cores owned by project
displaytextthe displaytext of the project
domainthe domain name where the project belongs to
domainidthe domain id the project belongs to
ipavailablethe total number of public ip addresses available for this project to acquire
iplimitthe total number of public ip addresses this project can acquire
iptotalthe total number of public ip addresses allocated for this project
memoryavailablethe total memory (in MB) available to be created for this project
memorylimitthe total memory (in MB) the project can own
memorytotalthe total memory (in MB) owned by project
namethe name of the project
networkavailablethe total number of networks available to be created for this project
networklimitthe total number of networks the project can own
networktotalthe total number of networks owned by project
primarystorageavailablethe total primary storage space (in GiB) available to be used for this project
primarystoragelimitthe total primary storage space (in GiB) the project can own
primarystoragetotalthe total primary storage space (in GiB) owned by project
secondarystorageavailablethe total secondary storage space (in GiB) available to be used for this project
secondarystoragelimitthe total secondary storage space (in GiB) the project can own
secondarystoragetotalthe total secondary storage space (in GiB) owned by project
snapshotavailablethe total number of snapshots available for this project
snapshotlimitthe total number of snapshots which can be stored by this project
snapshottotalthe total number of snapshots stored by this project
statethe state of the project
templateavailablethe total number of templates available to be created by this project
templatelimitthe total number of templates which can be created by this project
templatetotalthe total number of templates which have been created by this project
vmavailablethe total number of virtual machines available for this project to acquire
vmlimitthe total number of virtual machines that can be deployed by this project
vmrunningthe total number of virtual machines running for this project
vmstoppedthe total number of virtual machines stopped for this project
vmtotalthe total number of virtual machines deployed by this project
volumeavailablethe total volume available for this project
volumelimitthe total volume which can be used by this project
volumetotalthe total volume being used by this project
vpcavailablethe total number of vpcs available to be created for this project
vpclimitthe total number of vpcs the project can own
vpctotalthe total number of vpcs owned by 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/ab73675b/content/api/apidocs-4.8/domain_admin/addAccountToProject.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/addAccountToProject.html b/content/api/apidocs-4.8/domain_admin/addAccountToProject.html new file mode 100644 index 0000000..fd0b9cc --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/addAccountToProject.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

addAccountToProject

+

Adds account to a project

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
projectidID of the project to add the account totrue
accountname of the account to be added to the projectfalse
emailemail to which invitation to the project is going to be sentfalse
+
+
+

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/ab73675b/content/api/apidocs-4.8/domain_admin/addIpToNic.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/addIpToNic.html b/content/api/apidocs-4.8/domain_admin/addIpToNic.html new file mode 100644 index 0000000..888e708 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/addIpToNic.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

addIpToNic

+

Assigns secondary IP to NIC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nicidthe ID of the nic to which you want to assign private IPtrue
ipaddressSecondary IP Addressfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the secondary private IP addr
ipaddressSecondary IP address
networkidthe ID of the network
nicidthe ID of the nic
virtualmachineidthe ID of the vm
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/domain_admin/addNicToVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/addNicToVirtualMachine.html b/content/api/apidocs-4.8/domain_admin/addNicToVirtualMachine.html new file mode 100644 index 0000000..82882f5 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/addNicToVirtualMachine.html @@ -0,0 +1,520 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

addNicToVirtualMachine

+

Adds VM to specified network by creating a NIC

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
networkidNetwork IDtrue
virtualmachineidVirtual Machine IDtrue
ipaddressIP Address for the new networkfalse
+
+
+

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
detailsVm details in key/value pairs.
diskioreadthe read (io) of disk on the vm
diskiowritethe write (io) of disk on the vm
diskkbsreadthe read (bytes) of disk on the vm
diskkbswritethe write (bytes) of disk on the vm
diskofferingidthe ID of the disk offering of the virtual machine
diskofferingnamethe name of the disk offering of the virtual machine
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
displayvman optional field whether to the display the vm to the end user or not.
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
isdynamicallyscalabletrue if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.
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
ostypeidOS type id of the vm
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
servicestateState of the Service from LB rule
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
useridthe user's ID who deployed the virtual machine
usernamethe user's name who deployed the virtual machine
vgputhe vgpu type used by the virtual machine
zoneidthe ID of the availablility zone for the virtual machine
zonenamethe name of the availability zone for the virtual machine
affinitygroup(*)list of affinity groups associated with the virtual machine
idthe ID of the affinity group
accountthe account owning the affinity group
descriptionthe description of the affinity group
domainthe domain name of the affinity group
domainidthe domain ID of the affinity group
namethe name of the affinity group
projectthe project name of the affinity group
projectidthe project ID of the affinity group
typethe type of the affinity group
virtualmachineIdsvirtual machine IDs associated with this affinity group
nic(*)the list of nics associated with vm
idthe ID of the nic
broadcasturithe broadcast uri of the nic
deviceiddevice id for the network when plugged into the virtual machine
gatewaythe gateway of the nic
ip6addressthe IPv6 address of network
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
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
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryipthe Secondary ipv4 addr of nic
traffictypethe traffic type of the nic
typethe type of the nic
virtualmachineidId of the vm to which the nic belongs
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
virtualmachinecountthe number of virtualmachines associated with this securitygroup
virtualmachineidsthe list of virtualmachine ids associated with this securitygroup
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
tags(*)the list of resource tags associated with the 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
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/ab73675b/content/api/apidocs-4.8/domain_admin/addVpnUser.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/addVpnUser.html b/content/api/apidocs-4.8/domain_admin/addVpnUser.html new file mode 100644 index 0000000..8677963 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/addVpnUser.html @@ -0,0 +1,109 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

addVpnUser

+

Adds vpn users

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordpassword for the usernametrue
usernameusername for the vpn usertrue
accountan optional account for the vpn user. Must be used with domainId.false
domainidan optional domainId for the vpn user. If the account parameter is used, domainId must also be used.false
projectidadd vpn user to the specific projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe vpn userID
accountthe account of the remote access vpn
domainthe domain name of the account of the remote access vpn
domainidthe domain id of the account of the remote access vpn
projectthe project name of the vpn
projectidthe project id of the vpn
statethe state of the Vpn User
usernamethe username of the vpn user
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/domain_admin/archiveEvents.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/archiveEvents.html b/content/api/apidocs-4.8/domain_admin/archiveEvents.html new file mode 100644 index 0000000..fdd574c --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/archiveEvents.html @@ -0,0 +1,88 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

archiveEvents

+

Archive one or more events.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enddateend date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
idsthe IDs of the eventsfalse
startdatestart date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss")false
typearchive by event typefalse
+
+
+

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/ab73675b/content/api/apidocs-4.8/domain_admin/assignCertToLoadBalancer.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/assignCertToLoadBalancer.html b/content/api/apidocs-4.8/domain_admin/assignCertToLoadBalancer.html new file mode 100644 index 0000000..d25c6ad --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/assignCertToLoadBalancer.html @@ -0,0 +1,82 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

assignCertToLoadBalancer

+

Assigns a certificate to a load balancer rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
certidthe ID of the certificatetrue
lbruleidthe ID of the load balancer ruletrue
+
+
+

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/ab73675b/content/api/apidocs-4.8/domain_admin/assignToGlobalLoadBalancerRule.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/assignToGlobalLoadBalancerRule.html b/content/api/apidocs-4.8/domain_admin/assignToGlobalLoadBalancerRule.html new file mode 100644 index 0000000..31cbdc9 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/assignToGlobalLoadBalancerRule.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

assignToGlobalLoadBalancerRule

+

Assign load balancer rule or list of load balancer rules to a global load balancer rules.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the global load balancer ruletrue
loadbalancerrulelistthe list load balancer rules that will be assigned to global load balancer ruletrue
gslblbruleweightsmapMap of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'false
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ +