http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/associateLun.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/associateLun.html b/content/api/apidocs-4.9/apis/associateLun.html new file mode 100644 index 0000000..0b2461a --- /dev/null +++ b/content/api/apidocs-4.9/apis/associateLun.html @@ -0,0 +1,91 @@ +<!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>associateLun</h1> +<p>Associate a LUN with a guest IQN</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>iqn</strong></td><td style="width:500px;"><strong>Guest IQN to which the LUN associate.</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>LUN name.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the LUN id</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the IP address of </td> +</tr> +<tr> +<td style="width:200px;"><strong>targetiqn</strong></td><td style="width:500px;">the target IQN</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/associateUcsProfileToBlade.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/associateUcsProfileToBlade.html b/content/api/apidocs-4.9/apis/associateUcsProfileToBlade.html new file mode 100644 index 0000000..1a1a1be --- /dev/null +++ b/content/api/apidocs-4.9/apis/associateUcsProfileToBlade.html @@ -0,0 +1,100 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.9.0 Root Admin API Reference + </span> +<p></p> +<h1>associateUcsProfileToBlade</h1> +<p>associate a profile to a blade</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>bladeid</strong></td><td style="width:500px;"><strong>blade id</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>profiledn</strong></td><td style="width:500px;"><strong>profile dn</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>ucsmanagerid</strong></td><td style="width:500px;"><strong>ucs manager id</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">ucs blade id</td> +</tr> +<tr> +<td style="width:200px;"><strong>bladedn</strong></td><td style="width:500px;">ucs blade dn</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">cloudstack host id this blade associates to</td> +</tr> +<tr> +<td style="width:200px;"><strong>profiledn</strong></td><td style="width:500px;">associated ucs profile dn</td> +</tr> +<tr> +<td style="width:200px;"><strong>ucsmanagerid</strong></td><td style="width:500px;">ucs manager id</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/attachIso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/attachIso.html b/content/api/apidocs-4.9/apis/attachIso.html new file mode 100644 index 0000000..a4a0746 --- /dev/null +++ b/content/api/apidocs-4.9/apis/attachIso.html @@ -0,0 +1,499 @@ +<!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>attachIso</h1> +<p>Attaches an ISO to a virtual machine.</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 ISO file</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;"><strong>the ID of the virtual machine</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the number of cpu this virtual machine is running with</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuspeed</strong></td><td style="width:500px;">the speed of each cpu</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuused</strong></td><td style="width:500px;">the amount of the vm's CPU currently used</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date when this virtual machine was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">Vm details in key/value pairs.</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskioread</strong></td><td style="width:500px;">the read (io) of disk on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskiowrite</strong></td><td style="width:500px;">the write (io) of disk on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskkbsread</strong></td><td style="width:500px;">the read (bytes) of disk on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskkbswrite</strong></td><td style="width:500px;">the write (bytes) of disk on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskofferingid</strong></td><td style="width:500px;">the ID of the disk offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>diskofferingname</strong></td><td style="width:500px;">the name of the disk offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>displayname</strong></td><td style="width:500px;">user generated name. The name of the virtual machine is returned if no displayname exists.</td> +</tr> +<tr> +<td style="width:200px;"><strong>displayvm</strong></td><td style="width:500px;">an optional field whether to the display the vm to the end user or not.</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the name of the domain in which the virtual machine exists</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain in which the virtual machine exists</td> +</tr> +<tr> +<td style="width:200px;"><strong>forvirtualnetwork</strong></td><td style="width:500px;">the virtual network for the service offering</td> +</tr> +<tr> +<td style="width:200px;"><strong>group</strong></td><td style="width:500px;">the group name of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>groupid</strong></td><td style="width:500px;">the group ID of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestosid</strong></td><td style="width:500px;">Os type ID of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>haenable</strong></td><td style="width:500px;">true if high-availability is enabled, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the host for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the name of the host for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the hypervisor on which the template runs</td> +</tr> +<tr> +<td style="width:200px;"><strong>instancename</strong></td><td style="width:500px;">instance name of the user vm; this parameter is returned to the ROOT admin only</td> +</tr> +<tr> +<td style="width:200px;"><strong>isdynamicallyscalable</strong></td><td style="width:500px;">true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.</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>keypair</strong></td><td style="width:500px;">ssh key-pair</td> +</tr> +<tr> +<td style="width:200px;"><strong>memory</strong></td><td style="width:500px;">the memory allocated for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>memoryintfreekbs</strong></td><td style="width:500px;">the internal memory thats free in vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>memorykbs</strong></td><td style="width:500px;">the memory used by the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>memorytargetkbs</strong></td><td style="width:500px;">the target memory in vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkkbsread</strong></td><td style="width:500px;">the incoming network traffic on the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkkbswrite</strong></td><td style="width:500px;">the outgoing network traffic on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>ostypeid</strong></td><td style="width:500px;">OS type id of the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>password</strong></td><td style="width:500px;">the password (if exists) of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>passwordenabled</strong></td><td style="width:500px;">true if the password rest feature is enabled, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the vm</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicip</strong></td><td style="width:500px;">public IP address id associated with vm via Static nat rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicipid</strong></td><td style="width:500px;">public IP address id associated with vm via Static nat rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>rootdeviceid</strong></td><td style="width:500px;">device ID of the root volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>rootdevicetype</strong></td><td style="width:500px;">device type of the root volume</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;">the ID of the service offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingname</strong></td><td style="width:500px;">the name of the service offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>servicestate</strong></td><td style="width:500px;">State of the Service from LB rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the virtual machine</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>userid</strong></td><td style="width:500px;">the user's ID who deployed the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the user's name who deployed the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>vgpu</strong></td><td style="width:500px;">the vgpu type used by the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the ID of the availablility zone for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the name of the availability zone for the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>affinitygroup(*)</strong></td><td style="width:500px;">list of affinity groups associated with the virtual machine</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account owning the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>description</strong></td><td style="width:500px;">the description of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>name</strong></td><td style="width:500px;">the name of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project ID of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>type</strong></td><td style="width:500px;">the type of the affinity group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>virtualmachineIds</strong></td><td style="width:500px;">virtual machine IDs associated with this affinity group</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>nic(*)</strong></td><td style="width:500px;">the list of nics associated with vm</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>broadcasturi</strong></td><td style="width:500px;">the broadcast uri of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>deviceid</strong></td><td style="width:500px;">device id for the network when plugged into the virtual machine</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>gateway</strong></td><td style="width:500px;">the gateway of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ip6address</strong></td><td style="width:500px;">the IPv6 address of network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ip6cidr</strong></td><td style="width:500px;">the cidr of IPv6 network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ip6gateway</strong></td><td style="width:500px;">the gateway of IPv6 network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ipaddress</strong></td><td style="width:500px;">the ip address of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>isdefault</strong></td><td style="width:500px;">true if nic is default, false otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>isolationuri</strong></td><td style="width:500px;">the isolation uri of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>macaddress</strong></td><td style="width:500px;">true if nic is default, false otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>netmask</strong></td><td style="width:500px;">the netmask of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>networkid</strong></td><td style="width:500px;">the ID of the corresponding network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>networkname</strong></td><td style="width:500px;">the name of the corresponding network</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>nsxlogicalswitch</strong></td><td style="width:500px;">Id of the NSX Logical Switch (if NSX based), null otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>nsxlogicalswitchport</strong></td><td style="width:500px;">Id of the NSX Logical Switch Port (if NSX based), null otherwise</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>secondaryip</strong></td><td style="width:500px;">the Secondary ipv4 addr of nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>traffictype</strong></td><td style="width:500px;">the traffic type of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>type</strong></td><td style="width:500px;">the type of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>virtualmachineid</strong></td><td style="width:500px;">Id of the vm to which the nic belongs</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>securitygroup(*)</strong></td><td style="width:500px;">list of security groups associated with the virtual machine</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account owning the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>description</strong></td><td style="width:500px;">the description of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>name</strong></td><td style="width:500px;">the name of the security group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name of the group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the group</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>virtualmachinecount</strong></td><td style="width:500px;">the number of virtualmachines associated with this securitygroup</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>virtualmachineids</strong></td><td style="width:500px;">the list of virtualmachine ids associated with this securitygroup</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>egressrule(*)</strong></td><td style="width:500px;">the list of egress rules associated with the security group</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">account</td><td style="width:500px;">account owning the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">cidr</td><td style="width:500px;">the CIDR notation for the base IP address of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">endport</td><td style="width:500px;">the ending IP of the security group rule </td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">icmpcode</td><td style="width:500px;">the code for the ICMP message response</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">icmptype</td><td style="width:500px;">the type of the ICMP message response</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">protocol</td><td style="width:500px;">the protocol of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">ruleid</td><td style="width:500px;">the id of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">securitygroupname</td><td style="width:500px;">security group name</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">startport</td><td style="width:500px;">the starting IP of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">tags(*)</td><td style="width:500px;">the list of resource tags associated with the rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>ingressrule(*)</strong></td><td style="width:500px;">the list of ingress rules associated with the security group</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">account</td><td style="width:500px;">account owning the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">cidr</td><td style="width:500px;">the CIDR notation for the base IP address of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">endport</td><td style="width:500px;">the ending IP of the security group rule </td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">icmpcode</td><td style="width:500px;">the code for the ICMP message response</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">icmptype</td><td style="width:500px;">the type of the ICMP message response</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">protocol</td><td style="width:500px;">the protocol of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">ruleid</td><td style="width:500px;">the id of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">securitygroupname</td><td style="width:500px;">security group name</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">startport</td><td style="width:500px;">the starting IP of the security group rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">tags(*)</td><td style="width:500px;">the list of resource tags associated with the rule</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with the rule</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">account</td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">customer</td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">domain</td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">domainid</td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">key</td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">project</td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">projectid</td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">resourceid</td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">resourcetype</td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">value</td><td style="width:500px;">tag value</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><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:180px; padding-left:25px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</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 © 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/attachVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/attachVolume.html b/content/api/apidocs-4.9/apis/attachVolume.html new file mode 100644 index 0000000..e76165f --- /dev/null +++ b/content/api/apidocs-4.9/apis/attachVolume.html @@ -0,0 +1,241 @@ +<!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>attachVolume</h1> +<p>Attaches a disk volume to a virtual machine.</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 disk volume</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;"><strong> the ID of the virtual machine</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>deviceid</i></td><td style="width:500px;"><i>the ID of the device to map the volume to within the guest OS. If no deviceId is passed in, the next available deviceId will be chosen. Possible values for a Linux OS are:* 0 - /dev/xvda* 1 - /dev/xvdb* 2 - /dev/xvdc* 4 - /dev/xvde* 5 - /dev/xvdf* 6 - /dev/xvdg* 7 - /dev/xvdh* 8 - /dev/xvdi* 9 - /dev/xvdj</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>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 © 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/authorizeSamlSso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/authorizeSamlSso.html b/content/api/apidocs-4.9/apis/authorizeSamlSso.html new file mode 100644 index 0000000..f9c3dd8 --- /dev/null +++ b/content/api/apidocs-4.9/apis/authorizeSamlSso.html @@ -0,0 +1,91 @@ +<!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>authorizeSamlSso</h1> +<p>Allow or disallow a user to use SAML SSO</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>enable</strong></td><td style="width:500px;"><strong>If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>userid</strong></td><td style="width:500px;"><strong>User uuid</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>entityid</i></td><td style="width:500px;"><i>The Identity Provider ID the user is allowed to get single signed on from</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">any text associated with the success or failure</td> +</tr> +<tr> +<td style="width:200px;"><strong>success</strong></td><td style="width:500px;">true if operation is executed successfully</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 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/authorizeSecurityGroupEgress.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/authorizeSecurityGroupEgress.html b/content/api/apidocs-4.9/apis/authorizeSecurityGroupEgress.html new file mode 100644 index 0000000..36fe917 --- /dev/null +++ b/content/api/apidocs-4.9/apis/authorizeSecurityGroupEgress.html @@ -0,0 +1,172 @@ +<!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>authorizeSecurityGroupEgress</h1> +<p>Authorizes a particular egress rule for this security group</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>an optional account for the security group. Must be used with domainId.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>cidrlist</i></td><td style="width:500px;"><i>the cidr list associated</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>an optional domainId for the security group. If the account parameter is used, domainId must also be used.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>endport</i></td><td style="width:500px;"><i>end port for this egress rule</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>icmpcode</i></td><td style="width:500px;"><i>error code for this icmp message</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>icmptype</i></td><td style="width:500px;"><i>type of the icmp message being sent</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>an optional project of the security group</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>protocol</i></td><td style="width:500px;"><i>TCP is default. UDP is the other supported protocol</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>securitygroupid</i></td><td style="width:500px;"><i>The ID of the security group. Mutually exclusive with securityGroupName parameter</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>securitygroupname</i></td><td style="width:500px;"><i>The name of the security group. Mutually exclusive with securityGroupId parameter</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>startport</i></td><td style="width:500px;"><i>start port for this egress rule</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>usersecuritygrouplist</i></td><td style="width:500px;"><i>user to security group mapping</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">account owning the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>cidr</strong></td><td style="width:500px;">the CIDR notation for the base IP address of the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>endport</strong></td><td style="width:500px;">the ending IP of the security group rule </td> +</tr> +<tr> +<td style="width:200px;"><strong>icmpcode</strong></td><td style="width:500px;">the code for the ICMP message response</td> +</tr> +<tr> +<td style="width:200px;"><strong>icmptype</strong></td><td style="width:500px;">the type of the ICMP message response</td> +</tr> +<tr> +<td style="width:200px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>ruleid</strong></td><td style="width:500px;">the id of the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>securitygroupname</strong></td><td style="width:500px;">security group name</td> +</tr> +<tr> +<td style="width:200px;"><strong>startport</strong></td><td style="width:500px;">the starting IP of the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with the rule</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</tr> +</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/authorizeSecurityGroupIngress.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/authorizeSecurityGroupIngress.html b/content/api/apidocs-4.9/apis/authorizeSecurityGroupIngress.html new file mode 100644 index 0000000..c54e6bb --- /dev/null +++ b/content/api/apidocs-4.9/apis/authorizeSecurityGroupIngress.html @@ -0,0 +1,172 @@ +<!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>authorizeSecurityGroupIngress</h1> +<p>Authorizes a particular ingress rule for this security group</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>an optional account for the security group. Must be used with domainId.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>cidrlist</i></td><td style="width:500px;"><i>the cidr list associated</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>an optional domainId for the security group. If the account parameter is used, domainId must also be used.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>endport</i></td><td style="width:500px;"><i>end port for this ingress rule</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>icmpcode</i></td><td style="width:500px;"><i>error code for this icmp message</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>icmptype</i></td><td style="width:500px;"><i>type of the icmp message being sent</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>an optional project of the security group</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>protocol</i></td><td style="width:500px;"><i>TCP is default. UDP is the other supported protocol</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>securitygroupid</i></td><td style="width:500px;"><i>The ID of the security group. Mutually exclusive with securityGroupName parameter</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>securitygroupname</i></td><td style="width:500px;"><i>The name of the security group. Mutually exclusive with securityGroupId parameter</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>startport</i></td><td style="width:500px;"><i>start port for this ingress rule</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>usersecuritygrouplist</i></td><td style="width:500px;"><i>user to security group mapping</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">account owning the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>cidr</strong></td><td style="width:500px;">the CIDR notation for the base IP address of the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>endport</strong></td><td style="width:500px;">the ending IP of the security group rule </td> +</tr> +<tr> +<td style="width:200px;"><strong>icmpcode</strong></td><td style="width:500px;">the code for the ICMP message response</td> +</tr> +<tr> +<td style="width:200px;"><strong>icmptype</strong></td><td style="width:500px;">the type of the ICMP message response</td> +</tr> +<tr> +<td style="width:200px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>ruleid</strong></td><td style="width:500px;">the id of the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>securitygroupname</strong></td><td style="width:500px;">security group name</td> +</tr> +<tr> +<td style="width:200px;"><strong>startport</strong></td><td style="width:500px;">the starting IP of the security group rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with the rule</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</tr> +</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/cancelHostMaintenance.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/cancelHostMaintenance.html b/content/api/apidocs-4.9/apis/cancelHostMaintenance.html new file mode 100644 index 0000000..0449d2f --- /dev/null +++ b/content/api/apidocs-4.9/apis/cancelHostMaintenance.html @@ -0,0 +1,256 @@ +<!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>cancelHostMaintenance</h1> +<p>Cancels host maintenance.</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 host ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>averageload</strong></td><td style="width:500px;">the cpu average load on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>capabilities</strong></td><td style="width:500px;">capabilities of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clusterid</strong></td><td style="width:500px;">the cluster ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustername</strong></td><td style="width:500px;">the cluster name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustertype</strong></td><td style="width:500px;">the cluster type of the cluster that host belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuallocated</strong></td><td style="width:500px;">the amount of the host's CPU currently allocated</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the CPU number of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpusockets</strong></td><td style="width:500px;">the number of CPU sockets on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuspeed</strong></td><td style="width:500px;">the CPU speed of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuused</strong></td><td style="width:500px;">the amount of the host's CPU currently used</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuwithoverprovisioning</strong></td><td style="width:500px;">the amount of the host's CPU after applying the cpu.overprovisioning.factor </td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the host was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">Host details in key/value pairs.</td> +</tr> +<tr> +<td style="width:200px;"><strong>disconnected</strong></td><td style="width:500px;">true if the host is disconnected. False otherwise.</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizeallocated</strong></td><td style="width:500px;">the host's currently allocated disk size</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizetotal</strong></td><td style="width:500px;">the total disk size of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>events</strong></td><td style="width:500px;">events available for the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>hahost</strong></td><td style="width:500px;">true if the host is Ha host (dedicated to vms started by HA process; false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>hasenoughcapacity</strong></td><td style="width:500px;">true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>hosttags</strong></td><td style="width:500px;">comma-separated list of tags for the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the host hypervisor</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisorversion</strong></td><td style="width:500px;">the hypervisor version</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the IP address of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>islocalstorageactive</strong></td><td style="width:500px;">true if local storage is active, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>lastpinged</strong></td><td style="width:500px;">the date and time the host was last pinged</td> +</tr> +<tr> +<td style="width:200px;"><strong>managementserverid</strong></td><td style="width:500px;">the management server ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>memoryallocated</strong></td><td style="width:500px;">the amount of the host's memory currently allocated</td> +</tr> +<tr> +<td style="width:200px;"><strong>memorytotal</strong></td><td style="width:500px;">the memory total of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>memoryused</strong></td><td style="width:500px;">the amount of the host's memory currently used</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkkbsread</strong></td><td style="width:500px;">the incoming network traffic on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkkbswrite</strong></td><td style="width:500px;">the outgoing network traffic on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>oscategoryid</strong></td><td style="width:500px;">the OS category ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>oscategoryname</strong></td><td style="width:500px;">the OS category name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>outofbandmanagement</strong></td><td style="width:500px;">the host out-of-band management information</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">the Pod name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>removed</strong></td><td style="width:500px;">the date and time the host was removed</td> +</tr> +<tr> +<td style="width:200px;"><strong>resourcestate</strong></td><td style="width:500px;">the resource state of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>suitableformigration</strong></td><td style="width:500px;">true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">the host type</td> +</tr> +<tr> +<td style="width:200px;"><strong>version</strong></td><td style="width:500px;">the host version</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>gpugroup(*)</strong></td><td style="width:500px;">GPU cards present in the host</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>gpugroupname</strong></td><td style="width:500px;">GPU cards present in the host</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>vgpu(*)</strong></td><td style="width:500px;">the list of enabled vGPUs</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">maxcapacity</td><td style="width:500px;">Maximum vgpu can be created with this vgpu type on the given gpu group</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">maxheads</td><td style="width:500px;">Maximum displays per user</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">maxresolutionx</td><td style="width:500px;">Maximum X resolution per display</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">maxresolutiony</td><td style="width:500px;">Maximum Y resolution per display</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">maxvgpuperpgpu</td><td style="width:500px;">Maximum no. of vgpu per gpu card (pgpu)</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">remainingcapacity</td><td style="width:500px;">Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">vgputype</td><td style="width:500px;">Model Name of vGPU</td> +</tr> +<tr> +<td style="width:165px; padding-left:40px;">videoram</td><td style="width:500px;">Video RAM for this vGPU type</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 © 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/cancelStorageMaintenance.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/cancelStorageMaintenance.html b/content/api/apidocs-4.9/apis/cancelStorageMaintenance.html new file mode 100644 index 0000000..5a0c988 --- /dev/null +++ b/content/api/apidocs-4.9/apis/cancelStorageMaintenance.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.9.0 Root Admin API Reference + </span> +<p></p> +<h1>cancelStorageMaintenance</h1> +<p>Cancels maintenance for primary storage</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 primary storage ID</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>capacityiops</strong></td><td style="width:500px;">IOPS CloudStack can provision from this storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>clusterid</strong></td><td style="width:500px;">the ID of the cluster for the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustername</strong></td><td style="width:500px;">the name of the cluster for the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the storage pool was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizeallocated</strong></td><td style="width:500px;">the host's currently allocated disk size</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizetotal</strong></td><td style="width:500px;">the total disk size of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>disksizeused</strong></td><td style="width:500px;">the host's currently used disk size</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the hypervisor type of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the IP address of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>overprovisionfactor</strong></td><td style="width:500px;">the overprovisionfactor for the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>path</strong></td><td style="width:500px;">the storage pool path</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">the Pod name of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>scope</strong></td><td style="width:500px;">the scope of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>storagecapabilities</strong></td><td style="width:500px;">the storage pool capabilities</td> +</tr> +<tr> +<td style="width:200px;"><strong>suitableformigration</strong></td><td style="width:500px;">true if this pool is suitable to migrate a volume, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags</strong></td><td style="width:500px;">the tags for the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">the storage pool type</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name of the storage pool</td> +</tr> +<tr> +<td style="width:200px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td> +</tr> +<tr> +<td style="width:200px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="comments_thread"> +<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test"; async="true"></script> +<noscript> +<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin";></iframe> +</noscript> +</div> +<div id="footer_mainmaster"> +<p>Copyright © 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/changeOutOfBandManagementPassword.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/changeOutOfBandManagementPassword.html b/content/api/apidocs-4.9/apis/changeOutOfBandManagementPassword.html new file mode 100644 index 0000000..6972752 --- /dev/null +++ b/content/api/apidocs-4.9/apis/changeOutOfBandManagementPassword.html @@ -0,0 +1,115 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.9.0 Root Admin API Reference + </span> +<p></p> +<h1>changeOutOfBandManagementPassword</h1> +<p>Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password</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>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>password</i></td><td style="width:500px;"><i>the new host management interface password of maximum length 16, if none is provided a random password would be used</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>
