static/api/apidocs-4.16/apis/listIsos.html

<!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_controller"> <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.16.0.0 Root Admin API Reference </span> <p></p> <h1>listIsos</h1> <p>Lists all available ISO files.</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;"><i>account</i></td><td style="width:500px;"><i>list resources by account. Must be used with the domainId parameter.</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 the ISO is bootable, false otherwise</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>list only resources belonging to the domain specified</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>hypervisor</i></td><td style="width:500px;"><i>the hypervisor for which to restrict the search</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>list ISO by ID</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>isofilter</i></td><td style="width:500px;"><i>possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).</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 the ISO is publicly available to all users, false otherwise.</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>isready</i></td><td style="width:500px;"><i>true if this ISO is ready to be deployed</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>list all ISOs by name</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></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>list objects by project</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>showicon</i></td><td style="width:500px;"><i>flag to display the resource image for the isos</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>showremoved</i></td><td style="width:500px;"><i>show removed ISOs as well</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>showunique</i></td><td style="width:500px;"><i>If set to true, list only unique isos across zones</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>tags</i></td><td style="width:500px;"><i>List resources by tags (key/value pairs)</i></td><td style="width:180px;"><i>false</i></td> </tr> <tr> <td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>the ID of the zone</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>deployasis</strong></td><td style="width:500px;">VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template.</td> </tr> <tr> <td style="width:200px;"><strong>deployasisdetails</strong></td><td style="width:500px;">VMware only: additional key/value details tied with deploy-as-is template</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>downloaddetails</strong></td><td style="width:500px;">Lists the download progress of a template across all secondary storages</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>icon</strong></td><td style="width:500px;">Base64 string representation of the resource icon</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>url</strong></td><td style="width:500px;">the URL which the template/iso is registered from</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_maincontroller"> <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>

static/api/apidocs-4.16/apis/listIsos.html (282 lines of code) (raw):