Note
This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).
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.
To use it in a playbook, specify: ngine_io.cloudstack.cs_iso.
New in version 0.1.0: of ngine_io.cloudstack
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| account string | Account the ISO is related to. | |
| api_http_method string |
| HTTP method used to query the API endpoint. If not given, the CLOUDSTACK_METHOD env variable is considered. |
| api_key string / required | API key of the CloudStack API. If not given, the CLOUDSTACK_KEY env variable is considered. | |
| api_secret string / required | Secret key of the CloudStack API. If not set, the CLOUDSTACK_SECRET env variable is considered. | |
| api_timeout integer | Default: 10 | HTTP timeout in seconds. If not given, the CLOUDSTACK_TIMEOUT env variable is considered. |
| api_url string / required | URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the CLOUDSTACK_ENDPOINT env variable is considered. | |
| api_verify_ssl_cert string | Verify CA authority cert file. If not given, the CLOUDSTACK_VERIFY env variable is considered. | |
| bootable boolean |
| Register the ISO to be bootable. Only used if state is present. |
| checksum string | The MD5 checksum value of this ISO. If set, we search by checksum instead of name. | |
| cross_zones boolean |
| Whether the ISO should be synced or removed across zones. Mutually exclusive with zone. |
| display_text string | Display text of the ISO. If not specified, name will be used. | |
| domain string | Domain the ISO is related to. | |
| is_dynamically_scalable boolean |
| Register the ISO having XS/VMware tools installed inorder to support dynamic scaling of VM cpu/memory. Only used if state is present. |
| is_featured boolean |
| Register the ISO to be featured. Only used if state is present. |
| is_public boolean |
| Register the ISO to be publicly available to all users. Only used if state is present. |
| is_ready boolean |
| This flag is used for searching existing ISOs. If set to yes, it will only list ISO ready for deployment e.g. successfully downloaded and installed. Recommended to set it to no. |
| iso_filter string |
| Name of the filter used to search for the ISO. |
| name string / required | Name of the ISO. | |
| os_type string | Name of the OS that best represents the OS of this ISO. If the iso is bootable this parameter needs to be passed. Required if state is present. | |
| poll_async boolean |
| Poll async jobs until job has finished. |
| project string | Name of the project the ISO to be registered in. | |
| state string |
| State of the ISO. |
| tags list / elements=dictionary | List of tags. Tags are a list of dictionaries having keys key and value. To delete all tags, set a empty list e.g. tags: []. aliases: tag | |
| url string | URL where the ISO can be downloaded from. Required if state is present. | |
| zone string | Name of the zone you wish the ISO to be registered or deleted from. Required when cross_zones is no
|
Note
- name: Register an ISO if ISO name does not already exist
ngine_io.cloudstack.cs_iso:
name: Debian 7 64-bit
zone: zone01
url: http://mirror.switch.ch/ftp/mirror/debian-cd/current/amd64/iso-cd/debian-7.7.0-amd64-netinst.iso
os_type: Debian GNU/Linux 7(64-bit)
- name: Register an ISO with given name if ISO md5 checksum does not already exist
ngine_io.cloudstack.cs_iso:
name: Debian 7 64-bit
zone: zone01
url: http://mirror.switch.ch/ftp/mirror/debian-cd/current/amd64/iso-cd/debian-7.7.0-amd64-netinst.iso
os_type: Debian GNU/Linux 7(64-bit)
checksum: 0b31bccccb048d20b551f70830bb7ad0
- name: Remove an ISO by name
ngine_io.cloudstack.cs_iso:
name: Debian 7 64-bit
zone: zone01
state: absent
- name: Remove an ISO by checksum
ngine_io.cloudstack.cs_iso:
name: Debian 7 64-bit
zone: zone01
checksum: 0b31bccccb048d20b551f70830bb7ad0
state: absent
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| account string | success | Account the ISO is related to. Sample: example account |
| bootable boolean | success | True if the ISO is bootable. Sample: True |
| checksum string | success | MD5 checksum of the ISO. Sample: 0b31bccccb048d20b551f70830bb7ad0 |
| created string | success | Date of registering. Sample: 2015-03-29T14:57:06+0200 |
| cross_zones boolean | success | true if the ISO is managed across all zones, false otherwise. |
| display_text string | success | Text to be displayed of the ISO. Sample: Debian 7.7 64-bit minimal 2015-03-19 |
| domain string | success | Domain the ISO is related to. Sample: example domain |
| format string | success | Format of the ISO. Sample: ISO |
| id string | success | UUID of the ISO. Sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| is_featured boolean | success | True if the ISO is featured. Sample: True |
| is_public boolean | success | True if the ISO is public. Sample: True |
| is_ready boolean | success | True if the ISO is ready to be deployed from. Sample: True |
| name string | success | Name of the ISO. Sample: Debian 7 64-bit |
| os_type string | success | Typo of the OS. Sample: CentOS 6.5 (64-bit) |
| project string | success | Project the ISO is related to. Sample: example project |
| status string | success | Status of the ISO. Sample: Successfully Installed |
| tags dictionary | success | List of resource tags associated with the ISO. Sample: [ { "key": "foo", "value": "bar" } ] |
| zone string | success | Name of zone the ISO is registered in. Sample: zuerich |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_iso_module.html