http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/root_admin/createVolume.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createVolume.html b/source/api/apidocs-4.8/root_admin/createVolume.html new file mode 100644 index 0000000..b097bff --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createVolume.html @@ -0,0 +1,304 @@ +<!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>createVolume</h1> +<p>Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Root_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the account associated with the disk volume. Must be used with the domainId parameter.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>customid</i></td><td style="width:500px;"><i>an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>diskofferingid</i></td><td style="width:500px;"><i>the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>displayvolume</i></td><td style="width:500px;"><i>an optional field, whether to display the volume to the end user or not.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>maxiops</i></td><td style="width:500px;"><i>max iops</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>miniops</i></td><td style="width:500px;"><i>min iops</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 disk volume</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>the project associated with the volume. Mutually exclusive with account parameter</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>size</i></td><td style="width:500px;"><i>Arbitrary volume size</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>snapshotid</i></td><td style="width:500px;"><i>the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.</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; to be used with snapshot Id, VM to which the volume gets attached after creation</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>the ID of the availability zone</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">ID of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>attached</strong></td><td style="width:500px;">the date the volume was attached to a VM instance</td> +</tr> +<tr> +<td style="width:200px;"><strong>chaininfo</strong></td><td style="width:500px;">the chain info of the volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date the disk volume was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>destroyed</strong></td><td style="width:500px;">the boolean state of whether the volume is destroyed or not</td> +</tr> +<tr> +<td style="width:200px;"><strong>deviceid</strong></td><td style="width:500px;">the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskBytesReadRate</strong></td><td style="width:500px;">bytes read rate of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskBytesWriteRate</strong></td><td style="width:500px;">bytes write rate of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskIopsReadRate</strong></td><td style="width:500px;">io requests read rate of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskIopsWriteRate</strong></td><td style="width:500px;">io requests write rate of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskofferingdisplaytext</strong></td><td style="width:500px;">the display text of the disk offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskofferingid</strong></td><td style="width:500px;">ID of the disk offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskofferingname</strong></td><td style="width:500px;">name of the disk offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>displayvolume</strong></td><td style="width:500px;">an optional field whether to the display the volume to the end user or not.</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">Hypervisor the volume belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>isextractable</strong></td><td style="width:500px;">true if the volume is extractable, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>isodisplaytext</strong></td><td style="width:500px;">an alternate display text of the ISO attached to the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>isoid</strong></td><td style="width:500px;">the ID of the ISO attached to the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>isoname</strong></td><td style="width:500px;">the name of the ISO attached to the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>maxiops</strong></td><td style="width:500px;">max iops of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>miniops</strong></td><td style="width:500px;">min iops of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">name of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>path</strong></td><td style="width:500px;">the path of the volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the vpn</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the vpn</td> +</tr> +<tr> +<td style="width:200px;"><strong>provisioningtype</strong></td><td style="width:500px;">provisioning type used to create volumes.</td> +</tr> +<tr> +<td style="width:200px;"><strong>quiescevm</strong></td><td style="width:500px;">need quiesce vm or not when taking snapshot</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingdisplaytext</strong></td><td style="width:500px;">the display text of the service offering for root disk</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;">ID of the service offering for root disk</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingname</strong></td><td style="width:500px;">name of the service offering for root disk</td> +</tr> +<tr> +<td style="width:200px;"><strong>size</strong></td><td style="width:500px;">size of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>snapshotid</strong></td><td style="width:500px;">ID of the snapshot from which this volume was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the status of the volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>storage</strong></td><td style="width:500px;">name of the primary storage hosting the disk volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>storageid</strong></td><td style="width:500px;">id of the primary storage hosting the disk volume; returned to admin user only</td> +</tr> +<tr> +<td style="width:200px;"><strong>storagetype</strong></td><td style="width:500px;">shared or local storage</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatedisplaytext</strong></td><td style="width:500px;"> an alternate display text of the template for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>templateid</strong></td><td style="width:500px;">the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatename</strong></td><td style="width:500px;">the name of the template for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">type of the disk volume (ROOT or DATADISK)</td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;">id of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmdisplayname</strong></td><td style="width:500px;">display name of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmname</strong></td><td style="width:500px;">name of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmstate</strong></td><td style="width:500px;">state of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">ID of the availability zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">name of the availability zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with volume</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="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/51c4e97e/source/api/apidocs-4.8/root_admin/createVolumeOnFiler.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createVolumeOnFiler.html b/source/api/apidocs-4.8/root_admin/createVolumeOnFiler.html new file mode 100644 index 0000000..4a9ef87 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createVolumeOnFiler.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>createVolumeOnFiler</h1> +<p>Create a 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>aggregatename</strong></td><td style="width:500px;"><strong>aggregate name.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;"><strong>ip address.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>password</strong></td><td style="width:500px;"><strong>password.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>poolname</strong></td><td style="width:500px;"><strong>pool name.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>size</strong></td><td style="width:500px;"><strong>volume size.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;"><strong>user name.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>volumename</strong></td><td style="width:500px;"><strong>volume name.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>snapshotpolicy</i></td><td style="width:500px;"><i>snapshot policy.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>snapshotreservation</i></td><td style="width:500px;"><i>snapshot reservation.</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> +</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/51c4e97e/source/api/apidocs-4.8/root_admin/createVpnConnection.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createVpnConnection.html b/source/api/apidocs-4.8/root_admin/createVpnConnection.html new file mode 100644 index 0000000..e81deeb --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createVpnConnection.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>createVpnConnection</h1> +<p>Create site to site vpn connection</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>s2scustomergatewayid</strong></td><td style="width:500px;"><strong>id of the customer gateway</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>s2svpngatewayid</strong></td><td style="width:500px;"><strong>id of the vpn gateway</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>fordisplay</i></td><td style="width:500px;"><i>an optional field, whether to the display the vpn to the end user or not</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>passive</i></td><td style="width:500px;"><i>connection is passive or not</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 connection ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>cidrlist</strong></td><td style="width:500px;">guest cidr list of the customer gateway</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>domain</strong></td><td style="width:500px;">the domain name of the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain id of the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>dpd</strong></td><td style="width:500px;">if DPD is enabled for customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>esplifetime</strong></td><td style="width:500px;">Lifetime of ESP SA of customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>esppolicy</strong></td><td style="width:500px;">ESP policy of the customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>forceencap</strong></td><td style="width:500px;">if Force NAT Encapsulation is enabled for customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>fordisplay</strong></td><td style="width:500px;">is connection for display to the regular user</td> +</tr> +<tr> +<td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">public ip address id of the customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>ikelifetime</strong></td><td style="width:500px;">Lifetime of IKE SA of customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>ikepolicy</strong></td><td style="width:500px;">IKE policy of the customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipsecpsk</strong></td><td style="width:500px;">IPsec Preshared-Key of the customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>passive</strong></td><td style="width:500px;">State of vpn connection</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicip</strong></td><td style="width:500px;">the public IP address</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>s2scustomergatewayid</strong></td><td style="width:500px;">the customer gateway ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>s2svpngatewayid</strong></td><td style="width:500px;">the vpn gateway ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">State of vpn connection</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/51c4e97e/source/api/apidocs-4.8/root_admin/createVpnCustomerGateway.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createVpnCustomerGateway.html b/source/api/apidocs-4.8/root_admin/createVpnCustomerGateway.html new file mode 100644 index 0000000..475b042 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createVpnCustomerGateway.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>createVpnCustomerGateway</h1> +<p>Creates site to site vpn customer gateway</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>cidrlist</strong></td><td style="width:500px;"><strong>guest cidr list of the customer gateway</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>esppolicy</strong></td><td style="width:500px;"><strong>ESP policy of the customer gateway</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;"><strong>public ip address id of the customer gateway</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>ikepolicy</strong></td><td style="width:500px;"><strong>IKE policy of the customer gateway</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>ipsecpsk</strong></td><td style="width:500px;"><strong>IPsec Preshared-Key of the customer gateway</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the account associated with the gateway. Must be used with the domainId parameter.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>dpd</i></td><td style="width:500px;"><i>If DPD is enabled for VPN connection</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>esplifetime</i></td><td style="width:500px;"><i>Lifetime of phase 2 VPN connection to the customer gateway, in seconds</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>forceencap</i></td><td style="width:500px;"><i>Force Encapsulation for NAT traversal</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>ikelifetime</i></td><td style="width:500px;"><i>Lifetime of phase 1 VPN connection to the customer gateway, in seconds</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 this customer gateway</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>create site-to-site VPN customer gateway for the 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>id</strong></td><td style="width:500px;">the vpn gateway ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>cidrlist</strong></td><td style="width:500px;">guest cidr list of the customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain id of the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>dpd</strong></td><td style="width:500px;">if DPD is enabled for customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>esplifetime</strong></td><td style="width:500px;">Lifetime of ESP SA of customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>esppolicy</strong></td><td style="width:500px;">IPsec policy of customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>forceencap</strong></td><td style="width:500px;">if Force NAT Encapsulation is enabled for customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">public ip address id of the customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>ikelifetime</strong></td><td style="width:500px;">Lifetime of IKE SA of customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>ikepolicy</strong></td><td style="width:500px;">IKE policy of customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">guest ip of the customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipsecpsk</strong></td><td style="width:500px;">IPsec preshared-key of customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">name of the customer gateway</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id</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> +</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/51c4e97e/source/api/apidocs-4.8/root_admin/createVpnGateway.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createVpnGateway.html b/source/api/apidocs-4.8/root_admin/createVpnGateway.html new file mode 100644 index 0000000..8a8e52b --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createVpnGateway.html @@ -0,0 +1,112 @@ +<!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>createVpnGateway</h1> +<p>Creates site to site vpn local gateway</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>vpcid</strong></td><td style="width:500px;"><strong>public ip address id of the vpn gateway</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>fordisplay</i></td><td style="width:500px;"><i>an optional field, whether to the display the vpn to the end user or not</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 vpn gateway ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain id of the owner</td> +</tr> +<tr> +<td style="width:200px;"><strong>fordisplay</strong></td><td style="width:500px;">is vpn gateway for display to the regular user</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicip</strong></td><td style="width:500px;">the public IP address</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>vpcid</strong></td><td style="width:500px;">the vpc id of this gateway</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/51c4e97e/source/api/apidocs-4.8/root_admin/createZone.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/createZone.html b/source/api/apidocs-4.8/root_admin/createZone.html new file mode 100644 index 0000000..ecffa06 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/createZone.html @@ -0,0 +1,247 @@ +<!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>createZone</h1> +<p>Creates a Zone.</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>dns1</strong></td><td style="width:500px;"><strong>the first DNS for the Zone</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>internaldns1</strong></td><td style="width:500px;"><strong>the first internal DNS for the Zone</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;"><strong>the name of the Zone</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>networktype</strong></td><td style="width:500px;"><strong>network type of the zone, can be Basic or Advanced</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>allocationstate</i></td><td style="width:500px;"><i>Allocation state of this Zone for allocation of new resources</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>dns2</i></td><td style="width:500px;"><i>the second DNS for the Zone</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>domain</i></td><td style="width:500px;"><i>Network domain name for the networks in the zone</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>the ID of the containing domain, null for public zones</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>guestcidraddress</i></td><td style="width:500px;"><i>the guest CIDR address for the Zone</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>internaldns2</i></td><td style="width:500px;"><i>the second internal DNS for the Zone</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>ip6dns1</i></td><td style="width:500px;"><i>the first DNS for IPv6 network in the Zone</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>ip6dns2</i></td><td style="width:500px;"><i>the second DNS for IPv6 network in the Zone</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>localstorageenabled</i></td><td style="width:500px;"><i>true if local storage offering enabled, false otherwise</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>securitygroupenabled</i></td><td style="width:500px;"><i>true if network is security group enabled, false otherwise</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;">Zone id</td> +</tr> +<tr> +<td style="width:200px;"><strong>allocationstate</strong></td><td style="width:500px;">the allocation state of the cluster</td> +</tr> +<tr> +<td style="width:200px;"><strong>description</strong></td><td style="width:500px;">Zone description</td> +</tr> +<tr> +<td style="width:200px;"><strong>dhcpprovider</strong></td><td style="width:500px;">the dhcp Provider for the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">the display text of the zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>dns1</strong></td><td style="width:500px;">the first DNS for the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>dns2</strong></td><td style="width:500px;">the second DNS for the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">Network domain name for the networks in the zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the UUID of the containing domain, null for public zones</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainname</strong></td><td style="width:500px;">the name of the containing domain, null for public zones</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestcidraddress</strong></td><td style="width:500px;">the guest CIDR address for the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>internaldns1</strong></td><td style="width:500px;">the first internal DNS for the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>internaldns2</strong></td><td style="width:500px;">the second internal DNS for the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>ip6dns1</strong></td><td style="width:500px;">the first IPv6 DNS for the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>ip6dns2</strong></td><td style="width:500px;">the second IPv6 DNS for the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>localstorageenabled</strong></td><td style="width:500px;">true if local storage offering enabled, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">Zone name</td> +</tr> +<tr> +<td style="width:200px;"><strong>networktype</strong></td><td style="width:500px;">the network type of the zone; can be Basic or Advanced</td> +</tr> +<tr> +<td style="width:200px;"><strong>resourcedetails</strong></td><td style="width:500px;">Meta data associated with the zone (key/value pairs)</td> +</tr> +<tr> +<td style="width:200px;"><strong>securitygroupsenabled</strong></td><td style="width:500px;">true if security groups support is enabled, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonetoken</strong></td><td style="width:500px;">Zone Token</td> +</tr> +<tr> +<td style="width:200px;"><strong>capacity(*)</strong></td><td style="width:500px;">the capacity of the Zone</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>capacitytotal</strong></td><td style="width:500px;">the total capacity available</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>capacityused</strong></td><td style="width:500px;">the capacity currently in use</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>clusterid</strong></td><td style="width:500px;">the Cluster ID</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>clustername</strong></td><td style="width:500px;">the Cluster name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>percentused</strong></td><td style="width:500px;">the percentage of capacity currently in use</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>podname</strong></td><td style="width:500px;">the Pod name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>type</strong></td><td style="width:500px;">the capacity type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with zone.</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="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/51c4e97e/source/api/apidocs-4.8/root_admin/dedicateCluster.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/dedicateCluster.html b/source/api/apidocs-4.8/root_admin/dedicateCluster.html new file mode 100644 index 0000000..0d7cc70 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/dedicateCluster.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>dedicateCluster</h1> +<p>Dedicate an existing cluster</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>clusterid</strong></td><td style="width:500px;"><strong>the ID of the Cluster</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;"><strong>the ID of the containing domain</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the name of the account which needs dedication. Must be used with domainId.</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 dedicated resource</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the Account ID of the cluster</td> +</tr> +<tr> +<td style="width:200px;"><strong>affinitygroupid</strong></td><td style="width:500px;">the Dedication Affinity Group ID of the cluster</td> +</tr> +<tr> +<td style="width:200px;"><strong>clusterid</strong></td><td style="width:500px;">the ID of the cluster</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustername</strong></td><td style="width:500px;">the name of the cluster</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the cluster</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/51c4e97e/source/api/apidocs-4.8/root_admin/dedicateGuestVlanRange.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/dedicateGuestVlanRange.html b/source/api/apidocs-4.8/root_admin/dedicateGuestVlanRange.html new file mode 100644 index 0000000..c1cdaf4 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/dedicateGuestVlanRange.html @@ -0,0 +1,118 @@ +<!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>dedicateGuestVlanRange</h1> +<p>Dedicates a guest vlan range to 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;"><strong>account</strong></td><td style="width:500px;"><strong>account who will own the VLAN</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;"><strong>domain ID of the account owning a VLAN</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;"><strong>physical network ID of the vlan</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>vlanrange</strong></td><td style="width:500px;"><strong>guest vlan range to be dedicated</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>projectid</i></td><td style="width:500px;"><i>project who will own the VLAN</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</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 guest VLAN range</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account of the guest VLAN range</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the guest VLAN range</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the guest VLAN range</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestvlanrange</strong></td><td style="width:500px;">the guest VLAN range</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network of the guest vlan range</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the guest vlan range</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the guest vlan range</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the zone of the guest vlan range</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/51c4e97e/source/api/apidocs-4.8/root_admin/dedicateHost.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/dedicateHost.html b/source/api/apidocs-4.8/root_admin/dedicateHost.html new file mode 100644 index 0000000..26c0674 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/dedicateHost.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>dedicateHost</h1> +<p>Dedicates a host.</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>domainid</strong></td><td style="width:500px;"><strong>the ID of the containing domain</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;"><strong>the ID of the host to update</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the name of the account which needs dedication. Must be used with domainId.</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 dedicated resource</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the Account ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>affinitygroupid</strong></td><td style="width:500px;">the Dedication Affinity Group ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the name of the host</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/51c4e97e/source/api/apidocs-4.8/root_admin/dedicatePod.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/dedicatePod.html b/source/api/apidocs-4.8/root_admin/dedicatePod.html new file mode 100644 index 0000000..03f00ef --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/dedicatePod.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>dedicatePod</h1> +<p>Dedicates a Pod.</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>domainid</strong></td><td style="width:500px;"><strong>the ID of the containing domain</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;"><strong>the ID of the Pod</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the name of the account which needs dedication. Must be used with domainId.</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 dedicated resource</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the Account Id to which the Pod is dedicated</td> +</tr> +<tr> +<td style="width:200px;"><strong>affinitygroupid</strong></td><td style="width:500px;">the Dedication Affinity Group ID of the pod</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID to which the Pod is dedicated</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the ID of the Pod</td> +</tr> +<tr> +<td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">the Name of the Pod</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/51c4e97e/source/api/apidocs-4.8/root_admin/dedicatePublicIpRange.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/dedicatePublicIpRange.html b/source/api/apidocs-4.8/root_admin/dedicatePublicIpRange.html new file mode 100644 index 0000000..58e5862 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/dedicatePublicIpRange.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>dedicatePublicIpRange</h1> +<p>Dedicates a Public IP range to 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;"><strong>id</strong></td><td style="width:500px;"><strong>the id of the VLAN IP range</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;"><strong>domain ID of the account owning a VLAN</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>account who will own the VLAN</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>projectid</i></td><td style="width:500px;"><i>project who will own the VLAN</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>description</strong></td><td style="width:500px;">the description of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>endip</strong></td><td style="width:500px;">the end ip of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>endipv6</strong></td><td style="width:500px;">the end ipv6 of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>forvirtualnetwork</strong></td><td style="width:500px;">the virtual network for the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">the gateway of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>ip6cidr</strong></td><td style="width:500px;">the cidr of IPv6 network</td> +</tr> +<tr> +<td style="width:200px;"><strong>ip6gateway</strong></td><td style="width:500px;">the gateway of IPv6 network</td> +</tr> +<tr> +<td style="width:200px;"><strong>netmask</strong></td><td style="width:500px;">the netmask of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkid</strong></td><td style="width:500px;">the network id of vlan range</td> +</tr> +<tr> +<td style="width:200px;"><strong>physicalnetworkid</strong></td><td style="width:500px;">the physical network this belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID for the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">the Pod name for the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the vlan range</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the vlan range</td> +</tr> +<tr> +<td style="width:200px;"><strong>startip</strong></td><td style="width:500px;">the start ip of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>startipv6</strong></td><td style="width:500px;">the start ipv6 of the VLAN IP range</td> +</tr> +<tr> +<td style="width:200px;"><strong>vlan</strong></td><td style="width:500px;">the ID or VID of the VLAN.</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the VLAN IP range</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="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/51c4e97e/source/api/apidocs-4.8/root_admin/dedicateZone.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/dedicateZone.html b/source/api/apidocs-4.8/root_admin/dedicateZone.html new file mode 100644 index 0000000..b22f99e --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/dedicateZone.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 v4.8.0 Root Admin API Reference + </span> +<p></p> +<h1>dedicateZone</h1> +<p>Dedicates a zones.</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>domainid</strong></td><td style="width:500px;"><strong>the ID of the containing domain</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</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>the name of the account which needs dedication. Must be used with domainId.</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 dedicated resource</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the Account Id to which the Zone is dedicated</td> +</tr> +<tr> +<td style="width:200px;"><strong>affinitygroupid</strong></td><td style="width:500px;">the Dedication Affinity Group ID of the zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID to which the Zone is dedicated</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the ID of the Zone</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Name of the Zone</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/51c4e97e/source/api/apidocs-4.8/root_admin/deleteAccount.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/deleteAccount.html b/source/api/apidocs-4.8/root_admin/deleteAccount.html new file mode 100644 index 0000000..d0f5a51 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/deleteAccount.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>deleteAccount</h1> +<p>Deletes a account, and all users associated with this 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>Account 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>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/51c4e97e/source/api/apidocs-4.8/root_admin/deleteAccountFromProject.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/root_admin/deleteAccountFromProject.html b/source/api/apidocs-4.8/root_admin/deleteAccountFromProject.html new file mode 100644 index 0000000..15cee15 --- /dev/null +++ b/source/api/apidocs-4.8/root_admin/deleteAccountFromProject.html @@ -0,0 +1,88 @@ +<!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>deleteAccountFromProject</h1> +<p>Deletes account from the project</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>account</strong></td><td style="width:500px;"><strong>name of the account to be removed from the project</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;"><strong>ID of the project to remove the account from</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>
