New in version 2.0.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| account | no | Account the ISO is related to. | ||
| api_http_method | no | get |
| HTTP method used. |
| api_key | no | API key of the CloudStack API. | ||
| api_region | no | cloudstack | Name of the ini section in the cloustack.ini file. | |
| api_secret | no | Secret key of the CloudStack API. | ||
| api_timeout | no | 10 | HTTP timeout. | |
| api_url | no | URL of the CloudStack API e.g. https://cloud.example.com/client/api. | ||
| bootable | no | Register the ISO to be bootable. Only used if state is present. | ||
| checksum | no | The MD5 checksum value of this ISO. If set, we search by checksum instead of name. | ||
| cross_zones (added in 2.4)
| no | Whether the ISO should be synced or removed across zones. Mutually exclusive with zone. | ||
| display_text (added in 2.4)
| no | Display text of the ISO. If not specified, name will be used. | ||
| domain | no | Domain the ISO is related to. | ||
| is_dynamically_scalable | no | 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 | no | Register the ISO to be featured. Only used if state is present. | ||
| is_public | no | Register the ISO to be publicly available to all users. Only used if state is present. | ||
| is_ready | no | This flag is used for searching existing ISOs. If set to true, it will only list ISO ready for deployment e.g. successfully downloaded and installed. Recommended to set it to false. | ||
| iso_filter | no | self |
| Name of the filter used to search for the ISO. |
| name | yes | Name of the ISO. | ||
| os_type | no | 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 (added in 2.3)
| no | True | Poll async jobs until job has finished. | |
| project | no | Name of the project the ISO to be registered in. | ||
| state | no | present |
| State of the ISO. |
| tags (added in 2.4)
| no | 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 | no | URL where the ISO can be downloaded from. Required if state is present. | ||
| zone | no | Name of the zone you wish the ISO to be registered or deleted from. If not specified, first zone found will be used. |
# Register an ISO if ISO name does not already exist.
- local_action:
module: cs_iso
name: Debian 7 64-bit
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)
# Register an ISO with given name if ISO md5 checksum does not already exist.
- local_action:
module: cs_iso
name: Debian 7 64-bit
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
# Remove an ISO by name
- local_action:
module: cs_iso
name: Debian 7 64-bit
state: absent
# Remove an ISO by checksum
- local_action:
module: cs_iso
name: Debian 7 64-bit
checksum: 0b31bccccb048d20b551f70830bb7ad0
state: absent
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| status | Status of the ISO. | success | string | Successfully Installed |
| is_featured | True if the ISO is featured. | success | boolean | True |
| format | Format of the ISO. | success | string | ISO |
| domain | Domain the ISO is related to. | success | string | example domain |
| is_public | True if the ISO is public. | success | boolean | True |
| id | UUID of the ISO. | success | string | a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| display_text | Text to be displayed of the ISO. | success | string | Debian 7.7 64-bit minimal 2015-03-19 |
| account | Account the ISO is related to. | success | string | example account |
| name | Name of the ISO. | success | string | Debian 7 64-bit |
| zone | Name of zone the ISO is registered in. | success | string | zuerich |
| created | Date of registering. | success | string | 2015-03-29T14:57:06+0200 |
| bootable | True if the ISO is bootable. | success | boolean | True |
| checksum | MD5 checksum of the ISO. | success | string | 0b31bccccb048d20b551f70830bb7ad0 |
| tags | List of resource tags associated with the ISO. | success | dict | [ { "key": "foo", "value": "bar" } ] |
| cross_zones | true if the ISO is managed across all zones, false otherwise. | success | boolean | False |
| project | Project the ISO is related to. | success | string | example project |
| is_ready | True if the ISO is ready to be deployed from. | success | boolean | True |
| os_type | Typo of the OS. | success | string | CentOS 6.5 (64-bit) |
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.This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/cs_iso_module.html