Parameter |
Choices/Defaults |
Comments |
api_http_method
|
|
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is get if not specified.
|
api_key
|
|
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
|
api_region
|
Default:
cloudstack
|
Name of the ini section in the cloustack.ini file.
If not given, the CLOUDSTACK_REGION env variable is considered.
|
api_secret
|
|
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
|
api_timeout
|
|
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is 10 seconds if not specified.
|
api_url
|
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
|
bytes_read_rate
|
|
Bytes read rate of the disk offering.
|
bytes_write_rate
|
|
Bytes write rate of the disk offering.
|
cpu_number
|
|
The number of CPUs of the service offering.
|
cpu_speed
|
|
The CPU speed of the service offering in MHz.
|
deployment_planner
|
|
The deployment planner heuristics used to deploy a VM of this offering.
If not set, the value of global config vm.deployment.planner is used.
|
disk_iops_customized
|
Default:
no
|
Whether compute offering iops is custom or not.
|
disk_iops_max
|
|
Max. iops of the compute offering.
|
disk_iops_min
|
|
Min. iops of the compute offering.
|
disk_iops_read_rate
|
|
IO requests read rate of the disk offering.
|
disk_iops_write_rate
|
|
IO requests write rate of the disk offering.
|
display_text
|
|
Display text of the service offering.
If not set, name will be used as display_text while creating.
|
domain
|
|
Domain the service offering is related to.
Public for all domains and subdomains if not set.
|
host_tags
|
|
The host tagsfor this service offering.
aliases: host_tag
|
hypervisor_snapshot_reserve
|
|
Hypervisor snapshot reserve space as a percent of a volume.
Only for managed storage using Xen or VMware.
|
is_system
bool |
|
Whether it is a system VM offering or not.
|
is_volatile
bool |
|
Whether the virtual machine needs to be volatile or not.
Every reboot of VM the root disk is detached then destroyed and a fresh root disk is created and attached to VM.
|
limit_cpu_usage
bool |
|
Restrict the CPU usage to committed service offering.
|
memory
|
|
The total memory of the service offering in MB.
|
name
required |
|
Name of the service offering.
|
network_rate
|
|
Data transfer rate in Mb/s allowed.
Supported only for non-system offering and system offerings having system_vm_type=domainrouter .
|
offer_ha
bool |
|
Whether HA is set for the service offering.
|
provisioning_type
|
|
Provisioning type used to create volumes.
|
service_offering_details
|
|
Details for planner, used to store specific parameters.
|
state
|
Choices:
present ←
- absent
|
State of the service offering.
|
storage_tags
|
|
The storage tags for this service offering.
aliases: storage_tag
|
storage_type
|
|
The storage type of the service offering.
|
system_vm_type
|
Choices:
- domainrouter
- consoleproxy
- secondarystoragevm
|
The system VM type.
Required if is_system=true .
|