X-Mailer: ASF-Git Admin Mailer Subject: [04/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/root_admin/destroyVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/destroyVirtualMachine.html b/content/api/apidocs-4.8/root_admin/destroyVirtualMachine.html new file mode 100644 index 0000000..284dff7 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/destroyVirtualMachine.html @@ -0,0 +1,523 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

destroyVirtualMachine

Destroys a virtual machine. Once destroyed, only the administrator can recover it.

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
id	The ID of the virtual machine	true
expunge	If true is passed, the vm is expunged immediately. False by default.	false

Response Tags

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

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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/destroyVolumeOnFiler.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/destroyVolumeOnFiler.html b/content/api/apidocs-4.8/root_admin/destroyVolumeOnFiler.html new file mode 100644 index 0000000..87a9865 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/destroyVolumeOnFiler.html @@ -0,0 +1,85 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

destroyVolumeOnFiler

Destroy a Volume

+ +

Request parameters

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

Parameter Name	Description	Required
aggregatename	aggregate name.	true
ipaddress	ip address.	true
volumename	volume name.	true

Response Tags

+ + + + +

Response Name

Description

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/detachIso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/detachIso.html b/content/api/apidocs-4.8/root_admin/detachIso.html new file mode 100644 index 0000000..fa652bf --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/detachIso.html @@ -0,0 +1,520 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

detachIso

Detaches any ISO file (if any) currently attached to a virtual machine.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
virtualmachineid	The ID of the virtual machine	true

Response Tags

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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/detachVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/detachVolume.html b/content/api/apidocs-4.8/root_admin/detachVolume.html new file mode 100644 index 0000000..8d5fe11 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/detachVolume.html @@ -0,0 +1,274 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

detachVolume

Detaches a disk volume from a virtual machine.

+ +

Request parameters

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

Parameter Name	Description	Required
deviceid	the device ID on the virtual machine where volume is detached from	false
id	the ID of the disk volume	false
virtualmachineid	the ID of the virtual machine where the volume is detached from	false

Response Tags

Response Name	Description
id	ID of the disk volume
account	the account associated with the disk volume
attached	the date the volume was attached to a VM instance
chaininfo	the chain info of the volume
created	the date the disk volume was created
destroyed	the boolean state of whether the volume is destroyed or not
deviceid	the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskBytesReadRate	bytes read rate of the disk volume
diskBytesWriteRate	bytes write rate of the disk volume
diskIopsReadRate	io requests read rate of the disk volume
diskIopsWriteRate	io requests write rate of the disk volume
diskofferingdisplaytext	the display text of the disk offering
diskofferingid	ID of the disk offering
diskofferingname	name of the disk offering
displayvolume	an optional field whether to the display the volume to the end user or not.
domain	the domain associated with the disk volume
domainid	the ID of the domain associated with the disk volume
hypervisor	Hypervisor the volume belongs to
isextractable	true if the volume is extractable, false otherwise
isodisplaytext	an alternate display text of the ISO attached to the virtual machine
isoid	the ID of the ISO attached to the virtual machine
isoname	the name of the ISO attached to the virtual machine
maxiops	max iops of the disk volume
miniops	min iops of the disk volume
name	name of the disk volume
path	the path of the volume
project	the project name of the vpn
projectid	the project id of the vpn
provisioningtype	provisioning type used to create volumes.
quiescevm	need quiesce vm or not when taking snapshot
serviceofferingdisplaytext	the display text of the service offering for root disk
serviceofferingid	ID of the service offering for root disk
serviceofferingname	name of the service offering for root disk
size	size of the disk volume
snapshotid	ID of the snapshot from which this volume was created
state	the state of the disk volume
status	the status of the volume
storage	name of the primary storage hosting the disk volume
storageid	id of the primary storage hosting the disk volume; returned to admin user only
storagetype	shared or local storage
templatedisplaytext	an alternate display text of the template for the virtual machine
templateid	the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatename	the name of the template for the virtual machine
type	type of the disk volume (ROOT or DATADISK)
virtualmachineid	id of the virtual machine
vmdisplayname	display name of the virtual machine
vmname	name of the virtual machine
vmstate	state of the virtual machine
zoneid	ID of the availability zone
zonename	name of the availability zone
*tags()**	the list of resource tags associated with volume
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/ab73675b/content/api/apidocs-4.8/root_admin/disableAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/disableAccount.html b/content/api/apidocs-4.8/root_admin/disableAccount.html new file mode 100644 index 0000000..2c61df9 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/disableAccount.html @@ -0,0 +1,298 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

disableAccount

Disables an account

+ +

Request parameters

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

Parameter Name	Description	Required
lock	If true, only lock the account; else disable the account	true
account	Disables specified account.	false
domainid	Disables specified account in this domain.	false
id	Account id	false

Response Tags

Response Name	Description
id	the id of the account
accountdetails	details for the account
accounttype	account type (admin, domain-admin, user)
cpuavailable	the total number of cpu cores available to be created for this account
cpulimit	the total number of cpu cores the account can own
cputotal	the total number of cpu cores owned by account
defaultzoneid	the default zone of the account
domain	name of the Domain the account belongs too
domainid	id of the Domain the account belongs too
groups	the list of acl groups that account belongs to
ipavailable	the total number of public ip addresses available for this account to acquire
iplimit	the total number of public ip addresses this account can acquire
iptotal	the total number of public ip addresses allocated for this account
iscleanuprequired	true if the account requires cleanup
isdefault	true if account is default, false otherwise
memoryavailable	the total memory (in MB) available to be created for this account
memorylimit	the total memory (in MB) the account can own
memorytotal	the total memory (in MB) owned by account
name	the name of the account
networkavailable	the total number of networks available to be created for this account
networkdomain	the network domain
networklimit	the total number of networks the account can own
networktotal	the total number of networks owned by account
primarystorageavailable	the total primary storage space (in GiB) available to be used for this account
primarystoragelimit	the total primary storage space (in GiB) the account can own
primarystoragetotal	the total primary storage space (in GiB) owned by account
projectavailable	the total number of projects available for administration by this account
projectlimit	the total number of projects the account can own
projecttotal	the total number of projects being administrated by this account
receivedbytes	the total number of network traffic bytes received
secondarystorageavailable	the total secondary storage space (in GiB) available to be used for this account
secondarystoragelimit	the total secondary storage space (in GiB) the account can own
secondarystoragetotal	the total secondary storage space (in GiB) owned by account
sentbytes	the total number of network traffic bytes sent
snapshotavailable	the total number of snapshots available for this account
snapshotlimit	the total number of snapshots which can be stored by this account
snapshottotal	the total number of snapshots stored by this account
state	the state of the account
templateavailable	the total number of templates available to be created by this account
templatelimit	the total number of templates which can be created by this account
templatetotal	the total number of templates which have been created by this account
vmavailable	the total number of virtual machines available for this account to acquire
vmlimit	the total number of virtual machines that can be deployed by this account
vmrunning	the total number of virtual machines running for this account
vmstopped	the total number of virtual machines stopped for this account
vmtotal	the total number of virtual machines deployed by this account
volumeavailable	the total volume available for this account
volumelimit	the total volume which can be used by this account
volumetotal	the total volume being used by this account
vpcavailable	the total number of vpcs available to be created for this account
vpclimit	the total number of vpcs the account can own
vpctotal	the total number of vpcs owned by account
*user()**	the list of users associated with account
id	the user ID
account	the account name of the user
accountid	the account ID of the user
accounttype	the account type of the user
apikey	the api key of the user
created	the date and time the user account was created
domain	the domain name of the user
domainid	the domain ID of the user
email	the user email address
firstname	the user firstname
iscallerchilddomain	the boolean value representing if the updating target is in caller's child domain
isdefault	true if user is default, false otherwise
lastname	the user lastname
secretkey	the secret key of the user
state	the user state
timezone	the timezone user was created in
username	the user name

+ +

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

+ +

+ + Apache CloudStack v4.8.0 Root Admin API Reference + +

disableAutoScaleVmGroup

Disables an AutoScale Vm Group

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the ID of the autoscale group	true

Response Tags

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

Response Name	Description
id	the autoscale vm group ID
account	the account owning the instance group
domain	the domain name of the vm profile
domainid	the domain ID of the vm profile
fordisplay	is group for display to the regular user
interval	the frequency at which the conditions have to be evaluated
lbruleid	the load balancer rule ID
maxmembers	the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.
minmembers	the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.
project	the project name of the vm profile
projectid	the project id vm profile
scaledownpolicies	list of scaledown autoscale policies
scaleuppolicies	list of scaleup autoscale policies
state	the current state of the AutoScale Vm Group
vmprofileid	the autoscale profile that contains information about the vms in the vm group.

+ +