ngine_io.cloudstack.cs_disk_offering module – Manages disk offerings on Apache CloudStack based clouds.
Note
This module is part of the ngine_io.cloudstack collection (version 2.4.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ngine_io.cloudstack
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ngine_io.cloudstack.cs_disk_offering
.
New in ngine_io.cloudstack 0.1.0
Synopsis
Create and delete disk offerings for guest VMs.
Update display_text or display_offering of existing disk offering.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.9.0
Parameters
Parameter |
Comments |
---|---|
HTTP method used to query the API endpoint. If not given, the Choices:
|
|
API key of the CloudStack API. If not given, the |
|
Secret key of the CloudStack API. If not set, the |
|
HTTP timeout in seconds. If not given, the Default: |
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the |
|
Verify CA authority cert file. If not given, the |
|
Bytes read rate of the disk offering. |
|
Bytes write rate of the disk offering. |
|
Whether disk offering iops is custom or not. Choices:
|
|
Size of the disk offering in GB (1GB = 1,073,741,824 bytes). |
|
An optional field, whether to display the offering to the end user or not. Choices:
|
|
Display text of the disk offering. If not set, |
|
Domain the disk offering is related to. Public for all domains and subdomains if not set. |
|
Hypervisor snapshot reserve space as a percent of a volume. Only for managed storage using Xen or VMware. |
|
Max. iops of the disk offering. |
|
Min. iops of the disk offering. |
|
IO requests read rate of the disk offering. |
|
IO requests write rate of the disk offering. |
|
Name of the disk offering. |
|
Provisioning type used to create volumes. Choices:
|
|
State of the disk offering. Choices:
|
|
The storage tags for this disk offering. |
|
The storage type of the disk offering. Choices:
|
|
If If not given, the This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Notes
Note
A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.
Examples
- name: Create a disk offering with local storage
ngine_io.cloudstack.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
ngine_io.cloudstack.cs_disk_offering:
name: small
display_text: Small 10GB
disk_size: 10
storage_type: shared
storage_tags: SAN01
- name: Remove a disk offering
ngine_io.cloudstack.cs_disk_offering:
name: small
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Bytes read rate of the disk offering Returned: success Sample: |
|
Bytes write rate of the disk offering Returned: success Sample: |
|
Date the offering was created Returned: success Sample: |
|
Whether the offering uses custom IOPS or not Returned: success Sample: |
|
Size of the disk offering in GB Returned: success Sample: |
|
Whether to display the offering to the end user or not. Returned: success Sample: |
|
Display text of the offering Returned: success Sample: |
|
Domain the offering is into Returned: success Sample: |
|
UUID of the disk offering Returned: success Sample: |
|
Max iops of the disk offering Returned: success Sample: |
|
Min iops of the disk offering Returned: success Sample: |
|
IO requests per second read rate of the disk offering Returned: success Sample: |
|
IO requests per second write rate of the disk offering Returned: success Sample: |
|
Name of the system offering Returned: success Sample: |
|
Provisioning type used to create volumes Returned: success Sample: |
|
List of storage tags Returned: success Sample: |
|
Storage type used to create volumes Returned: success Sample: |