Apache CloudStack v4.9.0 Root Admin API Reference
registerTemplate
Registers an existing template into the CloudStack cloud.
Request parameters
| Parameter Name | Description | Required |
| displaytext | the display text of the template. This is usually used for display purposes. | true |
| format | the format for the template. Possible values include QCOW2, RAW, VHD and OVA. | true |
| hypervisor | the target hypervisor for the template | true |
| name | the name of the template | true |
| ostypeid | the ID of the OS Type that best represents the OS of this template. | true |
| url | the URL of where the template is hosted. Possible URL include http:// and https:// | true |
| zoneid | the ID of the zone the template is to be hosted on | true |
| account | an optional accountName. Must be used with domainId. | false |
| bits | 32 or 64 bits support. 64 by default | false |
| checksum | the MD5 checksum value of this template | false |
| details | Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61 | false |
| domainid | an optional domainId. If the account parameter is used, domainId must also be used. | false |
| isdynamicallyscalable | true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory | false |
| isextractable | true if the template or its derivatives are extractable; default is false | false |
| isfeatured | true if this template is a featured template, false otherwise | false |
| ispublic | true if the template is available to all accounts; default is true | false |
| isrouting | true if the template type is routing i.e., if template is used to deploy router | false |
| passwordenabled | true if the template supports the password reset feature; default is false | false |
| projectid | Register template for the project | false |
| requireshvm | true if this template requires HVM | false |
| sshkeyenabled | true if the template supports the sshkey upload feature; default is false | false |
| templatetag | the tag for this 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 |
| 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 |
| 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 |