ansible.builtin.cs_iso (v2.3.2.0-1) — module

Manages ISO images on Apache CloudStack based clouds.

| "added in version" 2.0 of ansible.builtin"

Authors: René Moser (@resmo)

stableinterface | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.2.0.post1

Description

Register and remove ISO images.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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)
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Remove an ISO by name
- local_action:
    module: cs_iso
    name: Debian 7 64-bit
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Remove an ISO by checksum
- local_action:
    module: cs_iso
    name: Debian 7 64-bit
    checksum: 0b31bccccb048d20b551f70830bb7ad0
    state: absent

Inputs

    
url:
    default: null
    description:
    - URL where the ISO can be downloaded from. Required if C(state) is present.
    required: false

name:
    description:
    - Name of the ISO.
    required: true

zone:
    default: null
    description:
    - Name of the zone you wish the ISO to be registered or deleted from. If not specified,
      first zone found will be used.
    required: false

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the ISO.
    required: false

domain:
    default: null
    description:
    - Domain the ISO is related to.
    required: false

account:
    default: null
    description:
    - Account the ISO is related to.
    required: false

api_key:
    description:
    - API key of the CloudStack API.
    - If not given, the C(CLOUDSTACK_KEY) env variable is considered.
    required: true
    type: str

api_url:
    description:
    - URL of the CloudStack API e.g. https://cloud.example.com/client/api.
    - If not given, the C(CLOUDSTACK_ENDPOINT) env variable is considered.
    required: true
    type: str

os_type:
    default: null
    description:
    - 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 C(state) is present.
    required: false

project:
    default: null
    description:
    - Name of the project the ISO to be registered in.
    required: false

bootable:
    default: true
    description:
    - Register the ISO to be bootable. Only used if C(state) is present.
    required: false

checksum:
    default: false
    description:
    - The MD5 checksum value of this ISO. If set, we search by checksum instead of name.
    required: false

is_ready:
    aliases: []
    default: false
    description:
    - This flag is used for searching existing ISOs. If set to C(true), it will only list
      ISO ready for deployment e.g. successfully downloaded and installed. Recommended
      to set it to C(false).
    required: false

is_public:
    default: false
    description:
    - Register the ISO to be publicly available to all users. Only used if C(state) is
      present.
    required: false

api_secret:
    description:
    - Secret key of the CloudStack API.
    - If not set, the C(CLOUDSTACK_SECRET) env variable is considered.
    required: true
    type: str

iso_filter:
    choices:
    - featured
    - self
    - selfexecutable
    - sharedexecutable
    - executable
    - community
    default: self
    description:
    - Name of the filter used to search for the ISO.
    required: false

poll_async:
    default: true
    description:
    - Poll async jobs until job has finished.
    required: false
    version_added: '2.3'
    version_added_collection: ansible.builtin

api_timeout:
    default: 10
    description:
    - HTTP timeout in seconds.
    - If not given, the C(CLOUDSTACK_TIMEOUT) env variable is considered.
    type: int

is_featured:
    default: false
    description:
    - Register the ISO to be featured. Only used if C(state) is present.
    required: false

api_http_method:
    choices:
    - get
    - post
    default: get
    description:
    - HTTP method used to query the API endpoint.
    - If not given, the C(CLOUDSTACK_METHOD) env variable is considered.
    type: str

api_verify_ssl_cert:
    description:
    - Verify CA authority cert file.
    - If not given, the C(CLOUDSTACK_VERIFY) env variable is considered.
    type: str

is_dynamically_scalable:
    aliases: []
    default: false
    description:
    - Register the ISO having XS/VMWare tools installed inorder to support dynamic scaling
      of VM cpu/memory. Only used if C(state) is present.
    required: false

Outputs

account:
  description: Account the ISO is related to.
  returned: success
  sample: example account
  type: string
checksum:
  description: MD5 checksum of the ISO.
  returned: success
  sample: 0b31bccccb048d20b551f70830bb7ad0
  type: string
created:
  description: Date of registering.
  returned: success
  sample: 2015-03-29T14:57:06+0200
  type: string
display_text:
  description: Text to be displayed of the ISO.
  returned: success
  sample: Debian 7.7 64-bit minimal 2015-03-19
  type: string
domain:
  description: Domain the ISO is related to.
  returned: success
  sample: example domain
  type: string
id:
  description: UUID of the ISO.
  returned: success
  sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
  type: string
is_ready:
  description: True if the ISO is ready to be deployed from.
  returned: success
  sample: true
  type: boolean
name:
  description: Name of the ISO.
  returned: success
  sample: Debian 7 64-bit
  type: string
project:
  description: Project the ISO is related to.
  returned: success
  sample: example project
  type: string
status:
  description: Status of the ISO.
  returned: success
  sample: Successfully Installed
  type: string
zone:
  description: Name of zone the ISO is registered in.
  returned: success
  sample: zuerich
  type: string