Apache CloudStack 4.23.0.0 Root Admin API Reference
registerIso
Registers an existing ISO into the CloudStack Cloud.
Request parameters
| Parameter Name | Description | Required |
| 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 |
| arch | the CPU arch of the ISO. Valid options are: x86_64, aarch64, s390x | 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 |
| displaytext | The display text of the ISO, defaults to the 'name' | 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 in order to support dynamic scaling of Instance 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 |
| arch | CPU Arch of the template |
| 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 |
| domainpath | Path of the Domain the template belongs to |
| downloaddetails | Lists the download progress of a Template across all secondary storages |
| extensionid | The ID of extension linked to this template |
| extensionname | The name of extension linked to this template |
| forcks | If true it indicates that the template can be used for CKS cluster deployments |
| 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 in order to support dynamic scaling of Instance 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 Instance |
| 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 |