Note
This plugin is part of the openstack.cloud collection (version 1.5.1).
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 openstack.cloud.
To use it in a playbook, specify: openstack.cloud.image.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_timeout integer | How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. | |
| auth dictionary | Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. | |
| auth_type string | Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. | |
| availability_zone string | Ignored. Present for backwards compatibility | |
| ca_cert string | A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert | |
| checksum string | The checksum of the image | |
| client_cert string | A path to a client certificate to use as part of the SSL transaction. aliases: cert | |
| client_key string | A path to a client key to use as part of the SSL transaction. aliases: key | |
| cloud raw | Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. | |
| container_format string |
| The format of the container |
| disk_format string |
| The format of the disk that is getting uploaded |
| filename string | The path to the file which has to be uploaded | |
| id string | The ID of the image when uploading an image | |
| interface string |
| Endpoint URL type to fetch from the service catalog. aliases: endpoint_type |
| is_public boolean |
| Whether the image can be accessed publicly. Note that publicizing an image requires admin role by default. |
| kernel string | The name of an existing kernel image that will be associated with this image | |
| min_disk integer | The minimum disk space (in GB) required to boot this image | |
| min_ram integer | The minimum ram (in MB) required to boot this image | |
| name string / required | The name of the image when uploading - or the name/ID of the image if deleting | |
| owner string | The owner of the image | |
| properties dictionary | Default: {} | Additional properties to be associated with this image |
| protected boolean |
| Prevent image from being deleted |
| ramdisk string | The name of an existing ramdisk image that will be associated with this image | |
| region_name string | Name of the region. | |
| state string |
| Should the resource be present or absent. |
| tags list / elements=string | Default: [] | List of tags to be applied to the image |
| timeout integer | Default: 180 | How long should ansible wait for the requested resource. |
| validate_certs boolean |
| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes.aliases: verify |
| volume string | ID of a volume to create an image from. The volume must be in AVAILABLE state. | |
| wait boolean |
| Should ansible wait until the requested resource is complete. |
Note
OS_USERNAME may be used instead of providing explicit values.# Upload an image from a local file named cirros-0.3.0-x86_64-disk.img
- openstack.cloud.image:
auth:
auth_url: https://identity.example.com
username: admin
password: passme
project_name: admin
openstack.cloud.identity_user_domain_name: Default
openstack.cloud.project_domain_name: Default
name: cirros
container_format: bare
disk_format: qcow2
state: present
filename: cirros-0.3.0-x86_64-disk.img
kernel: cirros-vmlinuz
ramdisk: cirros-initrd
tags:
- custom
properties:
cpu_arch: x86_64
distro: ubuntu
# Create image from volume attached to an instance
- name: create volume snapshot
openstack.cloud.volume_snapshot:
auth:
"{{ auth }}"
display_name: myvol_snapshot
volume: myvol
force: yes
register: myvol_snapshot
- name: create volume from snapshot
openstack.cloud.volume:
auth:
"{{ auth }}"
size: "{{ myvol_snapshot.snapshot.size }}"
snapshot_id: "{{ myvol_snapshot.snapshot.id }}"
display_name: myvol_snapshot_volume
wait: yes
register: myvol_snapshot_volume
- name: create image from volume snapshot
openstack.cloud.image:
auth:
"{{ auth }}"
volume: "{{ myvol_snapshot_volume.volume.id }}"
name: myvol_image
© 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/openstack/cloud/image_module.html