Apache CloudStack 4.23.0.0 Root Admin API Reference
cloneDiskOffering
Clones a disk offering. All parameters from createDiskOffering are available. If not specified, values will be copied from the source offering.
Request parameters
| Parameter Name | Description | Required |
| name | Name of the disk offering | true |
| sourceofferingid | The ID of the source disk offering to clone from | 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, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode | false |
| customized | Whether disk offering size is custom or not | false |
| customizediops | Whether disk offering IOPS is custom or not | false |
| details | Details to specify disk offering parameters | false |
| disksize | Size of the disk offering in GB (1GB = 1,073,741,824 bytes) | false |
| disksizestrictness | To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed | false |
| displayoffering | An optional field, whether to display the offering to the end user or not. | false |
| displaytext | An alternate display text of the disk offering, defaults to 'name'. | false |
| domainid | The ID of the containing domain(s), null for public offerings | false |
| encrypt | Volumes using this offering should be encrypted | false |
| hypervisorsnapshotreserve | Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) | false |
| iopsreadrate | I/O 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 | I/O requests write rate of the disk offering | false |
| iopswriteratemax | Burst I/O requests write rate of the disk offering | false |
| iopswriteratemaxlength | Length (in seconds) of the burst | false |
| maxiops | Max IOPS of the disk offering | false |
| miniops | Min IOPS of the disk offering | false |
| provisioningtype | Provisioning type used to create volumes. Valid values are thin, sparse, fat. | false |
| storagepolicy | Name of the storage policy defined at vCenter, this is applicable only for VMware | false |
| storagetype | The storage type of the disk offering. Values are local and shared. | false |
| tags | Tags for the disk offering | false |
| zoneid | The ID of the containing zone(s), null for public offerings | false |
Response Tags
| Response Name | Description |
| id | Unique ID of the disk offering |
| cacheMode | The cache mode to use for this disk offering. none, writeback or writethrough |
| created | The date this disk offering was created |
| details | Additional key/value details tied with this disk offering |
| diskBytesReadRate | Bytes read rate of the disk offering |
| diskBytesReadRateMax | Burst bytes read rate of the disk offering |
| diskBytesReadRateMaxLength | Length (in seconds) of the burst |
| diskBytesWriteRate | Bytes write rate of the disk offering |
| diskBytesWriteRateMax | Burst bytes write rate of the disk offering |
| diskBytesWriteRateMaxLength | Length (in seconds) of the burst |
| diskIopsReadRate | I/O requests read rate of the disk offering |
| diskIopsReadRateMax | Burst io requests read rate of the disk offering |
| diskIopsReadRateMaxLength | Length (in second) of the burst |
| diskIopsWriteRate | I/O requests write rate of the disk offering |
| diskIopsWriteRateMax | Burst io requests write rate of the disk offering |
| diskIopsWriteRateMaxLength | Length (in seconds) of the burst |
| disksize | The size of the disk offering in GB |
| disksizestrictness | To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed |
| displayoffering | Whether to display the offering to the end user or not. |
| displaytext | An alternate display text of the disk 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. |
| encrypt | Whether disks using this offering will be encrypted on primary storage |
| hypervisorsnapshotreserve | Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) |
| iscustomized | True if disk offering uses custom size, false otherwise |
| iscustomizediops | True if disk offering uses custom IOPS, false otherwise |
| maxiops | The max IOPS of the disk offering |
| miniops | The min IOPS of the disk offering |
| name | The name of the disk offering |
| provisioningtype | Provisioning type used to create volumes. Valid values are thin, sparse, fat. |
| state | state of the disk offering |
| storagetype | The storage type for this disk offering |
| suitableforvirtualmachine | Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false |
| tags | The tags for the disk offering |
| vspherestoragepolicy | The vsphere storage policy tagged to the disk 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. |