http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/authorizeSecurityGroupEgress.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/authorizeSecurityGroupEgress.html b/source/api/apidocs-4.8/domain_admin/authorizeSecurityGroupEgress.html new file mode 100644 index 0000000..c6b02ba --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/authorizeSecurityGroupEgress.html @@ -0,0 +1,166 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Domain 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="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>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="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/authorizeSecurityGroupIngress.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/authorizeSecurityGroupIngress.html b/source/api/apidocs-4.8/domain_admin/authorizeSecurityGroupIngress.html new file mode 100644 index 0000000..1e450a2 --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/authorizeSecurityGroupIngress.html @@ -0,0 +1,166 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Domain 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="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>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="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/changeServiceForRouter.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/changeServiceForRouter.html b/source/api/apidocs-4.8/domain_admin/changeServiceForRouter.html new file mode 100644 index 0000000..0dbcd00 --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/changeServiceForRouter.html @@ -0,0 +1,274 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Domain Admin API Reference + </span> +<p></p> +<h1>changeServiceForRouter</h1> +<p>Upgrades domain router to a new service offering</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>The ID of the router</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;"><strong>the service offering ID to apply to the domain router</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 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="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/changeServiceForVirtualMachine.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/changeServiceForVirtualMachine.html b/source/api/apidocs-4.8/domain_admin/changeServiceForVirtualMachine.html new file mode 100644 index 0000000..66cd96d --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/changeServiceForVirtualMachine.html @@ -0,0 +1,520 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Domain Admin API Reference + </span> +<p></p> +<h1>changeServiceForVirtualMachine</h1> +<p>Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>The ID of the virtual machine</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>serviceofferingid</strong></td><td style="width:500px;"><strong>the service offering ID to apply to the virtual machine</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>details</i></td><td style="width:500px;"><i>name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value</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 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>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>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with vm</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td> +</tr> +<tr> +<td style="width:200px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/configureInternalLoadBalancerElement.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/configureInternalLoadBalancerElement.html b/source/api/apidocs-4.8/domain_admin/configureInternalLoadBalancerElement.html new file mode 100644 index 0000000..a3c0ed4 --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/configureInternalLoadBalancerElement.html @@ -0,0 +1,85 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Domain Admin API Reference + </span> +<p></p> +<h1>configureInternalLoadBalancerElement</h1> +<p>Configures an Internal Load Balancer element.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>the ID of the internal lb provider</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>enabled</strong></td><td style="width:500px;"><strong>Enables/Disables the Internal Load Balancer element</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 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="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/configureOvsElement.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/configureOvsElement.html b/source/api/apidocs-4.8/domain_admin/configureOvsElement.html new file mode 100644 index 0000000..936bc06 --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/configureOvsElement.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.8.0 Domain Admin API Reference + </span> +<p></p> +<h1>configureOvsElement</h1> +<p>Configures an ovs element.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>the ID of the ovs provider</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>enabled</strong></td><td style="width:500px;"><strong>Enabled/Disabled the service provider</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 ovs</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID associated with the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>enabled</strong></td><td style="width:500px;">Enabled/Disabled the service provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>nspid</strong></td><td style="width:500px;">the physical network service provider id of the provider</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> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/configureVirtualRouterElement.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/configureVirtualRouterElement.html b/source/api/apidocs-4.8/domain_admin/configureVirtualRouterElement.html new file mode 100644 index 0000000..7fde45e --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/configureVirtualRouterElement.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.8.0 Domain Admin API Reference + </span> +<p></p> +<h1>configureVirtualRouterElement</h1> +<p>Configures a virtual router element.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>the ID of the virtual router provider</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>enabled</strong></td><td style="width:500px;"><strong>Enabled/Disabled the service provider</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 router</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID associated with the provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>enabled</strong></td><td style="width:500px;">Enabled/Disabled the service provider</td> +</tr> +<tr> +<td style="width:200px;"><strong>nspid</strong></td><td style="width:500px;">the physical network service provider id of the provider</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> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/copyIso.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/copyIso.html b/source/api/apidocs-4.8/domain_admin/copyIso.html new file mode 100644 index 0000000..11db05d --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/copyIso.html @@ -0,0 +1,223 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Domain Admin API Reference + </span> +<p></p> +<h1>copyIso</h1> +<p>Copies an iso from one zone to another.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>Template ID.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>destzoneid</strong></td><td style="width:500px;"><strong>ID of the zone the template is being copied to.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>sourcezoneid</i></td><td style="width:500px;"><i>ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide 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 template ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account name to which the template belongs</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account id to which the template belongs</td> +</tr> +<tr> +<td style="width:200px;"><strong>bootable</strong></td><td style="width:500px;">true if the ISO is bootable, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>checksum</strong></td><td style="width:500px;">checksum of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date this template was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>crossZones</strong></td><td style="width:500px;">true if the template is managed across all Zones, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">additional key/value details tied with template</td> +</tr> +<tr> +<td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">the template display text</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the name of the domain to which the template belongs</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>format</strong></td><td style="width:500px;">the format of the template.</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the secondary storage host for the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the name of the secondary storage host for the template</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>isdynamicallyscalable</strong></td><td style="width:500px;">true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory</td> +</tr> +<tr> +<td style="width:200px;"><strong>isextractable</strong></td><td style="width:500px;">true if the template is extractable, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>isfeatured</strong></td><td style="width:500px;">true if this template is a featured template, false otherwise</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>isready</strong></td><td style="width:500px;">true if the template is ready to be deployed from, false otherwise.</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the template name</td> +</tr> +<tr> +<td style="width:200px;"><strong>ostypeid</strong></td><td style="width:500px;">the ID of the OS type for this template.</td> +</tr> +<tr> +<td style="width:200px;"><strong>ostypename</strong></td><td style="width:500px;">the name of the OS type for this template.</td> +</tr> +<tr> +<td style="width:200px;"><strong>passwordenabled</strong></td><td style="width:500px;">true if the reset password 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 template</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>removed</strong></td><td style="width:500px;">the date this template was removed</td> +</tr> +<tr> +<td style="width:200px;"><strong>size</strong></td><td style="width:500px;">the size of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>sourcetemplateid</strong></td><td style="width:500px;">the template ID of the parent template if present</td> +</tr> +<tr> +<td style="width:200px;"><strong>sshkeyenabled</strong></td><td style="width:500px;">true if template is sshkey enabled, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the status of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatetag</strong></td><td style="width:500px;">the tag of this template</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatetype</strong></td><td style="width:500px;">the type of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the ID of the zone for this template</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the name of the zone for this template</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with tempate</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td> +</tr> +<tr> +<td style="width:200px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/51c4e97e/source/api/apidocs-4.8/domain_admin/copyTemplate.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.8/domain_admin/copyTemplate.html b/source/api/apidocs-4.8/domain_admin/copyTemplate.html new file mode 100644 index 0000000..209154c --- /dev/null +++ b/source/api/apidocs-4.8/domain_admin/copyTemplate.html @@ -0,0 +1,223 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" href="../includes/main.css" type="text/css"> +<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> +<title>Apache CloudStack | The Power Behind Your Cloud</title> +</head> +<body> +<div id="insidetopbg"> +<div id="inside_wrapper"> +<div class="uppermenu_panel"> +<div class="uppermenu_box"></div> +</div> +<div id="main_master"> +<div id="inside_header"> +<div class="header_top"> +<a class="cloud_logo" href="http://cloudstack.org";></a> +<div class="mainemenu_panel"></div> +</div> +</div> +<div id="main_content"> +<div class="inside_apileftpanel"> +<div class="inside_contentpanel" style="width:930px;"> +<div class="api_titlebox"> +<div class="api_titlebox_left"> +<span> + Apache CloudStack v4.8.0 Domain Admin API Reference + </span> +<p></p> +<h1>copyTemplate</h1> +<p>Copies a template from one zone to another.</p> +</div> +<div class="api_titlebox_right"> +<a class="api_backbutton" href="../TOC_Domain_Admin.html"></a> +</div> +</div> +<div class="api_tablepanel"> +<h2>Request parameters</h2> +<table class="apitable"> +<tr class="hed"> +<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> +</tr> +<tr> +<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>Template ID.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><strong>destzoneid</strong></td><td style="width:500px;"><strong>ID of the zone the template is being copied to.</strong></td><td style="width:180px;"><strong>true</strong></td> +</tr> +<tr> +<td style="width:200px;"><i>sourcezoneid</i></td><td style="width:500px;"><i>ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide 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 template ID</td> +</tr> +<tr> +<td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account name to which the template belongs</td> +</tr> +<tr> +<td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account id to which the template belongs</td> +</tr> +<tr> +<td style="width:200px;"><strong>bootable</strong></td><td style="width:500px;">true if the ISO is bootable, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>checksum</strong></td><td style="width:500px;">checksum of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date this template was created</td> +</tr> +<tr> +<td style="width:200px;"><strong>crossZones</strong></td><td style="width:500px;">true if the template is managed across all Zones, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">additional key/value details tied with template</td> +</tr> +<tr> +<td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">the template display text</td> +</tr> +<tr> +<td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the name of the domain to which the template belongs</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>format</strong></td><td style="width:500px;">the format of the template.</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the secondary storage host for the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>hostname</strong></td><td style="width:500px;">the name of the secondary storage host for the template</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>isdynamicallyscalable</strong></td><td style="width:500px;">true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory</td> +</tr> +<tr> +<td style="width:200px;"><strong>isextractable</strong></td><td style="width:500px;">true if the template is extractable, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>isfeatured</strong></td><td style="width:500px;">true if this template is a featured template, false otherwise</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>isready</strong></td><td style="width:500px;">true if the template is ready to be deployed from, false otherwise.</td> +</tr> +<tr> +<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the template name</td> +</tr> +<tr> +<td style="width:200px;"><strong>ostypeid</strong></td><td style="width:500px;">the ID of the OS type for this template.</td> +</tr> +<tr> +<td style="width:200px;"><strong>ostypename</strong></td><td style="width:500px;">the name of the OS type for this template.</td> +</tr> +<tr> +<td style="width:200px;"><strong>passwordenabled</strong></td><td style="width:500px;">true if the reset password 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 template</td> +</tr> +<tr> +<td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>removed</strong></td><td style="width:500px;">the date this template was removed</td> +</tr> +<tr> +<td style="width:200px;"><strong>size</strong></td><td style="width:500px;">the size of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>sourcetemplateid</strong></td><td style="width:500px;">the template ID of the parent template if present</td> +</tr> +<tr> +<td style="width:200px;"><strong>sshkeyenabled</strong></td><td style="width:500px;">true if template is sshkey enabled, false otherwise</td> +</tr> +<tr> +<td style="width:200px;"><strong>status</strong></td><td style="width:500px;">the status of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatetag</strong></td><td style="width:500px;">the tag of this template</td> +</tr> +<tr> +<td style="width:200px;"><strong>templatetype</strong></td><td style="width:500px;">the type of the template</td> +</tr> +<tr> +<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the ID of the zone for this template</td> +</tr> +<tr> +<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the name of the zone for this template</td> +</tr> +<tr> +<td style="width:200px;"><strong>tags(*)</strong></td><td style="width:500px;">the list of resource tags associated with tempate</td> +<tr> +<td style="width:180px; padding-left:25px;"><strong>account</strong></td><td style="width:500px;">the account associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>customer</strong></td><td style="width:500px;">customer associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the tag</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>key</strong></td><td style="width:500px;">tag key name</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>project</strong></td><td style="width:500px;">the project name where tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>projectid</strong></td><td style="width:500px;">the project id the tag belongs to</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourceid</strong></td><td style="width:500px;">id of the resource</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>resourcetype</strong></td><td style="width:500px;">resource type</td> +</tr> +<tr> +<td style="width:180px; padding-left:25px;"><strong>value</strong></td><td style="width:500px;">tag value</td> +</tr> +</tr> +<tr> +<td style="width:200px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td> +</tr> +<tr> +<td style="width:200px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td> +</tr> +</table> +</div> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer_mainmaster"> +<p>Copyright © 2016 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0.</a> +<br> + Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p> +</div> +</div> +</div> +</div> +</body> +</html>
