Apache CloudStack Root Admin API Reference


Registers an existing ISO into the CloudStack Cloud.

Request parameters

Parameter NameDescriptionRequired
displaytextthe display text of the ISO. This is usually used for display purposes.true
namethe name of the ISOtrue
urlthe URL to where the ISO is currently being hostedtrue
zoneidthe ID of the zone you wish to register the ISO to.true
accountan optional account name. Must be used with domainId.false
bootabletrue if this ISO is bootable. If not passed explicitly its assumed to be truefalse
checksumthe checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to use another algorithm the hexadecimal string is to be prefixed with a string of the form, "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not contain an algorithm called SHA256 or one called sha-256, only SHA-256.false
directdownloadtrue if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deploymentfalse
domainidan optional domainId. If the account parameter is used, domainId must also be used.false
imagestoreuuidImage store UUIDfalse
isdynamicallyscalabletrue if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memoryfalse
isextractabletrue if the ISO or its derivatives are extractable; default is falsefalse
isfeaturedtrue if you want this ISO to be featuredfalse
ispublictrue if you want to register the ISO to be publicly available to all users, false otherwise.false
ostypeidthe ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passedfalse
passwordenabledtrue if password reset feature is supported; default is falsefalse
projectidRegister ISO for the projectfalse

Response Tags

Response NameDescription
idthe template ID
accountthe account name to which the template belongs
accountidthe account id to which the template belongs
bitsthe processor bit size
bootabletrue if the ISO is bootable, false otherwise
checksumchecksum of the template
childtemplatesif root disk template, then ids of the datas disk templates this template owns
createdthe date this template was created
crossZonestrue if the template is managed across all Zones, false otherwise
deployasisVMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is template
detailsadditional key/value details tied with template
directdownloadKVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextthe template display text
domainthe name of the domain to which the template belongs
domainidthe ID of the domain to which the template belongs
downloaddetailsLists the download progress of a template across all secondary storages
formatthe format of the template.
hostidthe ID of the secondary storage host for the template
hostnamethe name of the secondary storage host for the template
hypervisorthe hypervisor on which the template runs
isdynamicallyscalabletrue if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory
isextractabletrue if the template is extractable, false otherwise
isfeaturedtrue if this template is a featured template, false otherwise
ispublictrue if this template is a public template, false otherwise
isreadytrue if the template is ready to be deployed from, false otherwise.
namethe template name
ostypeidthe ID of the OS type for this template.
ostypenamethe name of the OS type for this template.
parenttemplateidif Datadisk template, then id of the root disk template this template belongs to
passwordenabledtrue if the reset password feature is enabled, false otherwise
physicalsizethe physical size of the template
projectthe project name of the template
projectidthe project id of the template
removedthe date this template was removed
requireshvmtrue if template requires HVM enabled, false otherwise
sizethe size of the template
sourcetemplateidthe template ID of the parent template if present
sshkeyenabledtrue if template is sshkey enabled, false otherwise
statusthe status of the template
templatetagthe tag of this template
templatetypethe type of the template
urlthe URL which the template/iso is registered from
zoneidthe ID of the zone for this template
zonenamethe name of the zone for this template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object