http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/listGuestOsMapping.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listGuestOsMapping.html b/content/api/apidocs-4.9/apis/listGuestOsMapping.html new file mode 100644 index 0000000..5ef1d1d --- /dev/null +++ b/content/api/apidocs-4.9/apis/listGuestOsMapping.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>listGuestOsMapping</h1> +<p>Lists all available OS mappings for given hypervisor</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>hypervisor</i></td><td style="width:500px;"><i>list Guest OS mapping by hypervisor</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>hypervisorversion</i></td><td style="width:500px;"><i>list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter</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 mapping by its UUID</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>ostypeid</i></td><td style="width:500px;"><i>list mapping by Guest OS Type UUID</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the Guest OS mapping</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the hypervisor</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisorversion</strong></td><td style="width:500px;">version of the hypervisor for mapping</td> +</tr> +<tr> +<td style="width:200px;"><strong>isuserdefined</strong></td><td style="width:500px;">is the mapping user defined</td> +</tr> +<tr> +<td style="width:200px;"><strong>osdisplayname</strong></td><td style="width:500px;">standard display name for the Guest OS</td> +</tr> +<tr> +<td style="width:200px;"><strong>osnameforhypervisor</strong></td><td style="width:500px;">hypervisor specific name for the Guest OS</td> +</tr> +<tr> +<td style="width:200px;"><strong>ostypeid</strong></td><td style="width:500px;">the ID of the Guest OS type</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/97caa4e4/content/api/apidocs-4.9/apis/listHostTags.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listHostTags.html b/content/api/apidocs-4.9/apis/listHostTags.html new file mode 100644 index 0000000..1bdb1cd --- /dev/null +++ b/content/api/apidocs-4.9/apis/listHostTags.html @@ -0,0 +1,94 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listHostTags</h1> +<p>Lists host tags</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>id</strong></td><td style="width:500px;">the ID of the host tag</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the host ID of the host tag</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the host tag</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/97caa4e4/content/api/apidocs-4.9/apis/listHosts.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listHosts.html b/content/api/apidocs-4.9/apis/listHosts.html new file mode 100644 index 0000000..9c36fa4 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listHosts.html @@ -0,0 +1,304 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listHosts</h1> +<p>Lists hosts.</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>clusterid</i></td><td style="width:500px;"><i>lists hosts existing in particular cluster</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>details</i></td><td style="width:500px;"><i>comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>hahost</i></td><td style="width:500px;"><i>if true, list only hosts dedicated to HA</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>hypervisor</i></td><td style="width:500px;"><i>hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>the id of the host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>the name of the host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>outofbandmanagementenabled</i></td><td style="width:500px;"><i>list hosts for which out-of-band management is enabled</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>outofbandmanagementpowerstate</i></td><td style="width:500px;"><i>list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>podid</i></td><td style="width:500px;"><i>the Pod ID for the host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>resourcestate</i></td><td style="width:500px;"><i>list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>state</i></td><td style="width:500px;"><i>the state of the host</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>the host 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 hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>the Zone ID for the host</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>averageload</strong></td><td style="width:500px;">the cpu average load on the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>capabilities</strong></td><td style="width:500px;">capabilities of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clusterid</strong></td><td style="width:500px;">the cluster ID of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustername</strong></td><td style="width:500px;">the cluster name of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>clustertype</strong></td><td style="width:500px;">the cluster type of the cluster that host belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpuallocated</strong></td><td style="width:500px;">the amount of the host's CPU currently allocated</td> +</tr> +<tr> +<td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the CPU number of the host</td> +</tr> +<tr> +<td style="width:200px;"><strong>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/97caa4e4/content/api/apidocs-4.9/apis/listHypervisorCapabilities.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listHypervisorCapabilities.html b/content/api/apidocs-4.9/apis/listHypervisorCapabilities.html new file mode 100644 index 0000000..9644820 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listHypervisorCapabilities.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>listHypervisorCapabilities</h1> +<p>Lists all hypervisor capabilities.</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>hypervisor</i></td><td style="width:500px;"><i>the hypervisor for which to restrict the search</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>ID of the hypervisor capability</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the hypervisor capabilities row</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the hypervisor type</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>maxdatavolumeslimit</strong></td><td style="width:500px;">the maximum number of Data Volumes that can be attached for this hypervisor</td> +</tr> +<tr> +<td style="width:200px;"><strong>maxguestslimit</strong></td><td style="width:500px;">the maximum number of guest vms recommended for this hypervisor</td> +</tr> +<tr> +<td style="width:200px;"><strong>maxhostspercluster</strong></td><td style="width:500px;">the maximum number of Hosts per cluster for this hypervisor</td> +</tr> +<tr> +<td style="width:200px;"><strong>securitygroupenabled</strong></td><td style="width:500px;">true if security group is supported</td> +</tr> +<tr> +<td style="width:200px;"><strong>storagemotionenabled</strong></td><td style="width:500px;">true if storage motion is supported</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/97caa4e4/content/api/apidocs-4.9/apis/listHypervisors.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listHypervisors.html b/content/api/apidocs-4.9/apis/listHypervisors.html new file mode 100644 index 0000000..d5c2209 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listHypervisors.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>listHypervisors</h1> +<p>List hypervisors</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>zoneid</i></td><td style="width:500px;"><i>the zone id for listing hypervisors.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">Hypervisor 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/97caa4e4/content/api/apidocs-4.9/apis/listIdps.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listIdps.html b/content/api/apidocs-4.9/apis/listIdps.html new file mode 100644 index 0000000..3852b11 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listIdps.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>listIdps</h1> +<p>Returns list of discovered SAML Identity Providers</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>id</strong></td><td style="width:500px;">The IdP Entity ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>orgName</strong></td><td style="width:500px;">The IdP Organization Name</td> +</tr> +<tr> +<td style="width:200px;"><strong>orgUrl</strong></td><td style="width:500px;">The IdP Organization URL</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/97caa4e4/content/api/apidocs-4.9/apis/listImageStores.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listImageStores.html b/content/api/apidocs-4.9/apis/listImageStores.html new file mode 100644 index 0000000..9c9dcf6 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listImageStores.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>listImageStores</h1> +<p>Lists image stores.</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 storage pool</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>the name of the image store</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>protocol</i></td><td style="width:500px;"><i>the image store protocol</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>provider</i></td><td style="width:500px;"><i>the image store provider</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>the Zone ID for the image 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>id</strong></td><td style="width:500px;">the ID of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">the details of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>providername</strong></td><td style="width:500px;">the provider name of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>scope</strong></td><td style="width:500px;">the scope of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>url</strong></td><td style="width:500px;">the url of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the image store</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name of the image store</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/97caa4e4/content/api/apidocs-4.9/apis/listInstanceGroups.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listInstanceGroups.html b/content/api/apidocs-4.9/apis/listInstanceGroups.html new file mode 100644 index 0000000..d54bb90 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listInstanceGroups.html @@ -0,0 +1,130 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listInstanceGroups</h1> +<p>Lists vm 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 instance groups by ID</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>list instance 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> +</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 instance group</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account owning the instance group</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">time and date the instance group was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the instance group</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the instance group</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the instance group</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the instance group</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project ID of the instance 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/97caa4e4/content/api/apidocs-4.9/apis/listInternalLoadBalancerElements.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listInternalLoadBalancerElements.html b/content/api/apidocs-4.9/apis/listInternalLoadBalancerElements.html new file mode 100644 index 0000000..4d272a3 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listInternalLoadBalancerElements.html @@ -0,0 +1,103 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listInternalLoadBalancerElements</h1> +<p>Lists all available Internal Load Balancer elements.</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>enabled</i></td><td style="width:500px;"><i>list internal load balancer elements by enabled state</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 internal load balancer elements by id</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>nspid</i></td><td style="width:500px;"><i>list internal load balancer elements by network service provider id</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +</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 internal load balancer element</td> +</tr> +<tr> +<td style="width:200px;"><strong>enabled</strong></td><td style="width:500px;">Enabled/Disabled the element</td> +</tr> +<tr> +<td style="width:200px;"><strong>nspid</strong></td><td style="width:500px;">the physical network service provider id of the element</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/97caa4e4/content/api/apidocs-4.9/apis/listInternalLoadBalancerVMs.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listInternalLoadBalancerVMs.html b/content/api/apidocs-4.9/apis/listInternalLoadBalancerVMs.html new file mode 100644 index 0000000..d428200 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listInternalLoadBalancerVMs.html @@ -0,0 +1,325 @@ +<!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>listInternalLoadBalancerVMs</h1> +<p>List internal LB VMs.</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>forvpc</i></td><td style="width:500px;"><i>if true is passed for this parameter, list only VPC Internal LB VMs</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>hostid</i></td><td style="width:500px;"><i>the host ID of the Internal LB VM</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>the ID of the Internal LB VM</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>the name of the Internal LB VM</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>networkid</i></td><td style="width:500px;"><i>list by network id</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>podid</i></td><td style="width:500px;"><i>the Pod ID of the Internal LB VM</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>projectid</i></td><td style="width:500px;"><i>list objects by project</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>state</i></td><td style="width:500px;"><i>the state of the Internal LB VM</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>vpcid</i></td><td style="width:500px;"><i>List Internal LB VMs by VPC</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>zoneid</i></td><td style="width:500px;"><i>the Zone ID of the Internal LB VM</i></td><td style="width:180px;"><i>false</i></td> +</tr> +</table> +</div> +<div class="api_tablepanel"> +<h2>Response Tags</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the id of the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the router was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>dns1</strong></td><td style="width:500px;">the first DNS for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>dns2</strong></td><td style="width:500px;">the second DNS for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID associated with the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>gateway</strong></td><td style="width:500px;">the gateway for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestipaddress</strong></td><td style="width:500px;">the guest IP address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestmacaddress</strong></td><td style="width:500px;">the guest MAC address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestnetmask</strong></td><td style="width:500px;">the guest netmask for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestnetworkid</strong></td><td style="width:500px;">the ID of the corresponding guest network</td> +</tr> +<tr> +<td style="width:200px;"><strong>guestnetworkname</strong></td><td style="width:500px;">the name of the corresponding guest network</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the host ID for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the hostname for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the hypervisor on which the template runs</td> +</tr> +<tr> +<td style="width:200px;"><strong>ip6dns1</strong></td><td style="width:500px;">the first IPv6 DNS for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>ip6dns2</strong></td><td style="width:500px;">the second IPv6 DNS for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>isredundantrouter</strong></td><td style="width:500px;">if this router is an redundant virtual router</td> +</tr> +<tr> +<td style="width:200px;"><strong>linklocalip</strong></td><td style="width:500px;">the link local IP address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>linklocalmacaddress</strong></td><td style="width:500px;">the link local MAC address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>linklocalnetmask</strong></td><td style="width:500px;">the link local netmask for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>linklocalnetworkid</strong></td><td style="width:500px;">the ID of the corresponding link local network</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkdomain</strong></td><td style="width:500px;">the network domain for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the address</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the ipaddress</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicip</strong></td><td style="width:500px;">the public IP address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicmacaddress</strong></td><td style="width:500px;">the public MAC address for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicnetmask</strong></td><td style="width:500px;">the public netmask for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicnetworkid</strong></td><td style="width:500px;">the ID of the corresponding public network</td> +</tr> +<tr> +<td style="width:200px;"><strong>redundantstate</strong></td><td style="width:500px;">the state of redundant virtual router</td> +</tr> +<tr> +<td style="width:200px;"><strong>requiresupgrade</strong></td><td style="width:500px;">true if the router template requires upgrader</td> +</tr> +<tr> +<td style="width:200px;"><strong>role</strong></td><td style="width:500px;">role of the domain router</td> +</tr> +<tr> +<td style="width:200px;"><strong>scriptsversion</strong></td><td style="width:500px;">the version of scripts</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;">the ID of the service offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingname</strong></td><td style="width:500px;">the name of the service offering of the virtual machine</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>templateid</strong></td><td style="width:500px;">the template ID for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>version</strong></td><td style="width:500px;">the version of template</td> +</tr> +<tr> +<td style="width:200px;"><strong>vpcid</strong></td><td style="width:500px;">VPC the router belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>vpcname</strong></td><td style="width:500px;">the name of VPC the router belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name for the router</td> +</tr> +<tr> +<td style="width:200px;"><strong>nic(*)</strong></td><td style="width:500px;">the list of nics associated with the router</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>id</strong></td><td style="width:500px;">the ID of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>broadcasturi</strong></td><td style="width:500px;">the broadcast uri of the nic</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>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> +</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/97caa4e4/content/api/apidocs-4.9/apis/listIpForwardingRules.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listIpForwardingRules.html b/content/api/apidocs-4.9/apis/listIpForwardingRules.html new file mode 100644 index 0000000..264ec22 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listIpForwardingRules.html @@ -0,0 +1,190 @@ +<!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>listIpForwardingRules</h1> +<p>List the IP forwarding rules</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>Lists rule with the specified ID.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>ipaddressid</i></td><td style="width:500px;"><i>list the rule belonging to this public IP address</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>projectid</i></td><td style="width:500px;"><i>list objects by project</i></td><td style="width:180px;"><i>false</i></td> +</tr> +<tr> +<td style="width:200px;"><i>virtualmachineid</i></td><td style="width:500px;"><i>Lists all rules applied to the specified VM.</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 port forwarding rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>cidrlist</strong></td><td style="width:500px;">the cidr list to forward traffic from</td> +</tr> +<tr> +<td style="width:200px;"><strong>fordisplay</strong></td><td style="width:500px;">is firewall for display to the regular user</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the public ip address for the port forwarding rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>ipaddressid</strong></td><td style="width:500px;">the public ip address id for the port forwarding rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>networkid</strong></td><td style="width:500px;">the id of the guest network the port forwarding rule belongs to</td> +</tr> +<tr> +<td style="width:200px;"><strong>privateendport</strong></td><td style="width:500px;">the ending port of port forwarding rule's private port range</td> +</tr> +<tr> +<td style="width:200px;"><strong>privateport</strong></td><td style="width:500px;">the starting port of port forwarding rule's private port range</td> +</tr> +<tr> +<td style="width:200px;"><strong>protocol</strong></td><td style="width:500px;">the protocol of the port forwarding rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicendport</strong></td><td style="width:500px;">the ending port of port forwarding rule's private port range</td> +</tr> +<tr> +<td style="width:200px;"><strong>publicport</strong></td><td style="width:500px;">the starting port of port forwarding rule's public port range</td> +</tr> +<tr> +<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachinedisplayname</strong></td><td style="width:500px;">the VM display name for the port forwarding rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;">the VM ID for the port forwarding rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>virtualmachinename</strong></td><td style="width:500px;">the VM name for the port forwarding rule</td> +</tr> +<tr> +<td style="width:200px;"><strong>vmguestip</strong></td><td style="width:500px;">the vm ip address for the port forwarding 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/97caa4e4/content/api/apidocs-4.9/apis/listIsoPermissions.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listIsoPermissions.html b/content/api/apidocs-4.9/apis/listIsoPermissions.html new file mode 100644 index 0000000..cd6120a --- /dev/null +++ b/content/api/apidocs-4.9/apis/listIsoPermissions.html @@ -0,0 +1,94 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.9.0 Root Admin API Reference + </span> +<p></p> +<h1>listIsoPermissions</h1> +<p>List iso visibility and all accounts that have permissions to view this iso.</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 template 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 template ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the list of accounts the template is available for</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain to which the template belongs</td> +</tr> +<tr> +<td style="width:200px;"><strong>ispublic</strong></td><td style="width:500px;">true if this template is a public template, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectids</strong></td><td style="width:500px;">the list of projects the template is available for</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>
