Cosmic 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
byteswriteratebytes write rate of the disk offeringfalse
cpunumberthe CPU number of the service offeringfalse
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
domainidthe ID of the containing domain, null for public offeringsfalse
hosttagsthe host tag for this service offering.false
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen)false
iopsratepergbio requests per GBfalse
iopsreadrateio requests read rate of the disk offeringfalse
iopstotalrateio requests generic total rate of the disk offeringfalse
iopswriterateio requests write rate of the disk offeringfalse
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
maxiopsmax iops of the compute offeringfalse
memorythe total memory of the service offering in MBfalse
miniopsmin iops of the compute offeringfalse
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
serviceofferingdetailsdetails for planner, used to store specific parametersfalse
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

Response Tags

Response NameDescription
idthe id of the service offering
cpunumberthe number of CPU
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
diskBytesWriteRatebytes write rate of the service offering
diskIopsRatePerGbio requests per GB
diskIopsReadRateio requests read rate of the service offering
diskIopsTotalRateio requests total rate of the service offering
diskIopsWriteRateio requests write rate of the service offering
displaytextan alternate display text of the service offering.
domainDomain name for the offering
domainidthe domain id of the service offering
hosttagsthe host tag for the service offering
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen)
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.
serviceofferingdetailsadditional key/value details tied with this service offering
storagetypethe storage type for this service offering
systemvmtypeis this a the systemvm type for system vm offering
tagsthe tags for the service offering