ovirt_user_info – Retrieve information about one or more oVirt/RHV users
ovirt_user_info – Retrieve information about one or more oVirt/RHV users
Synopsis
- Retrieve information about one or more oVirt/RHV users.
- This module was called
ovirt_user_facts
before Ansible 2.9, returningansible_facts
. Note that the ovirt_user_info module no longer returnsansible_facts
!
Aliases: ovirt_user_facts
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth dictionary / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
fetch_nested boolean |
|
If yes the module will fetch additional data from the API. It will fetch only IDs of nested entity. It doesn't fetch multiple levels of nested attributes. Only the attributes of the current entity. User can configure to fetch other attributes of the nested entities by specifying |
nested_attributes list |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
pattern - |
Search term which is accepted by oVirt/RHV search backend. For example to search user X use following pattern: name=X |
Notes
Note
- This module returns a variable
ovirt_users
, which contains a list of users. You need to register the result with the register keyword to use it. - 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.3.0
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather information about all users which first names start with C(john):
- ovirt_user_info:
pattern: name=john*
register: result
- debug:
msg: "{{ result.ovirt_users }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_users list |
On success. |
List of dictionaries describing the users. User attributes are mapped to dictionary keys, all users attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Ondra Machacek (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ovirt_user_info_module.html