os_group_info – Retrieve info about one or more OpenStack groups

New in version 2.9.

Synopsis

  • Retrieve info about a one or more OpenStack groups.

Requirements

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

  • openstacksdk

  • openstacksdk >= 0.12.0

  • python >= 2.7

Parameters

Parameter Choices/Defaults 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, os_user_domain_name or os_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.
availability_zone
string
Ignored. Present for backwards compatibility
ca_cert
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
cloud
raw
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.
domain
string
Name or ID of the domain containing the group if the cloud supports domains
filters
dictionary
A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries.
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
name
string / required
Name or ID of the group.
region_name
string
Name of the region.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

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

Notes

Note

  • 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

# Gather info about previously created groups
- os_group_info:
    cloud: awesomecloud
  register: openstack_groups
- debug:
    var: openstack_groups

# Gather info about a previously created group by name
- os_group_info:
    cloud: awesomecloud
    name: demogroup
  register: openstack_groups
- debug:
    var: openstack_groups

# Gather info about a previously created group in a specific domain
- os_group_info:
    cloud: awesomecloud
    name: demogroup
    domain: admindomain
  register: openstack_groups
- debug:
    var: openstack_groups

# Gather info about a previously created group in a specific domain with filter
- os_group_info:
    cloud: awesomecloud
    name: demogroup
    domain: admindomain
    filters:
      enabled: False
  register: openstack_groups
- debug:
    var: openstack_groups

Return Values

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

Key Returned Description
openstack_groups
complex
always, but can be null
Dictionary describing all the matching groups.
 
description
string
success
Description of the group.
 
domain_id
boolean
success
Domain ID containing the group (keystone v3 clouds only)
 
id
string
success
Unique UUID.
 
name
string
success
Name given to the group.


Status

Authors

  • Phillipe Smith (@phsmith)

Hint

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