Documentation

os_image_facts - Retrieve facts about an image within OpenStack.

New in version 2.0.

Synopsis

  • Retrieve facts about a image image from OpenStack.

Requirements

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

  • openstacksdk
  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments
api_timeout
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 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
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
cacert
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
A path to a client certificate to use as part of the SSL transaction.
cloud
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.
image
Name or ID of the image
interface
(added in 2.3)
    Choices:
  • public ←
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
key
A path to a client key to use as part of the SSL transaction.
region_name
Name of the region.
timeout Default:
180
How long should ansible wait for the requested resource.
verify
bool
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: validate_certs
wait
bool
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

Notes

Note

  • 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 http://docs.openstack.org/developer/os-client-config

Examples

- name: Gather facts about a previously created image named image1
  os_image_facts:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    image: image1

- name: Show openstack facts
  debug:
    var: openstack_image

# Show all available Openstack images
- name: Retrieve all available Openstack images
  os_image_facts:

- name: Show images
  debug:
    var: openstack_image

Return Values

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

Key Returned Description
openstack_image
complex
always, but can be null
has all the openstack facts about the image

  status
string
success
Image status.

  deleted
boolean
success
Image deleted flag.

  container_format
string
success
Container format of the image.

  min_ram
int
success
Min amount of RAM required for this image.

  updated_at
string
success
Image updated at timestamp.

  min_disk
int
success
Min amount of disk space required for this image.

  owner
string
success
Owner for the image.

  is_public
boolean
success
Is public flag of the image.

  deleted_at
string
success
Image deleted at timestamp.

  properties
dict
success
Additional properties associated with the image.

  size
int
success
Size of the image.

  name
string
success
Name given to the image.

  checksum
string
success
Checksum for the image.

  created_at
string
success
Image created at timestamp.

  disk_format
string
success
Disk format of the image.

  id
string
success
Unique UUID.

  protected
boolean
success
Image protected flag.



Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Davide Agnello (@dagnello)

Hint

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