http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/disableCiscoNexusVSM.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/disableCiscoNexusVSM.html b/content/api/apidocs-4.8/root_admin/disableCiscoNexusVSM.html new file mode 100644 index 0000000..de92572 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/disableCiscoNexusVSM.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>disableCiscoNexusVSM</h1> +<p>disable a Cisco Nexus VSM device</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>id</strong></td><td style="width:500px;"><strong>Id of the Cisco Nexus 1000v VSM device to be deleted</strong></td><td style="width:180px;"><strong>true</strong></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>ipaddress</strong></td><td style="width:500px;">the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmconfigmode</strong></td><td style="width:500px;">The mode of the VSM (standalone/HA)</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmconfigstate</strong></td><td style="width:500px;">The Config State (Primary/Standby) of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmctrlvlanid</strong></td><td style="width:500px;">control vlan id of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdeviceid</strong></td><td style="width:500px;">device id of the Cisco N1KV VSM device</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdevicename</strong></td><td style="width:500px;">device name</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdevicestate</strong></td><td style="width:500px;">device state</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdevicestate</strong></td><td style="width:500px;">The Device State (Enabled/Disabled) of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdomainid</strong></td><td style="width:500px;">The VSM is a switch supervisor. This is the VSM's switch domain id</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmmgmtvlanid</strong></td><td style="width:500px;">management vlan id of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmpktvlanid</strong></td><td style="width:500px;">packet vlan id of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmstoragevlanid</strong></td><td style="width:500px;">storage vlan id of the VSM</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/disableStaticNat.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/disableStaticNat.html b/content/api/apidocs-4.8/root_admin/disableStaticNat.html new file mode 100644 index 0000000..69a418d --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/disableStaticNat.html @@ -0,0 +1,85 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>disableStaticNat</h1> +<p>Disables static rule for given IP address</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>ipaddressid</strong></td><td style="width:500px;"><strong>the public IP address ID for which static NAT feature is being disabled</strong></td><td style="width:180px;"><strong>true</strong></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>displaytext</strong></td><td style="width:500px;">any text associated with the success or failure</td> +</tr> +<tr> +<td style="width:200px;"><strong>success</strong></td><td style="width:500px;">true if operation is executed successfully</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/disableUser.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/disableUser.html b/content/api/apidocs-4.8/root_admin/disableUser.html new file mode 100644 index 0000000..6d0a24f --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/disableUser.html @@ -0,0 +1,130 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>disableUser</h1> +<p>Disables a user 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;"><strong>id</strong></td><td style="width:500px;"><strong>Disables user by user ID.</strong></td><td style="width:180px;"><strong>true</strong></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 user ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account name of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account ID of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>accounttype</strong></td><td style="width:500px;">the account type of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>apikey</strong></td><td style="width:500px;">the api key of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the user account was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>email</strong></td><td style="width:500px;">the user email address</td> +</tr> +<tr> +<td style="width:200px;"><strong>firstname</strong></td><td style="width:500px;">the user firstname</td> +</tr> +<tr> +<td style="width:200px;"><strong>iscallerchilddomain</strong></td><td style="width:500px;">the boolean value representing if the updating target is in caller's child domain</td> +</tr> +<tr> +<td style="width:200px;"><strong>isdefault</strong></td><td style="width:500px;">true if user is default, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>lastname</strong></td><td style="width:500px;">the user lastname</td> +</tr> +<tr> +<td style="width:200px;"><strong>secretkey</strong></td><td style="width:500px;">the secret key of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the user state</td> +</tr> +<tr> +<td style="width:200px;"><strong>timezone</strong></td><td style="width:500px;">the timezone user was created in</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the user name</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/disassociateIpAddress.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/disassociateIpAddress.html b/content/api/apidocs-4.8/root_admin/disassociateIpAddress.html new file mode 100644 index 0000000..aee11b7 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/disassociateIpAddress.html @@ -0,0 +1,85 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>disassociateIpAddress</h1> +<p>Disassociates an IP address from 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;"><strong>id</strong></td><td style="width:500px;"><strong>the ID of the public IP address to disassociate</strong></td><td style="width:180px;"><strong>true</strong></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>displaytext</strong></td><td style="width:500px;">any text associated with the success or failure</td> +</tr> +<tr> +<td style="width:200px;"><strong>success</strong></td><td style="width:500px;">true if operation is executed successfully</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/dissociateLun.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/dissociateLun.html b/content/api/apidocs-4.8/root_admin/dissociateLun.html new file mode 100644 index 0000000..e268bfd --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/dissociateLun.html @@ -0,0 +1,82 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>dissociateLun</h1> +<p>Dissociate a LUN</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>iqn</strong></td><td style="width:500px;"><strong>Guest IQN.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>path</strong></td><td style="width:500px;"><strong>LUN path.</strong></td><td style="width:180px;"><strong>true</strong></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> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/enableAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/enableAccount.html b/content/api/apidocs-4.8/root_admin/enableAccount.html new file mode 100644 index 0000000..dfbf27b --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/enableAccount.html @@ -0,0 +1,295 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>enableAccount</h1> +<p>Enables an 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>Enables specified account.</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>Enables specified account in this domain.</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>Account 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 account</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountdetails</strong></td><td style="width:500px;">details for the account</td> +</tr> +<tr> +<td style="width:200px;"><strong>accounttype</strong></td><td style="width:500px;">account type (admin, domain-admin, user)</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuavailable</strong></td><td style="width:500px;">the total number of cpu cores available to be created for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpulimit</strong></td><td style="width:500px;">the total number of cpu cores the account can own</td> +</tr> +<tr> +<td style="width:200px;"><strong>cputotal</strong></td><td style="width:500px;">the total number of cpu cores owned by account</td> +</tr> +<tr> +<td style="width:200px;"><strong>defaultzoneid</strong></td><td style="width:500px;">the default zone of the account</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">name of the Domain the account belongs too</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">id of the Domain the account belongs too</td> +</tr> +<tr> +<td style="width:200px;"><strong>groups</strong></td><td style="width:500px;">the list of acl groups that account belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipavailable</strong></td><td style="width:500px;">the total number of public ip addresses available for this account to acquire</td> +</tr> +<tr> +<td style="width:200px;"><strong>iplimit</strong></td><td style="width:500px;">the total number of public ip addresses this account can acquire</td> +</tr> +<tr> +<td style="width:200px;"><strong>iptotal</strong></td><td style="width:500px;">the total number of public ip addresses allocated for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>iscleanuprequired</strong></td><td style="width:500px;">true if the account requires cleanup</td> +</tr> +<tr> +<td style="width:200px;"><strong>isdefault</strong></td><td style="width:500px;">true if account is default, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>memoryavailable</strong></td><td style="width:500px;">the total memory (in MB) available to be created for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>memorylimit</strong></td><td style="width:500px;">the total memory (in MB) the account can own</td> +</tr> +<tr> +<td style="width:200px;"><strong>memorytotal</strong></td><td style="width:500px;">the total memory (in MB) owned by account</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the account</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkavailable</strong></td><td style="width:500px;">the total number of networks available to be created for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkdomain</strong></td><td style="width:500px;">the network domain</td> +</tr> +<tr> +<td style="width:200px;"><strong>networklimit</strong></td><td style="width:500px;">the total number of networks the account can own</td> +</tr> +<tr> +<td style="width:200px;"><strong>networktotal</strong></td><td style="width:500px;">the total number of networks owned by account</td> +</tr> +<tr> +<td style="width:200px;"><strong>primarystorageavailable</strong></td><td style="width:500px;">the total primary storage space (in GiB) available to be used for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>primarystoragelimit</strong></td><td style="width:500px;">the total primary storage space (in GiB) the account can own</td> +</tr> +<tr> +<td style="width:200px;"><strong>primarystoragetotal</strong></td><td style="width:500px;">the total primary storage space (in GiB) owned by account</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectavailable</strong></td><td style="width:500px;">the total number of projects available for administration by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectlimit</strong></td><td style="width:500px;">the total number of projects the account can own</td> +</tr> +<tr> +<td style="width:200px;"><strong>projecttotal</strong></td><td style="width:500px;">the total number of projects being administrated by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>receivedbytes</strong></td><td style="width:500px;">the total number of network traffic bytes received</td> +</tr> +<tr> +<td style="width:200px;"><strong>secondarystorageavailable</strong></td><td style="width:500px;">the total secondary storage space (in GiB) available to be used for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>secondarystoragelimit</strong></td><td style="width:500px;">the total secondary storage space (in GiB) the account can own</td> +</tr> +<tr> +<td style="width:200px;"><strong>secondarystoragetotal</strong></td><td style="width:500px;">the total secondary storage space (in GiB) owned by account</td> +</tr> +<tr> +<td style="width:200px;"><strong>sentbytes</strong></td><td style="width:500px;">the total number of network traffic bytes sent</td> +</tr> +<tr> +<td style="width:200px;"><strong>snapshotavailable</strong></td><td style="width:500px;">the total number of snapshots available for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>snapshotlimit</strong></td><td style="width:500px;">the total number of snapshots which can be stored by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>snapshottotal</strong></td><td style="width:500px;">the total number of snapshots stored by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the account</td> +</tr> +<tr> +<td style="width:200px;"><strong>templateavailable</strong></td><td style="width:500px;">the total number of templates available to be created by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatelimit</strong></td><td style="width:500px;">the total number of templates which can be created by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatetotal</strong></td><td style="width:500px;">the total number of templates which have been created by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmavailable</strong></td><td style="width:500px;">the total number of virtual machines available for this account to acquire</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmlimit</strong></td><td style="width:500px;">the total number of virtual machines that can be deployed by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmrunning</strong></td><td style="width:500px;">the total number of virtual machines running for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmstopped</strong></td><td style="width:500px;">the total number of virtual machines stopped for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmtotal</strong></td><td style="width:500px;">the total number of virtual machines deployed by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>volumeavailable</strong></td><td style="width:500px;">the total volume available for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>volumelimit</strong></td><td style="width:500px;">the total volume which can be used by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>volumetotal</strong></td><td style="width:500px;">the total volume being used by this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>vpcavailable</strong></td><td style="width:500px;">the total number of vpcs available to be created for this account</td> +</tr> +<tr> +<td style="width:200px;"><strong>vpclimit</strong></td><td style="width:500px;">the total number of vpcs the account can own</td> +</tr> +<tr> +<td style="width:200px;"><strong>vpctotal</strong></td><td style="width:500px;">the total number of vpcs owned by account</td> +</tr> +<tr> +<td style="width:200px;"><strong>user(*)</strong></td><td style="width:500px;">the list of users associated with account</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the user ID</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account name of the user</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>accountid</strong></td><td style="width:500px;">the account ID of the user</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>accounttype</strong></td><td style="width:500px;">the account type of the user</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>apikey</strong></td><td style="width:500px;">the api key of the user</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>created</strong></td><td style="width:500px;">the date and time the user account was created</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the user</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the user</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>email</strong></td><td style="width:500px;">the user email address</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>firstname</strong></td><td style="width:500px;">the user firstname</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>iscallerchilddomain</strong></td><td style="width:500px;">the boolean value representing if the updating target is in caller's child domain</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>isdefault</strong></td><td style="width:500px;">true if user is default, false otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>lastname</strong></td><td style="width:500px;">the user lastname</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>secretkey</strong></td><td style="width:500px;">the secret key of the user</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>state</strong></td><td style="width:500px;">the user state</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>timezone</strong></td><td style="width:500px;">the timezone user was created in</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>username</strong></td><td style="width:500px;">the user name</td> +</tr> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/enableAutoScaleVmGroup.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/enableAutoScaleVmGroup.html b/content/api/apidocs-4.8/root_admin/enableAutoScaleVmGroup.html new file mode 100644 index 0000000..256602a --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/enableAutoScaleVmGroup.html @@ -0,0 +1,124 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>enableAutoScaleVmGroup</h1> +<p>Enables an AutoScale Vm Group</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>id</strong></td><td style="width:500px;"><strong>the ID of the autoscale group</strong></td><td style="width:180px;"><strong>true</strong></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 autoscale vm group ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account owning the instance group</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the vm profile</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the vm profile</td> +</tr> +<tr> +<td style="width:200px;"><strong>fordisplay</strong></td><td style="width:500px;">is group for display to the regular user</td> +</tr> +<tr> +<td style="width:200px;"><strong>interval</strong></td><td style="width:500px;">the frequency at which the conditions have to be evaluated</td> +</tr> +<tr> +<td style="width:200px;"><strong>lbruleid</strong></td><td style="width:500px;">the load balancer rule ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>maxmembers</strong></td><td style="width:500px;">the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.</td> +</tr> +<tr> +<td style="width:200px;"><strong>minmembers</strong></td><td style="width:500px;">the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the vm profile</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id vm profile</td> +</tr> +<tr> +<td style="width:200px;"><strong>scaledownpolicies</strong></td><td style="width:500px;">list of scaledown autoscale policies</td> +</tr> +<tr> +<td style="width:200px;"><strong>scaleuppolicies</strong></td><td style="width:500px;">list of scaleup autoscale policies</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the current state of the AutoScale Vm Group</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmprofileid</strong></td><td style="width:500px;">the autoscale profile that contains information about the vms in the vm group.</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/enableCiscoNexusVSM.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/enableCiscoNexusVSM.html b/content/api/apidocs-4.8/root_admin/enableCiscoNexusVSM.html new file mode 100644 index 0000000..f78c547 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/enableCiscoNexusVSM.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>enableCiscoNexusVSM</h1> +<p>Enable a Cisco Nexus VSM device</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>id</strong></td><td style="width:500px;"><strong>Id of the Cisco Nexus 1000v VSM device to be enabled</strong></td><td style="width:180px;"><strong>true</strong></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>ipaddress</strong></td><td style="width:500px;">the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmconfigmode</strong></td><td style="width:500px;">The mode of the VSM (standalone/HA)</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmconfigstate</strong></td><td style="width:500px;">The Config State (Primary/Standby) of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmctrlvlanid</strong></td><td style="width:500px;">control vlan id of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdeviceid</strong></td><td style="width:500px;">device id of the Cisco N1KV VSM device</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdevicename</strong></td><td style="width:500px;">device name</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdevicestate</strong></td><td style="width:500px;">device state</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdevicestate</strong></td><td style="width:500px;">The Device State (Enabled/Disabled) of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmdomainid</strong></td><td style="width:500px;">The VSM is a switch supervisor. This is the VSM's switch domain id</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmmgmtvlanid</strong></td><td style="width:500px;">management vlan id of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmpktvlanid</strong></td><td style="width:500px;">packet vlan id of the VSM</td> +</tr> +<tr> +<td style="width:200px;"><strong>vsmstoragevlanid</strong></td><td style="width:500px;">storage vlan id of the VSM</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/enableStaticNat.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/enableStaticNat.html b/content/api/apidocs-4.8/root_admin/enableStaticNat.html new file mode 100644 index 0000000..7b61844 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/enableStaticNat.html @@ -0,0 +1,94 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>enableStaticNat</h1> +<p>Enables static NAT for given IP address</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>ipaddressid</strong></td><td style="width:500px;"><strong>the public IP address ID for which static NAT feature is being enabled</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;"><strong>the ID of the virtual machine for enabling static NAT feature</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>networkid</i></td><td style="width:500px;"><i>The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>vmguestip</i></td><td style="width:500px;"><i>VM guest NIC secondary IP address for the port forwarding rule</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>displaytext</strong></td><td style="width:500px;">any text associated with the success or failure</td> +</tr> +<tr> +<td style="width:200px;"><strong>success</strong></td><td style="width:500px;">true if operation is executed successfully</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/enableStorageMaintenance.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/enableStorageMaintenance.html b/content/api/apidocs-4.8/root_admin/enableStorageMaintenance.html new file mode 100644 index 0000000..30a821c --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/enableStorageMaintenance.html @@ -0,0 +1,154 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>enableStorageMaintenance</h1> +<p>Puts storage pool into maintenance state</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>id</strong></td><td style="width:500px;"><strong>Primary storage ID</strong></td><td style="width:180px;"><strong>true</strong></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>capacityiops</strong></td><td style="width:500px;">IOPS CloudStack can provision from this 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>hypervisor</strong></td><td style="width:500px;">the hypervisor type of the storage pool</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>overprovisionfactor</strong></td><td style="width:500px;">the overprovisionfactor for 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>scope</strong></td><td style="width:500px;">the scope 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>storagecapabilities</strong></td><td style="width:500px;">the storage pool capabilities</td> +</tr> +<tr> +<td style="width:200px;"><strong>suitableformigration</strong></td><td style="width:500px;">true if this pool is suitable to migrate a volume, false otherwise</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="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/enableUser.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/enableUser.html b/content/api/apidocs-4.8/root_admin/enableUser.html new file mode 100644 index 0000000..c7ba53e --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/enableUser.html @@ -0,0 +1,130 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>enableUser</h1> +<p>Enables a user 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;"><strong>id</strong></td><td style="width:500px;"><strong>Enables user by user ID.</strong></td><td style="width:180px;"><strong>true</strong></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 user ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account name of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account ID of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>accounttype</strong></td><td style="width:500px;">the account type of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>apikey</strong></td><td style="width:500px;">the api key of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the user account was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>email</strong></td><td style="width:500px;">the user email address</td> +</tr> +<tr> +<td style="width:200px;"><strong>firstname</strong></td><td style="width:500px;">the user firstname</td> +</tr> +<tr> +<td style="width:200px;"><strong>iscallerchilddomain</strong></td><td style="width:500px;">the boolean value representing if the updating target is in caller's child domain</td> +</tr> +<tr> +<td style="width:200px;"><strong>isdefault</strong></td><td style="width:500px;">true if user is default, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>lastname</strong></td><td style="width:500px;">the user lastname</td> +</tr> +<tr> +<td style="width:200px;"><strong>secretkey</strong></td><td style="width:500px;">the secret key of the user</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the user state</td> +</tr> +<tr> +<td style="width:200px;"><strong>timezone</strong></td><td style="width:500px;">the timezone user was created in</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the user name</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/expungeVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/expungeVirtualMachine.html b/content/api/apidocs-4.8/root_admin/expungeVirtualMachine.html new file mode 100644 index 0000000..08d1646 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/expungeVirtualMachine.html @@ -0,0 +1,85 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>expungeVirtualMachine</h1> +<p>Expunge a virtual machine. Once expunged, it cannot be recoverd.</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>id</strong></td><td style="width:500px;"><strong>The ID of the virtual machine</strong></td><td style="width:180px;"><strong>true</strong></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>displaytext</strong></td><td style="width:500px;">any text associated with the success or failure</td> +</tr> +<tr> +<td style="width:200px;"><strong>success</strong></td><td style="width:500px;">true if operation is executed successfully</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/extractIso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/extractIso.html b/content/api/apidocs-4.8/root_admin/extractIso.html new file mode 100644 index 0000000..d972390 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/extractIso.html @@ -0,0 +1,127 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>extractIso</h1> +<p>Extracts an ISO</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>id</strong></td><td style="width:500px;"><strong>the ID of the ISO file</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>mode</strong></td><td style="width:500px;"><strong>the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>url</i></td><td style="width:500px;"><i>the URL to which the ISO would be extracted</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>the ID of the zone where the ISO is originally located</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 extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account id to which the extracted object belongs</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the time and date the object was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>extractId</strong></td><td style="width:500px;">the upload id of extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>extractMode</strong></td><td style="width:500px;">the mode of extraction - upload or download</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the status of the extraction</td> +</tr> +<tr> +<td style="width:200px;"><strong>storagetype</strong></td><td style="width:500px;">type of the storage</td> +</tr> +<tr> +<td style="width:200px;"><strong>uploadpercentage</strong></td><td style="width:500px;">the percentage of the entity uploaded to the specified location</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;">if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">zone ID the object was extracted from</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">zone name the object was extracted from</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/extractTemplate.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/extractTemplate.html b/content/api/apidocs-4.8/root_admin/extractTemplate.html new file mode 100644 index 0000000..ca78152 --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/extractTemplate.html @@ -0,0 +1,127 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>extractTemplate</h1> +<p>Extracts a template</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>id</strong></td><td style="width:500px;"><strong>the ID of the template</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>mode</strong></td><td style="width:500px;"><strong>the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>url</i></td><td style="width:500px;"><i>the url to which the ISO would be extracted</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>the ID of the zone where the ISO is originally located</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 extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account id to which the extracted object belongs</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the time and date the object was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>extractId</strong></td><td style="width:500px;">the upload id of extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>extractMode</strong></td><td style="width:500px;">the mode of extraction - upload or download</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the status of the extraction</td> +</tr> +<tr> +<td style="width:200px;"><strong>storagetype</strong></td><td style="width:500px;">type of the storage</td> +</tr> +<tr> +<td style="width:200px;"><strong>uploadpercentage</strong></td><td style="width:500px;">the percentage of the entity uploaded to the specified location</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;">if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">zone ID the object was extracted from</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">zone name the object was extracted from</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/79d7c49c/content/api/apidocs-4.8/root_admin/extractVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.8/root_admin/extractVolume.html b/content/api/apidocs-4.8/root_admin/extractVolume.html new file mode 100644 index 0000000..cae3c3f --- /dev/null +++ b/content/api/apidocs-4.8/root_admin/extractVolume.html @@ -0,0 +1,127 @@ +<!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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>extractVolume</h1> +<p>Extracts volume</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>id</strong></td><td style="width:500px;"><strong>the ID of the volume</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>mode</strong></td><td style="width:500px;"><strong>the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;"><strong>the ID of the zone where the volume is located</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>url</i></td><td style="width:500px;"><i>the url to which the volume would be extracted</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 extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account id to which the extracted object belongs</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the time and date the object was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>extractId</strong></td><td style="width:500px;">the upload id of extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>extractMode</strong></td><td style="width:500px;">the mode of extraction - upload or download</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the extracted object</td> +</tr> +<tr> +<td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the status of the extraction</td> +</tr> +<tr> +<td style="width:200px;"><strong>storagetype</strong></td><td style="width:500px;">type of the storage</td> +</tr> +<tr> +<td style="width:200px;"><strong>uploadpercentage</strong></td><td style="width:500px;">the percentage of the entity uploaded to the specified location</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;">if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">zone ID the object was extracted from</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">zone name the object was extracted from</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html>
