Apache CloudStack v4.9.0 Root Admin API Reference

updateTemplate

Updates attributes of a template.

Request parameters

Parameter NameDescriptionRequired
idthe ID of the image filetrue
bootabletrue if image is bootable, false otherwise; available only for updateIso APIfalse
cleanupdetailsoptional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)false
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61false
displaytextthe display text of the imagefalse
formatthe format for the imagefalse
isdynamicallyscalabletrue if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memoryfalse
isroutingtrue if the template type is routing i.e., if template is used to deploy routerfalse
namethe name of the image filefalse
ostypeidthe ID of the OS type that best represents the OS of this image.false
passwordenabledtrue if the image supports the password reset feature; default is falsefalse
requireshvmtrue if the template requres HVM, false otherwise; available only for updateTemplate APIfalse
sortkeysort key of the template, integerfalse

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
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