openstack.cloud.resources module – List OpenStack cloud resources

Note

This module is part of the openstack.cloud collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install openstack.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: openstack.cloud.resources.

Synopsis

  • List OpenStack cloud resources.

Requirements

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

Parameters

Parameter

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, user_domain_name or 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.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

any

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.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

parameters

dictionary

Query parameters passed to OpenStack API for results filtering.

attributes is a set of key-value pairs where each key is a attribute name such as id and value holds its corresponding attribute value such ddad2d86-02a6-444d-80ae-1cc2fb023784.

For a complete list of valid query parameters open any resource class inside openstacksdk such as file openstack/compute/v2/server.py in https://opendev.org/openstack/openstacksdk/ and consult variable _query_mapping.

region_name

string

Name of the region.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "INFO" ← (default)

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

service

string / required

OpenStack service which this resource is part of.

Examples are block_storage, compute or network.

service must be a lowercase name of a OpenStack service as used in openstacksdk. For a list of available services visit https://opendev.org/openstack/openstacksdk: Most subdirectories in the openstack directory correspond to a OpenStack service, except cloud, common and other auxiliary directories.

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

type

string / required

Typename of the resource.

Examples are ip, network, router or server.

type must be a lowercase name of a openstacksdk resource class. Resource classes are defined in openstacksdk’s service folders. For example, visit https://opendev.org/openstack/openstacksdk, change to openstack directory, change to any service directory such as compute, choose a api version directory such as v2 and find all available resource classes such as Server inside *.py files.

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to true.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (default)

Notes

Note

  • This module does not support all OpenStack cloud resources. Resource handling must follow openstacksdk’s CRUD structure using and providing a <service>.<type>s function. The module will fail if this function cannot be found.

  • 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

- name: List images
  openstack.cloud.resources:
    cloud: devstack-admin
    service: image
    type: image
  register: images

- name: Identify CirrOS image id
  set_fact:
    image_id: "{{
      images.resources|community.general.json_query(query)|first }}"
  vars:
    query: "[?starts_with(name, 'cirros')].id"

- name: List compute flavors
  openstack.cloud.resources:
    cloud: devstack-admin
    service: compute
    type: flavor
  register: flavors

- name: Identify m1.tiny flavor id
  set_fact:
    flavor_id: "{{
      flavors.resources|community.general.json_query(query)|first }}"
  vars:
    query: "[?name == 'm1.tiny'].id"

- name: List public network
  openstack.cloud.resources:
    cloud: devstack-admin
    service: network
    type: network
    parameters:
      name: public

Return Values

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

Key

Description

resources

list / elements=dictionary

Dictionary describing the identified OpenStack cloud resources.

Returned: always

Authors

  • OpenStack Ansible SIG