Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 88612 invoked by uid 99); 17 Feb 2016 02:22:32 -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:22:32 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id E58ECE0B37; Wed, 17 Feb 2016 02:22:31 +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:23:00 -0000 Message-Id: <2f87c090a5c74065abeb36d1cd6aaf77@git.apache.org> In-Reply-To: <1d6b7f4149b145f39313a6a6c9d7bb76@git.apache.org> References: <1d6b7f4149b145f39313a6a6c9d7bb76@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [30/51] [abbrv] [partial] cloudstack-www git commit: 4.8.0, close #24 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/domain_admin/quotaIsEnabled.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/quotaIsEnabled.html b/content/api/apidocs-4.8/domain_admin/quotaIsEnabled.html new file mode 100644 index 0000000..90cc9da --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/quotaIsEnabled.html @@ -0,0 +1,73 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

quotaIsEnabled

Return true if the plugin is enabled

+ +

Request parameters

+ + + + +

Parameter Name

Description

Required

Response Tags

+ + + + + + + +

Response Name	Description
isenabled	is quota service enabled

+ +

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

+ +

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

quotaStatement

Create a quota statement

+ +

Request parameters

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

Parameter Name	Description	Required
account	Optional, Account Id for which statement needs to be generated	true
domainid	Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.	true
enddate	End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.	true
startdate	Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.	true
accountid	List usage records for the specified account	false
type	List quota usage records for the specified usage type	false

Response Tags

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

Response Name	Description
account	account name
accountid	account id
domain	domain id
name	usage type name
quota	quota consumed
type	usage type
unit	usage unit

+ +

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

+ +

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

quotaTariffList

Lists all quota tariff plans

+ +

Request parameters

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

Parameter Name	Description	Required
keyword	List by keyword	false
page		false
pagesize		false
startdate	The effective start date on/after which the quota tariff is effective and older tariffs are no longer used for the usage type. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.	false
usagetype	Usage type of the resource	false

Response Tags

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

Response Name	Description
currency	currency
description	description
effectiveDate	the date on/after which this quota value will be effective
tariffValue	tariffValue
usageDiscriminator	usageDiscriminator
usageName	usageName
usageType	usageType
usageUnit	usageUnit

+ +

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

+ +

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

rebootRouter

Starts a router.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the ID of the router	true

Response Tags

Response Name	Description
id	the id of the router
account	the account associated with the router
created	the date and time the router was created
dns1	the first DNS for the router
dns2	the second DNS for the router
domain	the domain associated with the router
domainid	the domain ID associated with the router
gateway	the gateway for the router
guestipaddress	the guest IP address for the router
guestmacaddress	the guest MAC address for the router
guestnetmask	the guest netmask for the router
guestnetworkid	the ID of the corresponding guest network
guestnetworkname	the name of the corresponding guest network
hostid	the host ID for the router
hostname	the hostname for the router
hypervisor	the hypervisor on which the template runs
ip6dns1	the first IPv6 DNS for the router
ip6dns2	the second IPv6 DNS for the router
isredundantrouter	if this router is an redundant virtual router
linklocalip	the link local IP address for the router
linklocalmacaddress	the link local MAC address for the router
linklocalnetmask	the link local netmask for the router
linklocalnetworkid	the ID of the corresponding link local network
name	the name of the router
networkdomain	the network domain for the router
podid	the Pod ID for the router
project	the project name of the address
projectid	the project id of the ipaddress
publicip	the public IP address for the router
publicmacaddress	the public MAC address for the router
publicnetmask	the public netmask for the router
publicnetworkid	the ID of the corresponding public network
redundantstate	the state of redundant virtual router
requiresupgrade	true if the router template requires upgrader
role	role of the domain router
scriptsversion	the version of scripts
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
state	the state of the router
templateid	the template ID for the router
version	the version of template
vpcid	VPC the router belongs to
vpcname	the name of VPC the router belongs to
zoneid	the Zone ID for the router
zonename	the Zone name for the router
*nic()**	the list of nics associated with the router
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

+ +

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

+ +

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

rebootVirtualMachine

Reboots a virtual machine.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	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/79d7c49c/content/api/apidocs-4.8/domain_admin/recoverVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/recoverVirtualMachine.html b/content/api/apidocs-4.8/domain_admin/recoverVirtualMachine.html new file mode 100644 index 0000000..428f298 --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/recoverVirtualMachine.html @@ -0,0 +1,514 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

recoverVirtualMachine

Recovers a virtual machine.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	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/79d7c49c/content/api/apidocs-4.8/domain_admin/registerIso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/domain_admin/registerIso.html b/content/api/apidocs-4.8/domain_admin/registerIso.html new file mode 100644 index 0000000..a1091cc --- /dev/null +++ b/content/api/apidocs-4.8/domain_admin/registerIso.html @@ -0,0 +1,259 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

registerIso

Registers an existing ISO into the CloudStack Cloud.

+ +

Request parameters

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

Parameter Name	Description	Required
displaytext	the display text of the ISO. This is usually used for display purposes.	true
name	the name of the ISO	true
url	the URL to where the ISO is currently being hosted	true
zoneid	the ID of the zone you wish to register the ISO to.	true
account	an optional account name. Must be used with domainId.	false
bootable	true if this ISO is bootable. If not passed explicitly its assumed to be true	false
checksum	the MD5 checksum value of this ISO	false
domainid	an optional domainId. If the account parameter is used, domainId must also be used.	false
imagestoreuuid	Image store UUID	false
isdynamicallyscalable	true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory	false
isextractable	true if the ISO or its derivatives are extractable; default is false	false
isfeatured	true if you want this ISO to be featured	false
ispublic	true if you want to register the ISO to be publicly available to all users, false otherwise.	false
ostypeid	the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed	false
projectid	Register ISO for the project	false

Response Tags

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

Response Name	Description
id	the template ID
account	the account name to which the template belongs
accountid	the account id to which the template belongs
bootable	true if the ISO is bootable, false otherwise
checksum	checksum of the template
created	the date this template was created
crossZones	true if the template is managed across all Zones, false otherwise
details	additional key/value details tied with template
displaytext	the template display text
domain	the name of the domain to which the template belongs
domainid	the ID of the domain to which the template belongs
format	the format of the template.
hostid	the ID of the secondary storage host for the template
hostname	the name of the secondary storage host for the template
hypervisor	the hypervisor on which the template runs
isdynamicallyscalable	true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory
isextractable	true if the template is extractable, false otherwise
isfeatured	true if this template is a featured template, false otherwise
ispublic	true if this template is a public template, false otherwise
isready	true if the template is ready to be deployed from, false otherwise.
name	the template name
ostypeid	the ID of the OS type for this template.
ostypename	the name of the OS type for this template.
passwordenabled	true if the reset password feature is enabled, false otherwise
project	the project name of the template
projectid	the project id of the template
removed	the date this template was removed
size	the size of the template
sourcetemplateid	the template ID of the parent template if present
sshkeyenabled	true if template is sshkey enabled, false otherwise
status	the status of the template
templatetag	the tag of this template
templatetype	the type of the template
zoneid	the ID of the zone for this template
zonename	the name of the zone for this template
*tags()**	the list of resource tags associated with tempate
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

+ +