Apache CloudStack 4.14.1.0-SNAPSHOT Root Admin API Reference
registerIso
Registers an existing ISO into the CloudStack Cloud.
Request parameters
| Parameter Name | Description | Required |
| displaytext | the display text of the ISO. This is usually used for display purposes. | true |
| name | the name of the ISO | true |
| url | the URL to where the ISO is currently being hosted | true |
| zoneid | the ID of the zone you wish to register the ISO to. | true |
| account | an optional account name. Must be used with domainId. | false |
| bootable | true if this ISO is bootable. If not passed explicitly its assumed to be true | false |
| checksum | the 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 |
| directdownload | true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment | false |
| domainid | an optional domainId. If the account parameter is used, domainId must also be used. | false |
| imagestoreuuid | Image store UUID | false |
| isdynamicallyscalable | true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory | false |
| isextractable | true if the ISO or its derivatives are extractable; default is false | false |
| isfeatured | true if you want this ISO to be featured | false |
| ispublic | true if you want to register the ISO to be publicly available to all users, false otherwise. | false |
| ostypeid | the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed | false |
| passwordenabled | true if password reset feature is supported; default is false | false |
| projectid | Register ISO for the project | 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 |
| 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 |
| 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. |
| 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 |
| 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 |