os_image_info – Retrieve information about an image within OpenStack¶
Synopsis¶
- Retrieve information about a image image from OpenStack.
- This module was called os_image_factsbefore Ansible 2.9, returningansible_facts. Note that the os_image_info module no longer returnsansible_facts!
Aliases: os_image_facts
Requirements¶
The below requirements are needed on the host that executes this module.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Parameters¶
Notes¶
Note
- The standard OpenStack environment variables, such as OS_USERNAMEmay 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¶
- name: Gather information about a previously created image named image1
  os_image_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    image: image1
  register: result
- name: Show openstack information
  debug:
    msg: "{{ result.openstack_image }}"
# Show all available Openstack images
- name: Retrieve all available Openstack images
  os_image_info:
  register: result
- name: Show images
  debug:
    msg: "{{ result.openstack_image }}"
# Show images matching requested properties
- name: Retrieve images having properties with desired values
  os_image_facts:
    properties:
      some_property: some_value
      OtherProp: OtherVal
- name: Show images
  debug:
    msg: "{{ result.openstack_image }}"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Davide Agnello (@dagnello)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
