Note
This plugin is part of the openstack.cloud collection.
To install it use: ansible-galaxy collection install openstack.cloud.
To use it in a playbook, specify: openstack.cloud.os_user_role.
The below requirements are needed on the host that executes this module.
| 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, 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 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 to scope the role association to. Valid only with keystone version 3, and required if project is not specified. | |
| group string | 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. | |
| interface string |
| Endpoint URL type to fetch from the service catalog. aliases: endpoint_type |
| project string | Name or ID of the project to scope the role association to. If you are using keystone version 2, then this value is required. | |
| region_name string | Name of the region. | |
| role string / required | Name or ID for the role. | |
| state string |
| Should the roles be present or absent on the user. |
| timeout integer | Default: 180 | How long should ansible wait for the requested resource. |
| user string | Name or ID for the user. If user is not specified, then group is required. Both may not be specified. | |
| validate_certs boolean |
| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes.aliases: verify |
| wait boolean |
| Should ansible wait until the requested resource is complete. |
Note
OS_USERNAME may be used instead of providing explicit values.# Grant an admin role on the user admin in the project project1
- openstack.cloud.role_assignment:
cloud: mycloud
user: admin
role: admin
project: project1
# Revoke the admin role from the user barney in the newyork domain
- openstack.cloud.role_assignment:
cloud: mycloud
state: absent
user: barney
role: admin
domain: newyork
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_user_role_module.html