| <!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.21.0.0 Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>listSharedFileSystems</h1> |
| <p>List Shared FileSystems</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>diskofferingid</i></td><td style="width:500px;"><i>the disk offering of the shared filesystem</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>id</i></td><td style="width:500px;"><i>the ID of the shared filesystem</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. Resources dedicated to a project are listed only if using the projectid parameter.</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 name of the shared filesystem</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>networkid</i></td><td style="width:500px;"><i>the ID of the network</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; if projectid=-1 lists All VMs</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>retrieveonlyresourcecount</i></td><td style="width:500px;"><i>makes the API's response contains only the resource count</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>serviceofferingid</i></td><td style="width:500px;"><i>the service offering of the shared filesystem</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 availability 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;">ID of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>description</strong></td><td style="width:500px;">description of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskioread</strong></td><td style="width:500px;">the read (IO) of disk on the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskiowrite</strong></td><td style="width:500px;">the write (IO) of disk on the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskkbsread</strong></td><td style="width:500px;">the shared filesystem's disk read in KiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskkbswrite</strong></td><td style="width:500px;">the shared filesystem's disk write in KiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskofferingdisplaytext</strong></td><td style="width:500px;">disk offering display text for the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskofferingid</strong></td><td style="width:500px;">disk offering ID for the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskofferingname</strong></td><td style="width:500px;">disk offering for the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainpath</strong></td><td style="width:500px;">path of the domain to which the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>filesystem</strong></td><td style="width:500px;">the filesystem format</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>iscustomdiskoffering</strong></td><td style="width:500px;">disk offering for the shared filesystem has custom size</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">name of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>networkid</strong></td><td style="width:500px;">Network ID of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>networkname</strong></td><td style="width:500px;">Network name of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>path</strong></td><td style="width:500px;">path to mount the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>physicalsize</strong></td><td style="width:500px;">the bytes actually consumed on disk</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project ID of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>provider</strong></td><td style="width:500px;">the shared filesystem provider</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>provisioningtype</strong></td><td style="width:500px;">provisioning type used in the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;">service offering ID for the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>serviceofferingname</strong></td><td style="width:500px;">service offering for the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>size</strong></td><td style="width:500px;">size of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>sizegb</strong></td><td style="width:500px;">size of the shared filesystem in GiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the shared filesystem</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>storage</strong></td><td style="width:500px;">name of the storage pool hosting the data volume</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>storageid</strong></td><td style="width:500px;">ID of the storage pool hosting the data volume</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>utilization</strong></td><td style="width:500px;">the disk utilization</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;">ID of the storage fs vm</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>virtualsize</strong></td><td style="width:500px;">the bytes allocated</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>vmstate</strong></td><td style="width:500px;">ID of the storage fs vm</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>volumeid</strong></td><td style="width:500px;">ID of the storage fs data volume</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>volumename</strong></td><td style="width:500px;">name of the storage fs data volume</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">ID of the availability zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">Name of the availability zone</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>nic(*)</strong></td><td style="width:500px;">the list of nics associated with the shared filesystem</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>mtu</strong></td><td style="width:500px;">MTU configured on the NIC</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>publicip</strong></td><td style="width:500px;">public IP address associated with this nic via Static nat rule</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>publicipid</strong></td><td style="width:500px;">public IP address id associated with this nic via Static nat rule</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> |
| <td style="width:180px; padding-left:25px;"><strong>vpcid</strong></td><td style="width:500px;">Id of the vpc to which the nic belongs</td> |
| </tr> |
| <tr> |
| <td style="width:180px; padding-left:25px;"><strong>vpcname</strong></td><td style="width:500px;">name of the vpc to which the nic belongs</td> |
| </tr> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="comments_thread"> |
| <script 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> |
