ovirt_users - Module to manage users in oVirt/RHV
New in version 2.3.
Synopsis
- Module to manage users in oVirt/RHV.
Requirements (on host that executes module)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| auth | yes | Dictionary with values needed to create HTTP/HTTPS connection to oVirt: username[required] - The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable.password[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable.url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable.token - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable.insecure - A boolean flag that indicates if the server TLS certificate and host name should be checked.ca_file - A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If `ca_file` parameter is not set, system wide CA certificate store is used. Default value is set by OVIRT_CAFILE environment variable.kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.headers - Dictionary of HTTP headers to be added to each API call. | ||
| authz_name | yes | Authorization provider of the user. In previous versions of oVirt/RHV known as domain. aliases: domain | ||
| fetch_nested (added in 2.3)
| no | If True the module will fetch additional data from the API. It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying nested_attributes. | ||
| name | yes | Name of the user to manage. In most LDAPs it's uid of the user, but in Active Directory you must specify UPN of the user. | ||
| nested_attributes (added in 2.3)
| no | Specifies list of the attributes which should be fetched from the API. This parameter apply only when fetch_nested is true. | ||
| poll_interval | no | 3 | Number of the seconds the module waits until another poll request on entity status is sent. | |
| state | no | present |
| Should the user be present/absent. |
| timeout | no | 180 | The amount of time in seconds the module should wait for the instance to get into desired state. | |
| wait | no |
True if the module should wait for the entity to get into desired state. |
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Add user user1 from authorization provider example.com-authz
ovirt_users:
name: user1
domain: example.com-authz
# Add user user1 from authorization provider example.com-authz
# In case of Active Directory specify UPN:
ovirt_users:
name: [email protected]
domain: example.com-authz
# Remove user user1 with authorization provider example.com-authz
ovirt_users:
state: absent
name: user1
authz_name: example.com-authz
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| id | ID of the user which is managed | On success if user is found. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| user | Dictionary of all the user attributes. User attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user. | On success if user is found. | dict |
Notes
Note
- In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.0.0
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_users_module.html