Apache CloudStack v4.9.0 Root Admin API Reference

registerIso

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 MD5 checksum value of this ISOfalse
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
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
bootabletrue if the ISO is bootable, false otherwise
checksumchecksum of the template
createdthe date this template was created
crossZonestrue if the template is managed across all Zones, false otherwise
detailsadditional key/value details tied with template
displaytextthe template display text
domainthe name of the domain to which the template belongs
domainidthe ID of the domain to which the template belongs
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.
passwordenabledtrue if the reset password feature is enabled, false otherwise
projectthe project name of the template
projectidthe project id of the template
removedthe date this template was removed
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
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