os_image_facts - Retrieve facts about an image within OpenStack.

New in version 2.0.


  • Retrieve facts about a image image from OpenStack.

Requirements (on host that executes module)

  • python >= 2.6
  • python >= 2.7
  • shade


parameter required default choices comments
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.
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.
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.
Ignored. Present for backwards compatability
no None
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
no None
A path to a client certificate to use as part of the SSL transaction.
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.
no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
Name or ID of the image
no None
A path to a client key to use as part of the SSL transaction.
Name of the region.
no 180
How long should ansible wait for the requested resource.
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: verify
no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.


- name: Gather facts about a previously created image named image1
      username: user
      password: password
      project_name: someproject
    image: image1

- name: Show openstack facts
    var: openstack

Return Values

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

name description returned type sample
openstack_image has all the openstack facts about the image always, but can be null complex
name description returned type sample
status Image status. success string
deleted Image deleted flag. success boolean
container_format Container format of the image. success string
min_ram Min amount of RAM required for this image. success int
updated_at Image updated at timestamp. success string
min_disk Min amount of disk space required for this image. success int
owner Owner for the image. success string
is_public Is public flag of the image. success boolean
deleted_at Image deleted at timestamp. success string
properties Additional properties associated with the image. success dict
size Size of the image. success int
name Name given to the image. success string
checksum Checksum for the image. success string
created_at Image created at timestamp. success string
disk_format Disk format of the image. success string
id Unique UUID. success string
protected Image protected flag. success boolean



  • Facts are placed in the openstack variable.
  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • 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


This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.


This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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