Documentation

os_user_role - Associate OpenStack Identity users and roles

New in version 2.1.

Synopsis

Grant and revoke roles in either project or domain context for OpenStack Identity Users.

Requirements (on host that executes module)

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

Options

parameter required default choices comments
api_timeout
 no None
    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
    		 no
      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
      		 no password
        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
        		 no
          Name of the availability zone.
          cacert
          		 no None
            A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
            cert
            		 no None
              A path to a client certificate to use as part of the SSL transaction
              cloud
              		 no
                Named cloud to operate against. 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.
                domain
                		 no
                  ID of the domain to scope the role association to. Valid only with keystone version 3, and required if project is not specified.
                  endpoint_type
                  		 no public
                  • public
                  • internal
                  • admin
                  Endpoint URL type to fetch from the service catalog.
                  group
                  		 no
                    Name or ID for the group. Valid only with keystone version 3. If group is not specified, then user is required. Both may not be specified.
                    key
                    		 no None
                      A path to a client key to use as part of the SSL transaction
                      project
                      		 no
                        Name or ID of the project to scope the role assocation to. If you are using keystone version 2, then this value is required.
                        region_name
                        		 no
                          Name of the region.
                          role
                          		 yes
                            Name or ID for the role.
                            state
                            		 no present
                            • present
                            • absent
                            Should the roles be present or absent on the user.
                            timeout
                            		 no 180
                              How long should ansible wait for the requested resource.
                              user
                              		 no
                                Name or ID for the user. If user is not specified, then group is required. Both may not be specified.
                                validate_certs
                                		 no True
                                  Whether or not SSL API requests should be verified.

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

                                  Examples

                                  # Grant an admin role on the user admin in the project project1
- os_user_role:
    cloud: mycloud
    user: admin
    role: admin
    project: project1

# Revoke the admin role from the user barney in the newyork domain
- os_user_role:
    cloud: mycloud
    state: absent
    user: barney
    role: admin
    domain: newyork

                                  Notes

                                  Note

                                  The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

                                  Note

                                  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

                                  This is an Extras Module

                                  For more information on what this means please read Extras Modules

                                  For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.