Apache CloudStack 4.15.0.0 Root Admin API Reference
createServiceOffering
Creates a service offering.
Request parameters
| Parameter Name | Description | Required |
| displaytext | the display text of the service offering | true |
| name | the name of the service offering | true |
| bytesreadrate | bytes read rate of the disk offering | false |
| bytesreadratemax | burst bytes read rate of the disk offering | false |
| bytesreadratemaxlength | length (in seconds) of the burst | false |
| byteswriterate | bytes write rate of the disk offering | false |
| byteswriteratemax | burst bytes write rate of the disk offering | false |
| byteswriteratemaxlength | length (in seconds) of the burst | false |
| cachemode | the cache mode to use for this disk offering. none, writeback or writethrough | false |
| cpunumber | the CPU number of the service offering | false |
| cpuspeed | the CPU speed of the service offering in MHz. | false |
| customized | Whether service offering size is custom or not | false |
| customizediops | whether compute offering iops is custom or not | false |
| deploymentplanner | The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used | false |
| domainid | the ID of the containing domain(s), null for public offerings | false |
| hosttags | the host tag for this service offering. | false |
| hypervisorsnapshotreserve | Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) | false |
| iopsreadrate | io requests read rate of the disk offering | false |
| iopsreadratemax | burst requests read rate of the disk offering | false |
| iopsreadratemaxlength | length (in seconds) of the burst | false |
| iopswriterate | io requests write rate of the disk offering | false |
| iopswriteratemax | burst io requests write rate of the disk offering | false |
| iopswriteratemaxlength | length (in seconds) of the burst | false |
| issystem | is this a system vm offering | false |
| isvolatile | 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 | false |
| limitcpuuse | restrict the CPU usage to committed service offering | false |
| maxcpunumber | The maximum number of CPUs to be set with Custom Computer Offering | false |
| maxiops | max iops of the compute offering | false |
| maxmemory | The maximum memroy size of the custom service offering in MB | false |
| memory | the total memory of the service offering in MB | false |
| mincpunumber | The minimum number of CPUs to be set with Custom Computer Offering | false |
| miniops | min iops of the compute offering | false |
| minmemory | The minimum memroy size of the custom service offering in MB | false |
| networkrate | data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype | false |
| offerha | the HA for the service offering | false |
| provisioningtype | provisioning type used to create volumes. Valid values are thin, sparse, fat. | false |
| rootdisksize | the Root disk size in GB. | false |
| serviceofferingdetails | details for planner, used to store specific parameters | false |
| storagepolicy | Name of the storage policy defined at vCenter, this is applicable only for VMware | false |
| storagetype | the storage type of the service offering. Values are local and shared. | false |
| systemvmtype | the system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm". | false |
| tags | the tags for this service offering. | false |
| zoneid | the ID of the containing zone(s), null for public offerings | false |
Response Tags
| Response Name | Description |
| id | the id of the service offering |
| cacheMode | the cache mode to use for this disk offering. none, writeback or writethrough |
| cpunumber | the number of CPU |
| cpuspeed | the clock rate CPU speed in Mhz |
| created | the date this service offering was created |
| defaultuse | is this a default system vm offering |
| deploymentplanner | deployment strategy used to deploy VM. |
| diskBytesReadRate | bytes read rate of the service offering |
| diskBytesReadRateMax | burst bytes read rate of the disk offering |
| diskBytesReadRateMaxLength | length (in seconds) of the burst |
| diskBytesWriteRate | bytes write rate of the service offering |
| diskBytesWriteRateMax | burst bytes write rate of the disk offering |
| diskBytesWriteRateMaxLength | length (in seconds) of the burst |
| diskIopsReadRate | io requests read rate of the service offering |
| diskIopsReadRateMax | burst io requests read rate of the disk offering |
| diskIopsReadRateMaxLength | length (in second) of the burst |
| diskIopsWriteRate | io requests write rate of the service offering |
| diskIopsWriteRateMax | burst io requests write rate of the disk offering |
| diskIopsWriteRateMaxLength | length (in seconds) of the burst |
| displaytext | an alternate display text of the service offering. |
| domain | the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| domainid | the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| hosttags | the host tag for the service offering |
| hypervisorsnapshotreserve | Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) |
| iscustomized | is true if the offering is customized |
| iscustomizediops | true if disk offering uses custom iops, false otherwise |
| issystem | is this a system vm offering |
| isvolatile | 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 |
| limitcpuuse | restrict the CPU usage to committed service offering |
| maxiops | the max iops of the disk offering |
| memory | the memory in MB |
| miniops | the min iops of the disk offering |
| name | the name of the service offering |
| networkrate | data transfer rate in megabits per second allowed. |
| offerha | the ha support in the service offering |
| provisioningtype | provisioning type used to create volumes. Valid values are thin, sparse, fat. |
| rootdisksize | Root disk size in GB |
| serviceofferingdetails | additional key/value details tied with this service offering |
| storagetype | the storage type for this service offering |
| systemvmtype | is this a the systemvm type for system vm offering |
| tags | the tags for the service offering |
| vspherestoragepolicy | the vsphere storage policy tagged to the service offering in case of VMware |
| zone | the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| zoneid | the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |