| <!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 4.12.0.0 Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>createServiceOffering</h1> |
| <p>Creates a service offering.</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>displaytext</strong></td><td style="width:500px;"><strong>the display text of the service offering</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;"><strong>the name of the service offering</strong></td><td style="width:180px;"><strong>true</strong></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>bytesreadrate</i></td><td style="width:500px;"><i>bytes read rate of the disk offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>bytesreadratemax</i></td><td style="width:500px;"><i>burst bytes read rate of the disk offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>bytesreadratemaxlength</i></td><td style="width:500px;"><i>length (in seconds) of the burst</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>byteswriterate</i></td><td style="width:500px;"><i>bytes write rate of the disk offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>byteswriteratemax</i></td><td style="width:500px;"><i>burst bytes write rate of the disk offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>byteswriteratemaxlength</i></td><td style="width:500px;"><i>length (in seconds) of the burst</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>cpunumber</i></td><td style="width:500px;"><i>the CPU number of the service offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>cpuspeed</i></td><td style="width:500px;"><i>the CPU speed of the service offering in MHz.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>customizediops</i></td><td style="width:500px;"><i>whether compute offering iops is custom or not</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>deploymentplanner</i></td><td style="width:500px;"><i>The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>the ID of the containing domain, null for public offerings</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>hosttags</i></td><td style="width:500px;"><i>the host tag for this service offering.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>hypervisorsnapshotreserve</i></td><td style="width:500px;"><i>Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>iopsreadrate</i></td><td style="width:500px;"><i>io requests read rate of the disk offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>iopsreadratemax</i></td><td style="width:500px;"><i>burst requests read rate of the disk offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>iopsreadratemaxlength</i></td><td style="width:500px;"><i>length (in seconds) of the burst</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>iopswriterate</i></td><td style="width:500px;"><i>io requests write rate of the disk offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>iopswriteratemax</i></td><td style="width:500px;"><i>burst io requests write rate of the disk offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>iopswriteratemaxlength</i></td><td style="width:500px;"><i>length (in seconds) of the burst</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>issystem</i></td><td style="width:500px;"><i>is this a system vm offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>isvolatile</i></td><td style="width:500px;"><i>true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>limitcpuuse</i></td><td style="width:500px;"><i>restrict the CPU usage to committed service offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>maxiops</i></td><td style="width:500px;"><i>max iops of the compute offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>memory</i></td><td style="width:500px;"><i>the total memory of the service offering in MB</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>miniops</i></td><td style="width:500px;"><i>min iops of the compute offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>networkrate</i></td><td style="width:500px;"><i>data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>offerha</i></td><td style="width:500px;"><i>the HA for the service offering</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>provisioningtype</i></td><td style="width:500px;"><i>provisioning type used to create volumes. Valid values are thin, sparse, fat.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>serviceofferingdetails</i></td><td style="width:500px;"><i>details for planner, used to store specific parameters</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>storagetype</i></td><td style="width:500px;"><i>the storage type of the service offering. Values are local and shared.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>systemvmtype</i></td><td style="width:500px;"><i>the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>tags</i></td><td style="width:500px;"><i>the tags for this service offering.</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 service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the number of CPU</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>cpuspeed</strong></td><td style="width:500px;">the clock rate CPU speed in Mhz</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date this service offering was created</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>defaultuse</strong></td><td style="width:500px;">is this a default system vm offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>deploymentplanner</strong></td><td style="width:500px;">deployment strategy used to deploy VM.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskBytesReadRate</strong></td><td style="width:500px;">bytes read rate of the service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskBytesReadRateMax</strong></td><td style="width:500px;">burst bytes read rate of the disk offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskBytesReadRateMaxLength</strong></td><td style="width:500px;">length (in seconds) of the burst</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskBytesWriteRate</strong></td><td style="width:500px;">bytes write rate of the service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskBytesWriteRateMax</strong></td><td style="width:500px;">burst bytes write rate of the disk offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskBytesWriteRateMaxLength</strong></td><td style="width:500px;">length (in seconds) of the burst</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskIopsReadRate</strong></td><td style="width:500px;">io requests read rate of the service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskIopsReadRateMax</strong></td><td style="width:500px;">burst io requests read rate of the disk offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskIopsReadRateMaxLength</strong></td><td style="width:500px;">length (in second) of the burst</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskIopsWriteRate</strong></td><td style="width:500px;">io requests write rate of the service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskIopsWriteRateMax</strong></td><td style="width:500px;">burst io requests write rate of the disk offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>diskIopsWriteRateMaxLength</strong></td><td style="width:500px;">length (in seconds) of the burst</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">an alternate display text of the service offering.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">Domain name for the offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain id of the service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>hosttags</strong></td><td style="width:500px;">the host tag for the service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>hypervisorsnapshotreserve</strong></td><td style="width:500px;">Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>iscustomized</strong></td><td style="width:500px;">is true if the offering is customized</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>iscustomizediops</strong></td><td style="width:500px;">true if disk offering uses custom iops, false otherwise</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>issystem</strong></td><td style="width:500px;">is this a system vm offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>isvolatile</strong></td><td style="width:500px;">true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>limitcpuuse</strong></td><td style="width:500px;">restrict the CPU usage to committed service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>maxiops</strong></td><td style="width:500px;">the max iops of the disk offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>memory</strong></td><td style="width:500px;">the memory in MB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>miniops</strong></td><td style="width:500px;">the min iops of the disk offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>networkrate</strong></td><td style="width:500px;">data transfer rate in megabits per second allowed.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>offerha</strong></td><td style="width:500px;">the ha support in the service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>provisioningtype</strong></td><td style="width:500px;">provisioning type used to create volumes. Valid values are thin, sparse, fat.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>serviceofferingdetails</strong></td><td style="width:500px;">additional key/value details tied with this service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>storagetype</strong></td><td style="width:500px;">the storage type for this service offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>systemvmtype</strong></td><td style="width:500px;">is this a the systemvm type for system vm offering</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>tags</strong></td><td style="width:500px;">the tags for the service offering</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> |
