os_image - Add/Delete images from OpenStack Cloud

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
This is a Core Module

Synopsis

Add or Remove images from the OpenStack Image Repository

Requirements (on host that executes module)

python >= 2.7

shade

Options

parameter	required	default	choices	comments
api_timeout	no	None		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	no			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 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	no	password		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	no			Name of the availability zone.
cacert	no	None		A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert	no	None		A path to a client certificate to use as part of the SSL transaction
cloud	no			Named cloud to operate against. 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.
container_format	no	bare		The format of the container
disk_format	no	qcow2		The format of the disk that is getting uploaded
endpoint_type	no	public	public internal admin	Endpoint URL type to fetch from the service catalog.
filename	no	None		The path to the file which has to be uploaded
is_public	no	yes		Whether the image can be accessed publicly. Note that publicizing an image requires admin role by default.
kernel	no	None		The name of an existing kernel image that will be associated with this image
key	no	None		A path to a client key to use as part of the SSL transaction
min_disk	no	None		The minimum disk space (in GB) required to boot this image
min_ram	no	None		The minimum ram (in MB) required to boot this image
name	yes	None		Name that has to be given to the image
owner	no	None		The owner of the image
properties	no			Additional properties to be associated with this image
ramdisk	no	None		The name of an existing ramdisk image that will be associated with this image
region_name	no			Name of the region.
state	no	present	present absent	Should the resource be present or absent.
timeout	no	180		How long should ansible wait for the requested resource.
validate_certs	no	True		Whether or not SSL API requests should be verified. aliases: verify
wait	no	yes	yes no	Should ansible wait until the requested resource is complete.

Examples

# Upload an image from a local file named cirros-0.3.0-x86_64-disk.img
- os_image:
    auth:
      auth_url: http://localhost/auth/v2.0
      username: admin
      password: passme
      project_name: admin
    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

Notes

Note

The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

Note

Auth information is driven by os-client-config, 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 http://docs.openstack.org/developer/os-client-config

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.