os_image – Add/Delete images from OpenStack Cloud — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# os_image – Add/Delete images from OpenStack Cloud

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Add or Remove images from the OpenStack Image Repository

## Requirements

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

- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7

## Parameters

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, os_user_domain_name or os_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 - |  | 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 - added in 2.5 |  | 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 - | Default: "bare" | The format of the container
disk_format - | Default: "qcow2" | The format of the disk that is getting uploaded
filename - |  | The path to the file which has to be uploaded
id - added in 2.4 |  | The ID of the image when uploading an image
interface string | Choices: admin internal public ← | Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
is_public boolean | Choices: no yes ← | Whether the image can be accessed publicly. Note that publicizing an image requires admin role by default.
kernel - |  | The name of an existing kernel image that will be associated with this image
min_disk - |  | The minimum disk space (in GB) required to boot this image
min_ram - |  | The minimum ram (in MB) required to boot this image
name - / required |  | The name of the image when uploading - or the name/ID of the image if deleting
owner - |  | The owner of the image
properties - | Default: {} | Additional properties to be associated with this image
protected boolean added in 2.9 | Choices: no ← yes | Prevent image from being deleted
ramdisk - |  | The name of an existing ramdisk image that will be associated with this image
region_name string |  | Name of the region.
state - | Choices: present ← absent | Should the resource be present or absent.
timeout integer | Default: 180 | How long should ansible wait for the requested resource.
validate_certs boolean | Choices: no ← yes | Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify
wait boolean | Choices: no yes ← | Should ansible wait until the requested resource is complete.

## Notes

Note

- The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values.
- Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

## Examples

    # Upload an image from a local file named cirros-0.3.0-x86_64-disk.img
    - os_image:
        auth:
          auth_url: https://identity.example.com
          username: admin
          password: passme
          project_name: admin
          os_user_domain_name: Default
          os_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
        properties:
          cpu_arch: x86_64
          distro: ubuntu

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Monty Taylor (@emonty)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.