| <!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.0.0-incubating Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>listVlanIpRanges</h1> |
| <p>Lists all VLAN IP ranges.</p> |
| </div> |
| <div class="api_titlebox_right"> |
| <a class="api_backbutton" href="../TOC_Root_Admin.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>the account with which the VLAN IP range is associated. Must be used with the domainId parameter.</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>the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>forvirtualnetwork</i></td><td style="width:500px;"><i>true if VLAN is of Virtual type, false if Direct</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 VLAN IP range</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>networkid</i></td><td style="width:500px;"><i>network id of the VLAN IP range</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>physicalnetworkid</i></td><td style="width:500px;"><i>physical network id of the VLAN IP range</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>podid</i></td><td style="width:500px;"><i>the Pod ID of the VLAN IP range</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>project who will own the VLAN</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>vlan</i></td><td style="width:500px;"><i>the ID or VID of the VLAN. Default is an "untagged" VLAN.</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 Zone ID of the VLAN IP range</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 ID of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>description</strong></td><td style="width:500px;">the description of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>endip</strong></td><td style="width:500px;">the end ip of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>forvirtualnetwork</strong></td><td style="width:500px;">the virtual network for the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">the gateway of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>netmask</strong></td><td style="width:500px;">the netmask of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>networkid</strong></td><td style="width:500px;">the network id of vlan range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network this belongs to</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID for the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">the Pod name for the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the vlan range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the vlan range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>startip</strong></td><td style="width:500px;">the start ip of the VLAN IP range</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>vlan</strong></td><td style="width:500px;">the ID or VID of the VLAN.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the VLAN IP range</td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="footer_mainmaster"> |
| <p>Copyright © 2012 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 and the Apache feather logo are trademarks of The Apache Software Foundation.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |