| <!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>listUnmanagedInstances</h1> |
| <p>Lists unmanaged virtual machines for a given cluster.</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>clusterid</strong></td><td style="width:500px;"><strong>the cluster ID</strong></td><td style="width:180px;"><strong>true</strong></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>name</i></td><td style="width:500px;"><i>the hypervisor name of the instance</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> |
| </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>clusterid</strong></td><td style="width:500px;">the ID of the cluster to which virtual machine belongs</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpucorepersocket</strong></td><td style="width:500px;">the CPU cores per socket for the virtual machine. VMware specific</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the CPU cores of the virtual machine</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpuspeed</strong></td><td style="width:500px;">the CPU speed of the virtual machine</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the host to which virtual machine belongs</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memory</strong></td><td style="width:500px;">the memory of the virtual machine in MB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the virtual machine</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>osdisplayname</strong></td><td style="width:500px;">the operating system of the virtual machine</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>osid</strong></td><td style="width:500px;">the operating system ID of the virtual machine</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>powerstate</strong></td><td style="width:500px;">the power state of the virtual machine</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>disk(*)</strong></td><td style="width:500px;">the list of disks associated with the virtual machine</td> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the disk</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>capacity</strong></td><td style="width:500px;">the capacity of the disk in bytes</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>controller</strong></td><td style="width:500px;">the controller of the disk</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>controllerunit</strong></td><td style="width:500px;">the controller unit of the disk</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>datastorehost</strong></td><td style="width:500px;">the controller of the disk</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>datastorename</strong></td><td style="width:500px;">the controller of the disk</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>datastorepath</strong></td><td style="width:500px;">the controller of the disk</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>datastoretype</strong></td><td style="width:500px;">the controller of the disk</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>imagepath</strong></td><td style="width:500px;">the file path of the disk image</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>label</strong></td><td style="width:500px;">the label of the disk</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>position</strong></td><td style="width:500px;">the position of the disk</td> |
| </tr> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>nic(*)</strong></td><td style="width:500px;">the list of nics associated with the virtual machine</td> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>adaptertype</strong></td><td style="width:500px;">Type of adapter if available</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>broadcasturi</strong></td><td style="width:500px;">the broadcast uri of the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>deviceid</strong></td><td style="width:500px;">device id for the network when plugged into the virtual machine</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>extradhcpoption</strong></td><td style="width:500px;">the extra dhcp options on the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>gateway</strong></td><td style="width:500px;">the gateway of the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>ip6address</strong></td><td style="width:500px;">the IPv6 address of network</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>ip6cidr</strong></td><td style="width:500px;">the cidr of IPv6 network</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>ip6gateway</strong></td><td style="width:500px;">the gateway of IPv6 network</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>ipaddress</strong></td><td style="width:500px;">the ip address of the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>ipaddresses</strong></td><td style="width:500px;">IP addresses associated with NIC found for unmanaged VM</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>isdefault</strong></td><td style="width:500px;">true if nic is default, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>isolatedpvlan</strong></td><td style="width:500px;">the isolated private VLAN if available</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>isolatedpvlantype</strong></td><td style="width:500px;">the isolated private VLAN type if available</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>isolationuri</strong></td><td style="width:500px;">the isolation uri of the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>macaddress</strong></td><td style="width:500px;">true if nic is default, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>netmask</strong></td><td style="width:500px;">the netmask of the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>networkid</strong></td><td style="width:500px;">the ID of the corresponding network</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>networkname</strong></td><td style="width:500px;">the name of the corresponding network</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>nsxlogicalswitch</strong></td><td style="width:500px;">Id of the NSX Logical Switch (if NSX based), null otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>nsxlogicalswitchport</strong></td><td style="width:500px;">Id of the NSX Logical Switch Port (if NSX based), null otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>secondaryip</strong></td><td style="width:500px;">the Secondary ipv4 addr of nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>traffictype</strong></td><td style="width:500px;">the traffic type of the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>type</strong></td><td style="width:500px;">the type of the nic</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>virtualmachineid</strong></td><td style="width:500px;">Id of the vm to which the nic belongs</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>vlanid</strong></td><td style="width:500px;">ID of the VLAN/VNI if available</td> |
| </tr> |
| </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> |
