| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" href="../includes/main.css" type="text/css"> |
| <link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> |
| <title>Apache CloudStack | The Power Behind Your Cloud</title> |
| </head> |
| <body> |
| <div id="insidetopbg"> |
| <div id="inside_wrapper"> |
| <div class="uppermenu_panel"> |
| <div class="uppermenu_box"></div> |
| </div> |
| <div id="main_master"> |
| <div id="inside_header"> |
| <div class="header_top"> |
| <a class="cloud_logo" href="http://cloudstack.org"></a> |
| <div class="mainemenu_panel"></div> |
| </div> |
| </div> |
| <div id="main_content"> |
| <div class="inside_apileftpanel"> |
| <div class="inside_contentpanel" style="width:930px;"> |
| <div class="api_titlebox"> |
| <div class="api_titlebox_left"> |
| <span> |
| Apache CloudStack 4.14.1.0-SNAPSHOT Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>registerIso</h1> |
| <p>Registers an existing ISO into the CloudStack Cloud.</p> |
| </div> |
| <div class="api_titlebox_right"> |
| <a class="api_backbutton" href="../index.html"></a> |
| </div> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Request parameters</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;"><strong>the display text of the ISO. This is usually used for display purposes.</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;"><strong>the name of the ISO</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>url</strong></td><td style="width:500px;"><strong>the URL to where the ISO is currently being hosted</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;"><strong>the ID of the zone you wish to register the ISO to.</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>an optional account name. Must be used with domainId.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>bootable</i></td><td style="width:500px;"><i>true if this ISO is bootable. If not passed explicitly its assumed to be true</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>checksum</i></td><td style="width:500px;"><i>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.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>directdownload</i></td><td style="width:500px;"><i>true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>an optional domainId. If the account parameter is used, domainId must also be used.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>imagestoreuuid</i></td><td style="width:500px;"><i>Image store UUID</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>isdynamicallyscalable</i></td><td style="width:500px;"><i>true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>isextractable</i></td><td style="width:500px;"><i>true if the ISO or its derivatives are extractable; default is false</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>isfeatured</i></td><td style="width:500px;"><i>true if you want this ISO to be featured</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>ispublic</i></td><td style="width:500px;"><i>true if you want to register the ISO to be publicly available to all users, false otherwise.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>ostypeid</i></td><td style="width:500px;"><i>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</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>passwordenabled</i></td><td style="width:500px;"><i>true if password reset feature is supported; default is false</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>projectid</i></td><td style="width:500px;"><i>Register ISO for the project</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| </table> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Response Tags</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the template ID</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account name to which the template belongs</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account id to which the template belongs</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>bits</strong></td><td style="width:500px;">the processor bit size</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>bootable</strong></td><td style="width:500px;">true if the ISO is bootable, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>checksum</strong></td><td style="width:500px;">checksum of the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>childtemplates</strong></td><td style="width:500px;">if root disk template, then ids of the datas disk templates this template owns</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date this template was created</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>crossZones</strong></td><td style="width:500px;">true if the template is managed across all Zones, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>details</strong></td><td style="width:500px;">additional key/value details tied with template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>directdownload</strong></td><td style="width:500px;">KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">the template display text</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the name of the domain to which the template belongs</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain to which the template belongs</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>format</strong></td><td style="width:500px;">the format of the template.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the secondary storage host for the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the name of the secondary storage host for the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the hypervisor on which the template runs</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>isdynamicallyscalable</strong></td><td style="width:500px;">true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>isextractable</strong></td><td style="width:500px;">true if the template is extractable, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>isfeatured</strong></td><td style="width:500px;">true if this template is a featured template, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ispublic</strong></td><td style="width:500px;">true if this template is a public template, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>isready</strong></td><td style="width:500px;">true if the template is ready to be deployed from, false otherwise.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the template name</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ostypeid</strong></td><td style="width:500px;">the ID of the OS type for this template.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>ostypename</strong></td><td style="width:500px;">the name of the OS type for this template.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>parenttemplateid</strong></td><td style="width:500px;">if Datadisk template, then id of the root disk template this template belongs to</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>passwordenabled</strong></td><td style="width:500px;">true if the reset password feature is enabled, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>physicalsize</strong></td><td style="width:500px;">the physical size of the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>removed</strong></td><td style="width:500px;">the date this template was removed</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>requireshvm</strong></td><td style="width:500px;">true if template requires HVM enabled, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>size</strong></td><td style="width:500px;">the size of the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>sourcetemplateid</strong></td><td style="width:500px;">the template ID of the parent template if present</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>sshkeyenabled</strong></td><td style="width:500px;">true if template is sshkey enabled, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the status of the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>templatetag</strong></td><td style="width:500px;">the tag of this template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>templatetype</strong></td><td style="width:500px;">the type of the template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the ID of the zone for this template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the name of the zone for this template</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="comments_thread"> |
| <script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test" async="true"></script> |
| <noscript> |
| <iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin"></iframe> |
| </noscript> |
| </div> |
| <div id="footer_mainmaster"> |
| <p> |
| Copyright © 2015 The Apache Software Foundation, Licensed under the |
| <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a> |
| <br> |
| Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
