You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

openstack.cloud.identity_user module – Manage OpenStack Identity Users

Note

This module is part of the openstack.cloud collection (version 1.10.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.identity_user.

Synopsis

• Manage OpenStack Identity users. Users can be created, updated or deleted using this module. A user will be updated if name matches an existing user and state is present. The value for name cannot be updated without deleting and re-creating the user.

Requirements

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

• openstacksdk

• openstacksdk >= 0.36, < 0.99.0

• python >= 3.6

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.
availability_zone string	Ignored. Present for backwards compatibility
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.
default_project string	Project name or ID that the user should be associated with by default
description string	Description about the user
domain string	Domain to create the user in if the cloud supports domains
email string	Email address for the user
enabled boolean	Is the user enabled Choices: false true ← (default)
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
name string / required	Username for the user
password string	Password for the user
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
state string	Should the resource be present or absent. Choices: "present" ← (default) "absent"
timeout integer	How long should ansible wait for the requested resource. Default: 180
update_password string	always will attempt to update password. on_create will only set the password for newly created users. Choices: "always" "on_create" ← (default)
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: false true
wait boolean	Should ansible wait until the requested resource is complete. Choices: false true ← (default)

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

# Create a user
- openstack.cloud.identity_user:
    cloud: mycloud
    state: present
    name: demouser
    password: secret
    email: [email protected]
    domain: default
    default_project: demo

# Delete a user
- openstack.cloud.identity_user:
    cloud: mycloud
    state: absent
    name: demouser

# Create a user but don't update password if user exists
- openstack.cloud.identity_user:
    cloud: mycloud
    state: present
    name: demouser
    password: secret
    update_password: on_create
    email: [email protected]
    domain: default
    default_project: demo

# Create a user without password
- openstack.cloud.identity_user:
    cloud: mycloud
    state: present
    name: demouser
    email: [email protected]
    domain: default
    default_project: demo

Return Values

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

Key	Description
user dictionary	Dictionary describing the user. Returned: On success when state is ‘present’
default_project_id string	User default project ID. Only present with Keystone >= v3. Returned: success Sample: "4427115787be45f08f0ec22a03bfc735"
description string	The description of this user Returned: success Sample: "a user"
domain_id string	User domain ID. Only present with Keystone >= v3. Returned: success Sample: "default"
email string	User email address Returned: success Sample: "demo@example.com"
enabled boolean	Indicates whether the user is enabled Returned: success
id string	User ID Returned: success Sample: "f59382db809c43139982ca4189404650"
name string	Unique user name, within the owning domain Returned: success Sample: "demouser"
username string	Username with Identity API v2 (OpenStack Pike or earlier) else Null Returned: success

Authors

• OpenStack Ansible SIG

Collection links

Issue Tracker Repository (Sources)