New in version 2.7.
The below requirements are needed on the host that executes this module.
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.
|
|
customized
boolean
|
|
Whether disk offering iops is custom or not.
|
disk_size
-
|
Size of the disk offering in GB (1GB = 1,073,741,824 bytes).
|
|
display_offering
boolean
|
|
An optional field, whether to display the offering to the end user or not.
|
display_text
-
|
Display text of the disk offering.
If not set,
name will be used as display_text while creating. |
|
domain
-
|
Domain the disk offering is related to.
Public for all domains and subdomains if not set.
|
|
hypervisor_snapshot_reserve
-
|
Hypervisor snapshot reserve space as a percent of a volume.
Only for managed storage using Xen or VMware.
|
|
iops_max
-
|
Max. iops of the disk offering.
|
|
iops_min
-
|
Min. iops of the disk offering.
|
|
iops_read_rate
-
|
IO requests read rate of the disk offering.
|
|
iops_write_rate
-
|
IO requests write rate of the disk offering.
|
|
name
-
/ required
|
Name of the disk offering.
|
|
provisioning_type
-
|
|
Provisioning type used to create volumes.
|
state
-
|
|
State of the disk offering.
|
storage_tags
-
|
The storage tags for this disk offering.
aliases: storage_tag |
|
storage_type
-
|
|
The storage type of the disk offering.
|
Note
cs
library’s configuration method if credentials are not provided by the arguments api_url
, api_key
, api_secret
. Configuration is read from several locations, in the following order. The CLOUDSTACK_ENDPOINT
, CLOUDSTACK_KEY
, CLOUDSTACK_SECRET
and CLOUDSTACK_METHOD
. CLOUDSTACK_TIMEOUT
environment variables. A CLOUDSTACK_CONFIG
environment variable pointing to an .ini
file. A cloudstack.ini
file in the current working directory. A .cloudstack.ini
file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini
. Use the argument api_region
to select the section name, default section is cloudstack
. See https://github.com/exoscale/cs for more information.- name: Create a disk offering with local storage
local_action:
module: cs_disk_offering
name: small
display_text: Small 10GB
disk_size: 10
storage_type: local
- name: Create or update a disk offering with shared storage
local_action:
module: cs_disk_offering
name: small
display_text: Small 10GB
disk_size: 10
storage_type: shared
storage_tags: SAN01
- name: Remove a disk offering
local_action:
module: cs_disk_offering
name: small
state: absent
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
bytes_read_rate
integer
|
success |
Bytes read rate of the disk offering
Sample:
1000
|
bytes_write_rate
integer
|
success |
Bytes write rate of the disk offering
Sample:
1000
|
created
string
|
success |
Date the offering was created
Sample:
2017-11-19T10:48:59+0000
|
customized
boolean
|
success |
Whether the offering uses custom IOPS or not
|
disk_size
integer
|
success |
Size of the disk offering in GB
Sample:
10
|
display_offering
boolean
|
success |
Whether to display the offering to the end user or not.
|
display_text
string
|
success |
Display text of the offering
Sample:
Small 10GB
|
domain
string
|
success |
Domain the offering is into
Sample:
ROOT
|
id
string
|
success |
UUID of the disk offering
Sample:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
|
iops_max
integer
|
success |
Max iops of the disk offering
Sample:
1000
|
iops_min
integer
|
success |
Min iops of the disk offering
Sample:
500
|
iops_read_rate
integer
|
success |
IO requests per second read rate of the disk offering
Sample:
1000
|
iops_write_rate
integer
|
success |
IO requests per second write rate of the disk offering
Sample:
1000
|
name
string
|
success |
Name of the system offering
Sample:
Micro
|
provisioning_type
string
|
success |
Provisioning type used to create volumes
Sample:
thin
|
storage_tags
list
|
success |
List of storage tags
Sample:
['eco']
|
storage_type
string
|
success |
Storage type used to create volumes
Sample:
shared
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.