ngine_io.cloudstack.cs_image_store – Manages CloudStack Image Stores.

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_image_store.

New in version 0.1.0: of ngine_io.cloudstack

Synopsis

Deploy, remove, recreate CloudStack Image Stores.

Requirements

The below requirements are needed on the host that executes this module.

python >= 2.6
cs >= 0.9.0

Parameters

Parameter	Choices/Defaults	Comments
api_http_method string	Choices: get ← post	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.
force_recreate boolean	Choices: no ← yes	Set to `yes` if you're changing an existing Image Store. This will force the recreation of the Image Store. Recreation might fail if there are snapshots present on the Image Store. Delete them before running the recreation.
name string / required		The ID of the Image Store. Required when deleting a Image Store.
provider string		The image store provider name. Required when creating a new Image Store
state string	Choices: present ← absent	Stage of the Image Store
url string		The URL for the Image Store. Required when state=present.
zone string / required		The Zone name for the Image Store.

Notes

Note

A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.

Examples

- name: Add a Image Store (NFS)
  ngine_io.cloudstack.cs_image_store:
    zone: zone-01
    name: nfs-01
    provider: NFS
    url: nfs://192.168.21.16/exports/secondary


# Change the NFS share URL and force a Image Store recreation
- name: Change the NFS url
  ngine_io.cloudstack.cs_image_store:
    zone: zone-01
    name: nfs-01
    provider: NFS
    force_recreate: yes
    url: nfs://192.168.21.10/shares/secondary

- name: delete the image store
  ngine_io.cloudstack.cs_image_store:
    name: nfs-01
    zone: zone-01
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
id string	success	the ID of the image store Sample: feb11a84-a093-45eb-b84d-7f680313c40b
name string	success	the name of the image store Sample: nfs-01
protocol string	success	the protocol of the image store Sample: nfs
provider_name string	success	the provider name of the image store Sample: NFS
scope string	success	the scope of the image store Sample: ZONE
url string	success	the url of the image store Sample: nfs://192.168.21.16/exports/secondary
zone string	success	the Zone name of the image store Sample: zone-01

Authors

Patryk Cichy (@PatTheSilent)

© 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_image_store_module.html

Docs

Docs4dev

Title here