os_user_facts - Retrieve facts about one or more OpenStack users

New in version 2.1.

Synopsis

  • Retrieve facts about a one or more OpenStack users

Requirements

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

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

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.
domain Default:
None
Name or ID of the domain containing the user if the cloud supports domains
filters Default:
None
A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries.
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.
name
required
Name or ID of the user
region_name
Name of the region.
timeout Default:
180
How long should ansible wait for the requested resource.
verify
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: validate_certs
wait
    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 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

# Gather facts about previously created users
- os_user_facts:
    cloud: awesomecloud
- debug:
    var: openstack_users

# Gather facts about a previously created user by name
- os_user_facts:
    cloud: awesomecloud
    name: demouser
- debug:
    var: openstack_users

# Gather facts about a previously created user in a specific domain
- os_user_facts:
    cloud: awesomecloud
    name: demouser
    domain: admindomain
- debug:
    var: openstack_users

# Gather facts about a previously created user in a specific domain with filter
- os_user_facts:
    cloud: awesomecloud
    name: demouser
    domain: admindomain
    filters:
      enabled: False
- debug:
    var: openstack_users

Return Values

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

Key Returned Description
openstack_users
complex
 always, but can be null
has all the OpenStack facts about users
username
string
 success
Username of the user
domain_id
string
 success
Domain ID containing the user
name
string
 success
Name given to the user.
id
string
 success
Unique UUID.
enabled
bool
 success
Flag to indicate if the user is enabled
email
string
 success
Email of the user
default_project_id
string
 success
Default project ID of the user


Status

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

Author

  • Ricardo Carrillo Cruz (@rcarrillocruz)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/os_user_facts_module.html