Apache CloudStack 4.17.0.0 Root Admin API Reference

createServiceOffering

Creates a service offering.

Request parameters

Parameter NameDescriptionRequired
displaytextthe display text of the service offeringtrue
namethe name of the service offeringtrue
bytesreadratebytes read rate of the disk offeringfalse
bytesreadratemaxburst bytes read rate of the disk offeringfalse
bytesreadratemaxlengthlength (in seconds) of the burstfalse
byteswriteratebytes write rate of the disk offeringfalse
byteswriteratemaxburst bytes write rate of the disk offeringfalse
byteswriteratemaxlengthlength (in seconds) of the burstfalse
cachemodethe cache mode to use for this disk offering. none, writeback or writethroughfalse
cpunumberthe CPU number of the service offeringfalse
cpuspeedthe CPU speed of the service offering in MHz.false
customizedWhether service offering size is custom or notfalse
customizediopswhether compute offering iops is custom or notfalse
deploymentplannerThe deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is usedfalse
diskofferingidthe ID of the disk offering to which service offering should be mappedfalse
diskofferingstrictnessTrue/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployedfalse
domainidthe ID of the containing domain(s), null for public offeringsfalse
dynamicscalingenabledtrue if virtual machine needs to be dynamically scalable of cpu or memoryfalse
hosttagsthe host tag for this service offering.false
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)false
iopsreadrateio requests read rate of the disk offeringfalse
iopsreadratemaxburst requests read rate of the disk offeringfalse
iopsreadratemaxlengthlength (in seconds) of the burstfalse
iopswriterateio requests write rate of the disk offeringfalse
iopswriteratemaxburst io requests write rate of the disk offeringfalse
iopswriteratemaxlengthlength (in seconds) of the burstfalse
issystemis this a system vm offeringfalse
isvolatiletrue 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 VMfalse
limitcpuuserestrict the CPU usage to committed service offeringfalse
maxcpunumberThe maximum number of CPUs to be set with Custom Computer Offeringfalse
maxiopsmax iops of the compute offeringfalse
maxmemoryThe maximum memory size of the custom service offering in MBfalse
memorythe total memory of the service offering in MBfalse
mincpunumberThe minimum number of CPUs to be set with Custom Computer Offeringfalse
miniopsmin iops of the compute offeringfalse
minmemoryThe minimum memory size of the custom service offering in MBfalse
networkratedata transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtypefalse
offerhathe HA for the service offeringfalse
provisioningtypeprovisioning type used to create volumes. Valid values are thin, sparse, fat.false
rootdisksizethe Root disk size in GB.false
serviceofferingdetailsdetails for planner, used to store specific parametersfalse
storagepolicyName of the storage policy defined at vCenter, this is applicable only for VMwarefalse
storagetypethe storage type of the service offering. Values are local and shared.false
systemvmtypethe system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".false
tagsthe tags for this service offering.false
zoneidthe ID of the containing zone(s), null for public offeringsfalse

Response Tags

Response NameDescription
idthe id of the service offering
cacheModethe cache mode to use for this disk offering. none, writeback or writethrough
cpunumberthe number of CPU
cpuspeedthe clock rate CPU speed in Mhz
createdthe date this service offering was created
defaultuseis this a default system vm offering
deploymentplannerdeployment strategy used to deploy VM.
diskBytesReadRatebytes read rate of the service offering
diskBytesReadRateMaxburst bytes read rate of the disk offering
diskBytesReadRateMaxLengthlength (in seconds) of the burst
diskBytesWriteRatebytes write rate of the service offering
diskBytesWriteRateMaxburst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthlength (in seconds) of the burst
diskIopsReadRateio requests read rate of the service offering
diskIopsReadRateMaxburst io requests read rate of the disk offering
diskIopsReadRateMaxLengthlength (in second) of the burst
diskIopsWriteRateio requests write rate of the service offering
diskIopsWriteRateMaxburst io requests write rate of the disk offering
diskIopsWriteRateMaxLengthlength (in seconds) of the burst
diskofferingdisplaytextthe display text of the disk offering
diskofferingidthe ID of the disk offering to which service offering is linked
diskofferingnamename of the disk offering
diskofferingstrictnessTrue/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed
displaytextan alternate display text of the service offering.
domainthe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidthe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
dynamicscalingenabledtrue if virtual machine needs to be dynamically scalable of cpu or memory
hosttagsthe host tag for the service offering
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedis true if the offering is customized
iscustomizediopstrue if disk offering uses custom iops, false otherwise
issystemis this a system vm offering
isvolatiletrue 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
limitcpuuserestrict the CPU usage to committed service offering
maxiopsthe max iops of the disk offering
memorythe memory in MB
miniopsthe min iops of the disk offering
namethe name of the service offering
networkratedata transfer rate in megabits per second allowed.
offerhathe ha support in the service offering
provisioningtypeprovisioning type used to create volumes. Valid values are thin, sparse, fat.
rootdisksizeRoot disk size in GB
serviceofferingdetailsadditional key/value details tied with this service offering
storagetagsthe tags for the service offering
storagetypethe storage type for this service offering
systemvmtypeis this a the systemvm type for system vm offering
vspherestoragepolicythe vsphere storage policy tagged to the service offering in case of VMware
zonethe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidthe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.