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 04D5D18316 for ; Wed, 17 Feb 2016 02:34:25 +0000 (UTC) Received: (qmail 23958 invoked by uid 500); 17 Feb 2016 02:34:18 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 23510 invoked by uid 500); 17 Feb 2016 02:34:17 -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 21793 invoked by uid 99); 17 Feb 2016 02:34:15 -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; Wed, 17 Feb 2016 02:34:15 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id D0E53E103E; Wed, 17 Feb 2016 02:34:15 +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: Wed, 17 Feb 2016 02:34:39 -0000 Message-Id: <1c64f1aeb872412aa8f239ee55813700@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [25/51] [partial] cloudstack-www git commit: 4.8.0 with APIs, change copyright date to 2016 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/suspendProject.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/suspendProject.html b/source/api/apidocs-4.8/domain_admin/suspendProject.html new file mode 100644 index 0000000..8e124ff --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/suspendProject.html @@ -0,0 +1,232 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

suspendProject

+

Suspends a project

+
+
+ +
+
+
+

Request parameters

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

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

+

updateAccount

+

Updates account information for the authenticated user

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
newnamenew name for the accounttrue
accountthe current account namefalse
accountdetailsdetails for account used to store specific parametersfalse
domainidthe ID of the domain where the account existsfalse
idAccount idfalse
networkdomainNetwork domain for the account's networks; empty string will update domainName with NULL valuefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the account
accountdetailsdetails for the account
accounttypeaccount type (admin, domain-admin, user)
cpuavailablethe total number of cpu cores available to be created for this account
cpulimitthe total number of cpu cores the account can own
cputotalthe total number of cpu cores owned by account
defaultzoneidthe default zone of the account
domainname of the Domain the account belongs too
domainidid of the Domain the account belongs too
groupsthe list of acl groups that account belongs to
ipavailablethe total number of public ip addresses available for this account to acquire
iplimitthe total number of public ip addresses this account can acquire
iptotalthe total number of public ip addresses allocated for this account
iscleanuprequiredtrue if the account requires cleanup
isdefaulttrue if account is default, false otherwise
memoryavailablethe total memory (in MB) available to be created for this account
memorylimitthe total memory (in MB) the account can own
memorytotalthe total memory (in MB) owned by account
namethe name of the account
networkavailablethe total number of networks available to be created for this account
networkdomainthe network domain
networklimitthe total number of networks the account can own
networktotalthe total number of networks owned by account
primarystorageavailablethe total primary storage space (in GiB) available to be used for this account
primarystoragelimitthe total primary storage space (in GiB) the account can own
primarystoragetotalthe total primary storage space (in GiB) owned by account
projectavailablethe total number of projects available for administration by this account
projectlimitthe total number of projects the account can own
projecttotalthe total number of projects being administrated by this account
receivedbytesthe total number of network traffic bytes received
secondarystorageavailablethe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitthe total secondary storage space (in GiB) the account can own
secondarystoragetotalthe total secondary storage space (in GiB) owned by account
sentbytesthe total number of network traffic bytes sent
snapshotavailablethe total number of snapshots available for this account
snapshotlimitthe total number of snapshots which can be stored by this account
snapshottotalthe total number of snapshots stored by this account
statethe state of the account
templateavailablethe total number of templates available to be created by this account
templatelimitthe total number of templates which can be created by this account
templatetotalthe total number of templates which have been created by this account
vmavailablethe total number of virtual machines available for this account to acquire
vmlimitthe total number of virtual machines that can be deployed by this account
vmrunningthe total number of virtual machines running for this account
vmstoppedthe total number of virtual machines stopped for this account
vmtotalthe total number of virtual machines deployed by this account
volumeavailablethe total volume available for this account
volumelimitthe total volume which can be used by this account
volumetotalthe total volume being used by this account
vpcavailablethe total number of vpcs available to be created for this account
vpclimitthe total number of vpcs the account can own
vpctotalthe total number of vpcs owned by account
user(*)the list of users associated with account
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
iscallerchilddomainthe boolean value representing if the updating target is in caller's child domain
isdefaulttrue if user is default, false otherwise
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/updateAutoScalePolicy.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/updateAutoScalePolicy.html b/source/api/apidocs-4.8/domain_admin/updateAutoScalePolicy.html new file mode 100644 index 0000000..71d7411 --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/updateAutoScalePolicy.html @@ -0,0 +1,112 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

updateAutoScalePolicy

+

Updates an existing autoscale policy.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the autoscale policytrue
conditionidsthe list of IDs of the conditions that are being evaluated on every intervalfalse
durationthe duration for which the conditions have to be true before action is takenfalse
quiettimethe cool down period for which the policy should not be evaluated after the action has been takenfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe autoscale policy ID
accountthe account owning the autoscale policy
actionthe action to be executed if all the conditions evaluate to true for the specified duration.
conditionsthe list of IDs of the conditions that are being evaluated on every interval
domainthe domain name of the autoscale policy
domainidthe domain ID of the autoscale policy
durationthe duration for which the conditions have to be true before action is taken
projectthe project name of the autoscale policy
projectidthe project id autoscale policy
quiettimethe cool down period for which the policy should not be evaluated after the action has been taken
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/updateAutoScaleVmGroup.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/updateAutoScaleVmGroup.html b/source/api/apidocs-4.8/domain_admin/updateAutoScaleVmGroup.html new file mode 100644 index 0000000..008e0d5 --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/updateAutoScaleVmGroup.html @@ -0,0 +1,139 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

updateAutoScaleVmGroup

+

Updates an existing autoscale vm group.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the autoscale grouptrue
customidan optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayan optional field, whether to the display the group to the end user or notfalse
intervalthe frequency at which the conditions have to be evaluatedfalse
maxmembersthe maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.false
minmembersthe minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.false
scaledownpolicyidslist of scaledown autoscale policiesfalse
scaleuppolicyidslist of scaleup autoscale policiesfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe autoscale vm group ID
accountthe account owning the instance group
domainthe domain name of the vm profile
domainidthe domain ID of the vm profile
fordisplayis group for display to the regular user
intervalthe frequency at which the conditions have to be evaluated
lbruleidthe load balancer rule ID
maxmembersthe maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.
minmembersthe minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.
projectthe project name of the vm profile
projectidthe project id vm profile
scaledownpolicieslist of scaledown autoscale policies
scaleuppolicieslist of scaleup autoscale policies
statethe current state of the AutoScale Vm Group
vmprofileidthe autoscale profile that contains information about the vms in the vm group.
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/updateAutoScaleVmProfile.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/updateAutoScaleVmProfile.html b/source/api/apidocs-4.8/domain_admin/updateAutoScaleVmProfile.html new file mode 100644 index 0000000..003dfbe --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/updateAutoScaleVmProfile.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

updateAutoScaleVmProfile

+

Updates an existing autoscale vm profile.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the autoscale vm profiletrue
autoscaleuseridthe ID of the user used to launch and destroy the VMsfalse
counterparamcounterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161false
customidan optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
destroyvmgraceperiodthe time allowed for existing connections to get closed before a vm is destroyedfalse
fordisplayan optional field, whether to the display the profile to the end user or notfalse
templateidthe template of the auto deployed virtual machinefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe autoscale vm profile ID
accountthe account owning the instance group
autoscaleuseridthe ID of the user used to launch and destroy the VMs
destroyvmgraceperiodthe time allowed for existing connections to get closed before a vm is destroyed
domainthe domain name of the vm profile
domainidthe domain ID of the vm profile
fordisplayis profile for display to the regular user
otherdeployparamsparameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine
projectthe project name of the vm profile
projectidthe project id vm profile
serviceofferingidthe service offering to be used while deploying a virtual machine
templateidthe template to be used while deploying a virtual machine
zoneidthe availability zone to be used while deploying a virtual machine
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/updateDefaultNicForVirtualMachine.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/updateDefaultNicForVirtualMachine.html b/source/api/apidocs-4.8/domain_admin/updateDefaultNicForVirtualMachine.html new file mode 100644 index 0000000..2d961db --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/updateDefaultNicForVirtualMachine.html @@ -0,0 +1,517 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

updateDefaultNicForVirtualMachine

+

Changes the default NIC on a VM

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
nicidNIC IDtrue
virtualmachineidVirtual Machine IDtrue
+
+
+

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

+

updateDiskOffering

+

Updates a disk offering.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idID of the disk offeringtrue
displayofferingan optional field, whether to display the offering to the end user or not.false
displaytextupdates alternate display text of the disk offering with this valuefalse
nameupdates name of the disk offering with this valuefalse
sortkeysort key of the disk offering, integerfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idunique ID of the disk offering
cacheModethe cache mode to use for this disk offering. none, writeback or writethrough
createdthe date this disk offering was created
diskBytesReadRatebytes read rate of the disk offering
diskBytesWriteRatebytes write rate of the disk offering
diskIopsReadRateio requests read rate of the disk offering
diskIopsWriteRateio requests write rate of the disk offering
disksizethe size of the disk offering in GB
displayofferingwhether to display the offering to the end user or not.
displaytextan alternate display text of the disk offering.
domainthe domain name this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidthe domain ID this disk offering belongs to. Ignore this information as it is not currently applicable.
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedtrue if disk offering uses custom size, false otherwise
iscustomizediopstrue if disk offering uses custom iops, false otherwise
maxiopsthe max iops of the disk offering
miniopsthe min iops of the disk offering
namethe name of the disk offering
provisioningtypeprovisioning type used to create volumes. Valid values are thin, sparse, fat.
storagetypethe storage type for this disk offering
tagsthe tags for the disk offering
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/updateEgressFirewallRule.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/updateEgressFirewallRule.html b/source/api/apidocs-4.8/domain_admin/updateEgressFirewallRule.html new file mode 100644 index 0000000..859b159 --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/updateEgressFirewallRule.html @@ -0,0 +1,148 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

updateEgressFirewallRule

+

Updates egress firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the egress firewall ruletrue
customidan optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayan optional field, whether to the display the rule to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the firewall rule
cidrlistthe cidr list to forward traffic from
endportthe ending port of firewall rule's port range
fordisplayis rule for display to the regular user
icmpcodeerror code for this icmp message
icmptypetype of the icmp message being sent
ipaddressthe public ip address for the firewall rule
ipaddressidthe public ip address id for the firewall rule
networkidthe network id of the firewall rule
protocolthe protocol of the firewall rule
startportthe starting port of firewall rule's port range
statethe state of 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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/updateFirewallRule.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/updateFirewallRule.html b/source/api/apidocs-4.8/domain_admin/updateFirewallRule.html new file mode 100644 index 0000000..b27666a --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/updateFirewallRule.html @@ -0,0 +1,148 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.8.0 Domain Admin API Reference + +

+

updateFirewallRule

+

Updates firewall rule

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the firewall ruletrue
customidan optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayan optional field, whether to the display the rule to the end user or notfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the firewall rule
cidrlistthe cidr list to forward traffic from
endportthe ending port of firewall rule's port range
fordisplayis rule for display to the regular user
icmpcodeerror code for this icmp message
icmptypetype of the icmp message being sent
ipaddressthe public ip address for the firewall rule
ipaddressidthe public ip address id for the firewall rule
networkidthe network id of the firewall rule
protocolthe protocol of the firewall rule
startportthe starting port of firewall rule's port range
statethe state of 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
+
+
+
+
+
+ +
+
+ +