Apache CloudStack 4.18.0.0 Root Admin API Reference
updateTemplate
Updates attributes of a template.
Request parameters
| Parameter Name | Description | Required |
| id | the ID of the image file | true |
| bootable | true if image is bootable, false otherwise; available only for updateIso API | false |
| cleanupdetails | optional 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 |
| details | Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 | false |
| displaytext | the display text of the image | false |
| format | the format for the image | false |
| isdynamicallyscalable | true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory | false |
| isrouting | true if the template type is routing i.e., if template is used to deploy router | false |
| name | the name of the image file | false |
| ostypeid | the ID of the OS type that best represents the OS of this image. | false |
| passwordenabled | true if the image supports the password reset feature; default is false | false |
| requireshvm | true if the template requires HVM, false otherwise; available only for updateTemplate API | false |
| sortkey | sort key of the template, integer | false |
| sshkeyenabled | true if the template supports the sshkey upload feature; default is false | false |
| templatetype | the type of the template | 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 |
| bits | the processor bit size |
| bootable | true if the ISO is bootable, false otherwise |
| checksum | checksum of the template |
| childtemplates | if root disk template, then ids of the datas disk templates this template owns |
| created | the date this template was created |
| crossZones | true if the template is managed across all Zones, false otherwise |
| deployasis | VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. |
| deployasisdetails | VMware only: additional key/value details tied with deploy-as-is template |
| details | additional key/value details tied with template |
| directdownload | KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage |
| 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 |
| downloaddetails | Lists the download progress of a template across all secondary storages |
| 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 |
| icon | Base64 string representation of the resource icon |
| 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. |
| parenttemplateid | if Datadisk template, then id of the root disk template this template belongs to |
| passwordenabled | true if the reset password feature is enabled, false otherwise |
| physicalsize | the physical size of the template |
| project | the project name of the template |
| projectid | the project id of the template |
| removed | the date this template was removed |
| requireshvm | true if template requires HVM enabled, false otherwise |
| 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 |
| url | the URL which the template/iso is registered from |
| userdataid | the id of userdata linked to this template |
| userdataname | the name of userdata linked to this template |
| userdataparams | list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata |
| userdatapolicy | the userdata override policy with the userdata provided while deploying VM |
| zoneid | the ID of the zone for this template |
| zonename | the name of the zone for this template |
| 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 |