http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listResourceLimits.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listResourceLimits.html b/content/api/apidocs-4.0.0/root_admin/listResourceLimits.html new file mode 100644 index 0000000..4868552 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listResourceLimits.html @@ -0,0 +1,121 @@ +<!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>listResourceLimits</h1> +<p>Lists resource limits.</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>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>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>Lists resource limits by ID.</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>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>resourcetype</i></td><td style="width:500px;"><i>Type of resource to update. Values are 0, 1, 2, 3, and 4. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.</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>account</strong></td><td style="width:500px;">the account of the resource limit</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the resource limit</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the resource limit</td> +</tr> +<tr> +<td style="width:200px;"><strong>max</strong></td><td style="width:500px;">the maximum number of the resource. A -1 means the resource currently has no limit.</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the resource limit</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the resource limit</td> +</tr> +<tr> +<td style="width:200px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type. Values include 0, 1, 2, 3, 4. See the resourceType parameter for more information on these values.</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>
http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listRouters.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listRouters.html b/content/api/apidocs-4.0.0/root_admin/listRouters.html new file mode 100644 index 0000000..c0095e5 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listRouters.html @@ -0,0 +1,274 @@ +<!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>listRouters</h1> +<p>List routers.</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>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>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>forvpc</i></td><td style="width:500px;"><i>if true is passed for this parameter, list only VPC routers</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>hostid</i></td><td style="width:500px;"><i>the host ID of the router</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 disk router</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>the name of the router</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>list by network id</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>podid</i></td><td style="width:500px;"><i>the Pod ID of the router</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>state</i></td><td style="width:500px;"><i>the state of the router</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>vpcid</i></td><td style="width:500px;"><i>List networks by VPC</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 router</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 router</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the router was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>dns1</strong></td><td style="width:500px;">the first DNS for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>dns2</strong></td><td style="width:500px;">the second DNS for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID associated with the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">the gateway for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestipaddress</strong></td><td style="width:500px;">the guest IP address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestmacaddress</strong></td><td style="width:500px;">the guest MAC address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestnetmask</strong></td><td style="width:500px;">the guest netmask for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestnetworkid</strong></td><td style="width:500px;">the ID of the corresponding guest network</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the host ID for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the hostname for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>isredundantrouter</strong></td><td style="width:500px;">if this router is an redundant virtual router</td> +</tr> +<tr> +<td style="width:200px;"><strong>linklocalip</strong></td><td style="width:500px;">the link local IP address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>linklocalmacaddress</strong></td><td style="width:500px;">the link local MAC address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>linklocalnetmask</strong></td><td style="width:500px;">the link local netmask for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>linklocalnetworkid</strong></td><td style="width:500px;">the ID of the corresponding link local network</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkdomain</strong></td><td style="width:500px;">the network domain for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the address</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the ipaddress</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicip</strong></td><td style="width:500px;">the public IP address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicmacaddress</strong></td><td style="width:500px;">the public MAC address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicnetmask</strong></td><td style="width:500px;">the public netmask for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicnetworkid</strong></td><td style="width:500px;">the ID of the corresponding public network</td> +</tr> +<tr> +<td style="width:200px;"><strong>redundantstate</strong></td><td style="width:500px;">the state of redundant virtual router</td> +</tr> +<tr> +<td style="width:200px;"><strong>scriptsversion</strong></td><td style="width:500px;">the version of scripts</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;">the ID of the service offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingname</strong></td><td style="width:500px;">the name of the service offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>templateid</strong></td><td style="width:500px;">the template ID for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>templateversion</strong></td><td style="width:500px;">the version of template</td> +</tr> +<tr> +<td style="width:200px;"><strong>vpcid</strong></td><td style="width:500px;">VPC the network belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>nic(*)</strong></td><td style="width:500px;">the list of nics associated with the router</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>broadcasturi</strong></td><td style="width:500px;">the broadcast uri of 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>ipaddress</strong></td><td style="width:500px;">the ip address of the nic</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>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>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> +</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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listSSHKeyPairs.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listSSHKeyPairs.html b/content/api/apidocs-4.0.0/root_admin/listSSHKeyPairs.html new file mode 100644 index 0000000..7fb2010 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listSSHKeyPairs.html @@ -0,0 +1,109 @@ +<!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>listSSHKeyPairs</h1> +<p>List registered keypairs</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>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>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>fingerprint</i></td><td style="width:500px;"><i>A public key fingerprint to look for</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>A key pair name to look for</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> +</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>fingerprint</strong></td><td style="width:500px;">Fingerprint of the public key</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">Name of the keypair</td> +</tr> +<tr> +<td style="width:200px;"><strong>privatekey</strong></td><td style="width:500px;">Private key</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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listSecurityGroups.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listSecurityGroups.html b/content/api/apidocs-4.0.0/root_admin/listSecurityGroups.html new file mode 100644 index 0000000..1bf1712 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listSecurityGroups.html @@ -0,0 +1,229 @@ +<!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>listSecurityGroups</h1> +<p>Lists security groups</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>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>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>list the security group by the id provided</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>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>securitygroupname</i></td><td style="width:500px;"><i>lists security groups by name</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>virtualmachineid</i></td><td style="width:500px;"><i>lists security groups by virtual machine id</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 security group</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account owning the security group</td> +</tr> +<tr> +<td style="width:200px;"><strong>description</strong></td><td style="width:500px;">the description of the security group</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the security group</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the security group</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the security group</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the group</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the group</td> +</tr> +<tr> +<td style="width:200px;"><strong>egressrule(*)</strong></td><td style="width:500px;">the list of egress rules associated with the security group</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">account owning the security group rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>cidr</strong></td><td style="width:500px;">the CIDR notation for the base IP address of the security group rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>endport</strong></td><td style="width:500px;">the ending IP of the security group rule </td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>icmpcode</strong></td><td style="width:500px;">the code for the ICMP message response</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>icmptype</strong></td><td style="width:500px;">the type of the ICMP message response</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the security group rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ruleid</strong></td><td style="width:500px;">the id of the security group rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>securitygroupname</strong></td><td style="width:500px;">security group name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>startport</strong></td><td style="width:500px;">the starting IP of the security group rule</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>ingressrule(*)</strong></td><td style="width:500px;">the list of ingress rules associated with the security group</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">account owning the security group rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>cidr</strong></td><td style="width:500px;">the CIDR notation for the base IP address of the security group rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>endport</strong></td><td style="width:500px;">the ending IP of the security group rule </td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>icmpcode</strong></td><td style="width:500px;">the code for the ICMP message response</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>icmptype</strong></td><td style="width:500px;">the type of the ICMP message response</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the security group rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ruleid</strong></td><td style="width:500px;">the id of the security group rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>securitygroupname</strong></td><td style="width:500px;">security group name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>startport</strong></td><td style="width:500px;">the starting IP of the security group rule</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with the rule</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</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="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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listServiceOfferings.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listServiceOfferings.html b/content/api/apidocs-4.0.0/root_admin/listServiceOfferings.html new file mode 100644 index 0000000..12ee55e --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listServiceOfferings.html @@ -0,0 +1,151 @@ +<!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>listServiceOfferings</h1> +<p>Lists all available service offerings.</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>domainid</i></td><td style="width:500px;"><i>the ID of the domain associated with the service offering</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>ID of the service offering</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>issystem</i></td><td style="width:500px;"><i>is this a system vm offering</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>name</i></td><td style="width:500px;"><i>name of the service offering</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>systemvmtype</i></td><td style="width:500px;"><i>the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter".</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>virtualmachineid</i></td><td style="width:500px;"><i>the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.</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 service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the number of CPU</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuspeed</strong></td><td style="width:500px;">the clock rate CPU speed in Mhz</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date this service offering was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>defaultuse</strong></td><td style="width:500px;">is this a default system vm offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">an alternate display text of the service offering.</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">Domain name for the offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain id of the service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>hosttags</strong></td><td style="width:500px;">the host tag for the service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>issystem</strong></td><td style="width:500px;">is this a system vm offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>limitcpuuse</strong></td><td style="width:500px;">restrict the CPU usage to committed service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>memory</strong></td><td style="width:500px;">the memory in MB</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkrate</strong></td><td style="width:500px;">data transfer rate in megabits per second allowed.</td> +</tr> +<tr> +<td style="width:200px;"><strong>offerha</strong></td><td style="width:500px;">the ha support in the service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>storagetype</strong></td><td style="width:500px;">the storage type for this service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>systemvmtype</strong></td><td style="width:500px;">is this a the systemvm type for system vm offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags</strong></td><td style="width:500px;">the tags for the service offering</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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listSnapshotPolicies.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listSnapshotPolicies.html b/content/api/apidocs-4.0.0/root_admin/listSnapshotPolicies.html new file mode 100644 index 0000000..a3e0ea1 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listSnapshotPolicies.html @@ -0,0 +1,100 @@ +<!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>listSnapshotPolicies</h1> +<p>Lists snapshot policies.</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;"><strong>volumeid</strong></td><td style="width:500px;"><strong>the ID of the disk volume</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>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>id</strong></td><td style="width:500px;">the ID of the snapshot policy</td> +</tr> +<tr> +<td style="width:200px;"><strong>intervaltype</strong></td><td style="width:500px;">the interval type of the snapshot policy</td> +</tr> +<tr> +<td style="width:200px;"><strong>maxsnaps</strong></td><td style="width:500px;">maximum number of snapshots retained</td> +</tr> +<tr> +<td style="width:200px;"><strong>schedule</strong></td><td style="width:500px;">time the snapshot is scheduled to be taken.</td> +</tr> +<tr> +<td style="width:200px;"><strong>timezone</strong></td><td style="width:500px;">the time zone of the snapshot policy</td> +</tr> +<tr> +<td style="width:200px;"><strong>volumeid</strong></td><td style="width:500px;">the ID of the disk volume</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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listSnapshots.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listSnapshots.html b/content/api/apidocs-4.0.0/root_admin/listSnapshots.html new file mode 100644 index 0000000..49d7e8b --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listSnapshots.html @@ -0,0 +1,193 @@ +<!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>listSnapshots</h1> +<p>Lists all available snapshots for the account.</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>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>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>lists snapshot by snapshot ID</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>intervaltype</i></td><td style="width:500px;"><i>valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.</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>lists snapshot by snapshot 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>snapshottype</i></td><td style="width:500px;"><i>valid values are MANUAL or RECURRING.</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>volumeid</i></td><td style="width:500px;"><i>the ID of the disk volume</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 snapshot</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the snapshot</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;"> the date the snapshot was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the snapshot's account</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the snapshot's account</td> +</tr> +<tr> +<td style="width:200px;"><strong>intervaltype</strong></td><td style="width:500px;">valid types are hourly, daily, weekly, monthy, template, and none.</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">name of the snapshot</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the snapshot</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the snapshot</td> +</tr> +<tr> +<td style="width:200px;"><strong>snapshottype</strong></td><td style="width:500px;">the type of the snapshot</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage</td> +</tr> +<tr> +<td style="width:200px;"><strong>volumeid</strong></td><td style="width:500px;">ID of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>volumename</strong></td><td style="width:500px;">name of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>volumetype</strong></td><td style="width:500px;">type of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with snapshot</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</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="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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listStaticRoutes.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listStaticRoutes.html b/content/api/apidocs-4.0.0/root_admin/listStaticRoutes.html new file mode 100644 index 0000000..f32779b --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listStaticRoutes.html @@ -0,0 +1,169 @@ +<!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>listStaticRoutes</h1> +<p>Lists all static routes</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>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>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>gatewayid</i></td><td style="width:500px;"><i>list static routes by gateway id</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 static route by id</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>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>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>vpcid</i></td><td style="width:500px;"><i>list static routes by vpc id</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 static route</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the static route</td> +</tr> +<tr> +<td style="width:200px;"><strong>cidr</strong></td><td style="width:500px;">static route CIDR</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the static route</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the static route</td> +</tr> +<tr> +<td style="width:200px;"><strong>gatewayid</strong></td><td style="width:500px;">VPC gateway the route is created for</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the static route</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the static route</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the static route</td> +</tr> +<tr> +<td style="width:200px;"><strong>vpcid</strong></td><td style="width:500px;">VPC the static route belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with static route</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listStorageNetworkIpRange.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listStorageNetworkIpRange.html b/content/api/apidocs-4.0.0/root_admin/listStorageNetworkIpRange.html new file mode 100644 index 0000000..47b7b34 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listStorageNetworkIpRange.html @@ -0,0 +1,115 @@ +<!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>listStorageNetworkIpRange</h1> +<p>List a storage network IP range.</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>id</i></td><td style="width:500px;"><i>optional parameter. Storaget network IP range uuid, if specicied, using it to search the 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>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>podid</i></td><td style="width:500px;"><i>optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.</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>optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the 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 uuid of storage network IP range.</td> +</tr> +<tr> +<td style="width:200px;"><strong>endip</strong></td><td style="width:500px;">the end ip of the storage network IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">the gateway of the storage network IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>netmask</strong></td><td style="width:500px;">the netmask of the storage network IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkid</strong></td><td style="width:500px;">the network uuid of storage network IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod uuid for the storage network IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>startip</strong></td><td style="width:500px;">the start ip of the storage network 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 uuid of the storage network 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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listStoragePools.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listStoragePools.html b/content/api/apidocs-4.0.0/root_admin/listStoragePools.html new file mode 100644 index 0000000..30a6689 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listStoragePools.html @@ -0,0 +1,157 @@ +<!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>listStoragePools</h1> +<p>Lists storage pools.</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>clusterid</i></td><td style="width:500px;"><i>list storage pools belongig to the specific cluster</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 storage pool</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>ipaddress</i></td><td style="width:500px;"><i>the IP address for the storage pool</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>name</i></td><td style="width:500px;"><i>the name of the storage pool</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>path</i></td><td style="width:500px;"><i>the storage pool path</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 for the storage pool</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 for the storage pool</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 storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>clusterid</strong></td><td style="width:500px;">the ID of the cluster for the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustername</strong></td><td style="width:500px;">the name of the cluster for the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the storage pool was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizeallocated</strong></td><td style="width:500px;">the host's currently allocated disk size</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizetotal</strong></td><td style="width:500px;">the total disk size of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizeused</strong></td><td style="width:500px;">the host's currently used disk size</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the IP address of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>path</strong></td><td style="width:500px;">the storage pool path</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">the Pod name of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags</strong></td><td style="width:500px;">the tags for the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">the storage pool type</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name of the storage pool</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="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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listSupportedNetworkServices.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listSupportedNetworkServices.html b/content/api/apidocs-4.0.0/root_admin/listSupportedNetworkServices.html new file mode 100644 index 0000000..7748056 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listSupportedNetworkServices.html @@ -0,0 +1,103 @@ +<!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>listSupportedNetworkServices</h1> +<p>Lists all network services provided by CloudStack or for the given Provider.</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>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>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>provider</i></td><td style="width:500px;"><i>network service provider name</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>service</i></td><td style="width:500px;"><i>network service name to list providers and capabilities of</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>name</strong></td><td style="width:500px;">the service name</td> +</tr> +<tr> +<td style="width:200px;"><strong>provider</strong></td><td style="width:500px;">the service provider name</td> +</tr> +<tr> +<td style="width:200px;"><strong>capability(*)</strong></td><td style="width:500px;">the list of capabilities</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>canchooseservicecapability</strong></td><td style="width:500px;">can this service capability value can be choosable while creatine network offerings</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>name</strong></td><td style="width:500px;">the capability name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">the capability value</td> +</tr> +</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> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/listSwifts.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/listSwifts.html b/content/api/apidocs-4.0.0/root_admin/listSwifts.html new file mode 100644 index 0000000..bc2c043 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/listSwifts.html @@ -0,0 +1,217 @@ +<!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>listSwifts</h1> +<p>List Swift.</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>id</i></td><td style="width:500px;"><i>the id of the swift</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>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>id</strong></td><td style="width:500px;">the ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>averageload</strong></td><td style="width:500px;">the cpu average load on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>capabilities</strong></td><td style="width:500px;">capabilities of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clusterid</strong></td><td style="width:500px;">the cluster ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustername</strong></td><td style="width:500px;">the cluster name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustertype</strong></td><td style="width:500px;">the cluster type of the cluster that host belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuallocated</strong></td><td style="width:500px;">the amount of the host's CPU currently allocated</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the CPU number of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuspeed</strong></td><td style="width:500px;">the CPU speed of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuused</strong></td><td style="width:500px;">the amount of the host's CPU currently used</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuwithoverprovisioning</strong></td><td style="width:500px;">the amount of the host's CPU after applying the cpu.overprovisioning.factor </td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the host was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>disconnected</strong></td><td style="width:500px;">true if the host is disconnected. False otherwise.</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizeallocated</strong></td><td style="width:500px;">the host's currently allocated disk size</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizetotal</strong></td><td style="width:500px;">the total disk size of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>events</strong></td><td style="width:500px;">events available for the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>hahost</strong></td><td style="width:500px;">true if the host is Ha host (dedicated to vms started by HA process; false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>hasenoughcapacity</strong></td><td style="width:500px;">true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>hosttags</strong></td><td style="width:500px;">comma-separated list of tags for the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the host hypervisor</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisorversion</strong></td><td style="width:500px;">the hypervisor version</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the IP address of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>islocalstorageactive</strong></td><td style="width:500px;">true if local storage is active, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>lastpinged</strong></td><td style="width:500px;">the date and time the host was last pinged</td> +</tr> +<tr> +<td style="width:200px;"><strong>managementserverid</strong></td><td style="width:500px;">the management server ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>memoryallocated</strong></td><td style="width:500px;">the amount of the host's memory currently allocated</td> +</tr> +<tr> +<td style="width:200px;"><strong>memorytotal</strong></td><td style="width:500px;">the memory total of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>memoryused</strong></td><td style="width:500px;">the amount of the host's memory currently used</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkkbsread</strong></td><td style="width:500px;">the incoming network traffic on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkkbswrite</strong></td><td style="width:500px;">the outgoing network traffic on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>oscategoryid</strong></td><td style="width:500px;">the OS category ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>oscategoryname</strong></td><td style="width:500px;">the OS category name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">the Pod name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>removed</strong></td><td style="width:500px;">the date and time the host was removed</td> +</tr> +<tr> +<td style="width:200px;"><strong>resourcestate</strong></td><td style="width:500px;">the resource state of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>suitableformigration</strong></td><td style="width:500px;">true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">the host type</td> +</tr> +<tr> +<td style="width:200px;"><strong>version</strong></td><td style="width:500px;">the host version</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name of the host</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="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>
