http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/getVMPassword.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/getVMPassword.html b/content/api/apidocs-4.9/apis/getVMPassword.html new file mode 100644 index 0000000..8864081 --- /dev/null +++ b/content/api/apidocs-4.9/apis/getVMPassword.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>getVMPassword</h1> +<p>Returns an encrypted password for the VM</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><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>encryptedpassword</strong></td><td style="width:500px;">The base64 encoded encrypted password of the VM</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/getVirtualMachineUserData.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/getVirtualMachineUserData.html b/content/api/apidocs-4.9/apis/getVirtualMachineUserData.html new file mode 100644 index 0000000..09be978 --- /dev/null +++ b/content/api/apidocs-4.9/apis/getVirtualMachineUserData.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>getVirtualMachineUserData</h1> +<p>Returns user data associated with the VM</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineid</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>userdata</strong></td><td style="width:500px;">Base 64 encoded VM user data</td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;">the ID of the virtual machine</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/getVolumeSnapshotDetails.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/getVolumeSnapshotDetails.html b/content/api/apidocs-4.9/apis/getVolumeSnapshotDetails.html new file mode 100644 index 0000000..154650c --- /dev/null +++ b/content/api/apidocs-4.9/apis/getVolumeSnapshotDetails.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>getVolumeSnapshotDetails</h1> +<p>Get Volume Snapshot Details</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>snapshotid</strong></td><td style="width:500px;"><strong>CloudStack Snapshot UUID</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>volumeiScsiName</strong></td><td style="width:500px;">Volume iSCSI 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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/getVolumeiScsiName.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/getVolumeiScsiName.html b/content/api/apidocs-4.9/apis/getVolumeiScsiName.html new file mode 100644 index 0000000..3d343c0 --- /dev/null +++ b/content/api/apidocs-4.9/apis/getVolumeiScsiName.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>getVolumeiScsiName</h1> +<p>Get Volume's iSCSI Name</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>volumeid</strong></td><td style="width:500px;"><strong>CloudStack Volume UUID</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>volumeiScsiName</strong></td><td style="width:500px;">Volume iSCSI 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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/importLdapUsers.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/importLdapUsers.html b/content/api/apidocs-4.9/apis/importLdapUsers.html new file mode 100644 index 0000000..680ea00 --- /dev/null +++ b/content/api/apidocs-4.9/apis/importLdapUsers.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>importLdapUsers</h1> +<p>Import LDAP users</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>Creates the user under the specified account. If no account is specified, the username will be used as the account name.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>accountdetails</i></td><td style="width:500px;"><i>details for account used to store specific parameters</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>accounttype</i></td><td style="width:500px;"><i>Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin</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>Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>group</i></td><td style="width:500px;"><i>Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>roleid</i></td><td style="width:500px;"><i>Creates the account under the specified role.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>timezone</i></td><td style="width:500px;"><i>Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.</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>domain</strong></td><td style="width:500px;">The user's domain</td> +</tr> +<tr> +<td style="width:200px;"><strong>email</strong></td><td style="width:500px;">The user's email</td> +</tr> +<tr> +<td style="width:200px;"><strong>firstname</strong></td><td style="width:500px;">The user's firstname</td> +</tr> +<tr> +<td style="width:200px;"><strong>lastname</strong></td><td style="width:500px;">The user's lastname</td> +</tr> +<tr> +<td style="width:200px;"><strong>principal</strong></td><td style="width:500px;">The user's principle</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">The user's username</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/issueOutOfBandManagementPowerAction.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/issueOutOfBandManagementPowerAction.html b/content/api/apidocs-4.9/apis/issueOutOfBandManagementPowerAction.html new file mode 100644 index 0000000..954b4c9 --- /dev/null +++ b/content/api/apidocs-4.9/apis/issueOutOfBandManagementPowerAction.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>issueOutOfBandManagementPowerAction</h1> +<p>Initiates the specified power action to the host's out-of-band management interface</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>action</strong></td><td style="width:500px;"><strong>out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS</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</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>timeout</i></td><td style="width:500px;"><i>optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting</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>action</strong></td><td style="width:500px;">the out-of-band management action (if issued)</td> +</tr> +<tr> +<td style="width:200px;"><strong>address</strong></td><td style="width:500px;">the out-of-band management interface address</td> +</tr> +<tr> +<td style="width:200px;"><strong>description</strong></td><td style="width:500px;">the operation result description</td> +</tr> +<tr> +<td style="width:200px;"><strong>driver</strong></td><td style="width:500px;">the out-of-band management driver for the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>enabled</strong></td><td style="width:500px;">true if out-of-band management is enabled for 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>password</strong></td><td style="width:500px;">the out-of-band management interface password</td> +</tr> +<tr> +<td style="width:200px;"><strong>port</strong></td><td style="width:500px;">the out-of-band management interface port</td> +</tr> +<tr> +<td style="width:200px;"><strong>powerstate</strong></td><td style="width:500px;">the out-of-band management interface powerState of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the operation result</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the out-of-band management interface username</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/ldapConfig.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/ldapConfig.html b/content/api/apidocs-4.9/apis/ldapConfig.html new file mode 100644 index 0000000..b3ba357 --- /dev/null +++ b/content/api/apidocs-4.9/apis/ldapConfig.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>ldapConfig</h1> +<p>Configure the LDAP context for this site.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>binddn</i></td><td style="width:500px;"><i>Specify the distinguished name of a user with the search permission on the directory.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>bindpass</i></td><td style="width:500px;"><i>Enter the password.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>hostname</i></td><td style="width:500px;"><i>Hostname or ip address of the ldap server eg: my.ldap.com</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>If true return current LDAP configuration</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>port</i></td><td style="width:500px;"><i>Specify the LDAP port if required, default is 389.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>queryfilter</i></td><td style="width:500px;"><i>You specify a query filter here, which narrows down the users, who can be part of this domain.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>searchbase</i></td><td style="width:500px;"><i>The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>ssl</i></td><td style="width:500px;"><i>Check Use SSL if the external LDAP server is configured for LDAP over SSL.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>truststore</i></td><td style="width:500px;"><i>Enter the path to trust certificates store.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>truststorepass</i></td><td style="width:500px;"><i>Enter the password for trust store.</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>binddn</strong></td><td style="width:500px;">Specify the distinguished name of a user with the search permission on the directory</td> +</tr> +<tr> +<td style="width:200px;"><strong>bindpass</strong></td><td style="width:500px;">DN password</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">Hostname or ip address of the ldap server eg: my.ldap.com</td> +</tr> +<tr> +<td style="width:200px;"><strong>port</strong></td><td style="width:500px;">Specify the LDAP port if required, default is 389</td> +</tr> +<tr> +<td style="width:200px;"><strong>queryfilter</strong></td><td style="width:500px;">You specify a query filter here, which narrows down the users, who can be part of this domain</td> +</tr> +<tr> +<td style="width:200px;"><strong>searchbase</strong></td><td style="width:500px;">The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com</td> +</tr> +<tr> +<td style="width:200px;"><strong>ssl</strong></td><td style="width:500px;">Check Use SSL if the external LDAP server is configured for LDAP over SSL</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/ldapCreateAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/ldapCreateAccount.html b/content/api/apidocs-4.9/apis/ldapCreateAccount.html new file mode 100644 index 0000000..8d78d53 --- /dev/null +++ b/content/api/apidocs-4.9/apis/ldapCreateAccount.html @@ -0,0 +1,334 @@ +<!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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>ldapCreateAccount</h1> +<p>Creates an account from an LDAP user</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;"><strong>Unique username.</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>Creates the user under the specified account. If no account is specified, the username will be used as the account name.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>accountdetails</i></td><td style="width:500px;"><i>details for account used to store specific parameters</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>accountid</i></td><td style="width:500px;"><i>Account UUID, required for adding account from external provisioning system</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>accounttype</i></td><td style="width:500px;"><i>Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin</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>Creates the user under the specified domain.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>networkdomain</i></td><td style="width:500px;"><i>Network domain for the account's networks</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>roleid</i></td><td style="width:500px;"><i>Creates the account under the specified role.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>timezone</i></td><td style="width:500px;"><i>Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>userid</i></td><td style="width:500px;"><i>User UUID, required for adding account from external provisioning system</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>roleid</strong></td><td style="width:500px;">the ID of the role</td> +</tr> +<tr> +<td style="width:200px;"><strong>rolename</strong></td><td style="width:500px;">the name of the role</td> +</tr> +<tr> +<td style="width:200px;"><strong>roletype</strong></td><td style="width:500px;">the type of the role (Admin, ResourceAdmin, DomainAdmin, User)</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>roleid</strong></td><td style="width:500px;">the ID of the role</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>rolename</strong></td><td style="width:500px;">the name of the role</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>roletype</strong></td><td style="width:500px;">the type of the role</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/ldapRemove.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/ldapRemove.html b/content/api/apidocs-4.9/apis/ldapRemove.html new file mode 100644 index 0000000..7cf7269 --- /dev/null +++ b/content/api/apidocs-4.9/apis/ldapRemove.html @@ -0,0 +1,97 @@ +<!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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>ldapRemove</h1> +<p>Remove the LDAP context for this site.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +</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>binddn</strong></td><td style="width:500px;">Specify the distinguished name of a user with the search permission on the directory</td> +</tr> +<tr> +<td style="width:200px;"><strong>bindpass</strong></td><td style="width:500px;">DN password</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">Hostname or ip address of the ldap server eg: my.ldap.com</td> +</tr> +<tr> +<td style="width:200px;"><strong>port</strong></td><td style="width:500px;">Specify the LDAP port if required, default is 389</td> +</tr> +<tr> +<td style="width:200px;"><strong>queryfilter</strong></td><td style="width:500px;">You specify a query filter here, which narrows down the users, who can be part of this domain</td> +</tr> +<tr> +<td style="width:200px;"><strong>searchbase</strong></td><td style="width:500px;">The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com</td> +</tr> +<tr> +<td style="width:200px;"><strong>ssl</strong></td><td style="width:500px;">Check Use SSL if the external LDAP server is configured for LDAP over SSL</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/linkDomainToLdap.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/linkDomainToLdap.html b/content/api/apidocs-4.9/apis/linkDomainToLdap.html new file mode 100644 index 0000000..c8733f5 --- /dev/null +++ b/content/api/apidocs-4.9/apis/linkDomainToLdap.html @@ -0,0 +1,106 @@ +<!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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>linkDomainToLdap</h1> +<p>link an existing cloudstack domain to group or OU in ldap</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>accounttype</strong></td><td style="width:500px;"><strong>Type of the account to auto import. Specify 0 for user and 2 for domain admin</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 domain which has to be linked to LDAP.</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>name of the group or OU in LDAP</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;"><strong>type of the ldap name. GROUP or OU</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>admin</i></td><td style="width:500px;"><i>domain admin username in LDAP </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>accountid</strong></td><td style="width:500px;">Domain Admin accountId that is created</td> +</tr> +<tr> +<td style="width:200px;"><strong>accounttype</strong></td><td style="width:500px;">Type of the account to auto import</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">id of the Domain which is linked to LDAP</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">name of the group or OU in LDAP which is linked to the domain</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">type of the name in LDAP which is linke to the domain</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listAccounts.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listAccounts.html b/content/api/apidocs-4.9/apis/listAccounts.html new file mode 100644 index 0000000..c337fbf --- /dev/null +++ b/content/api/apidocs-4.9/apis/listAccounts.html @@ -0,0 +1,337 @@ +<!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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listAccounts</h1> +<p>Lists accounts and provides detailed account information for listed accounts</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>accounttype</i></td><td style="width:500px;"><i>list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>list only resources belonging to the domain specified</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>list account by account ID</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>iscleanuprequired</i></td><td style="width:500px;"><i>list accounts by cleanuprequired attribute (values are true or false)</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>list account by account name</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>state</i></td><td style="width:500px;"><i>list accounts by state. Valid states are enabled, disabled, and locked.</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>roleid</strong></td><td style="width:500px;">the ID of the role</td> +</tr> +<tr> +<td style="width:200px;"><strong>rolename</strong></td><td style="width:500px;">the name of the role</td> +</tr> +<tr> +<td style="width:200px;"><strong>roletype</strong></td><td style="width:500px;">the type of the role (Admin, ResourceAdmin, DomainAdmin, User)</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>roleid</strong></td><td style="width:500px;">the ID of the role</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>rolename</strong></td><td style="width:500px;">the name of the role</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>roletype</strong></td><td style="width:500px;">the type of the role</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listAffinityGroupTypes.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listAffinityGroupTypes.html b/content/api/apidocs-4.9/apis/listAffinityGroupTypes.html new file mode 100644 index 0000000..cb4f723 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listAffinityGroupTypes.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listAffinityGroupTypes</h1> +<p>Lists affinity group types available</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">the type of the affinity 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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listAffinityGroups.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listAffinityGroups.html b/content/api/apidocs-4.9/apis/listAffinityGroups.html new file mode 100644 index 0000000..6c66a01 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listAffinityGroups.html @@ -0,0 +1,142 @@ +<!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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listAffinityGroups</h1> +<p>Lists affinity groups</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>list resources by account. Must be used with the domainId parameter.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>list only resources belonging to the domain specified</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>list the affinity group by the ID provided</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>lists affinity groups by name</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>projectid</i></td><td style="width:500px;"><i>list objects by project</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>type</i></td><td style="width:500px;"><i>lists affinity groups by type</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>virtualmachineid</i></td><td style="width:500px;"><i>lists affinity groups by virtual machine ID</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account owning the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>description</strong></td><td style="width:500px;">the description of the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project ID of the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">the type of the affinity group</td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineIds</strong></td><td style="width:500px;">virtual machine IDs associated with this affinity 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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listAlerts.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listAlerts.html b/content/api/apidocs-4.9/apis/listAlerts.html new file mode 100644 index 0000000..d3bbd23 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listAlerts.html @@ -0,0 +1,109 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listAlerts</h1> +<p>Lists all alerts.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../index.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>the ID of the alert</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>list by alert name</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>type</i></td><td style="width:500px;"><i>list by alert type</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 alert</td> +</tr> +<tr> +<td style="width:200px;"><strong>description</strong></td><td style="width:500px;">description of the alert</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the alert</td> +</tr> +<tr> +<td style="width:200px;"><strong>sent</strong></td><td style="width:500px;">the date and time the alert was sent</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, HOST = 6, USERVM = 7, DOMAIN_ROUTER = 8, CONSOLE_PROXY = 9, ROUTING = 10: lost connection to default route (to the gateway), STORAGE_MISC = 11: lost connection to default route (to the gateway), USAGE_SERVER = 12: lost connection to default route (to the gateway), MANAGMENT_NODE = 13: lost connection to default route (to the gateway), DOMAIN_ROUTER_MIGRATE = 14, CONSOLE_PROXY_MIGRATE = 15, USERVM_MIGRATE = 16, VLAN = 17, SSVM = 18, USAGE_SERVER_RESULT = 19</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 © 2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html>
