ovirt_permission_facts – Retrieve facts about one or more oVirt/RHV permissions
ovirt_permission_facts – Retrieve facts about one or more oVirt/RHV permissions
New in version 2.3.
Synopsis
- Retrieve facts about one or more oVirt/RHV permissions.
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:
| |
authz_name - / required |
Authorization provider of the user/group. In previous versions of oVirt/RHV known as domain.
| |
fetch_nested boolean added in 2.3 |
|
If yes 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 |
group_name - |
Name of the group to manage. | |
namespace - |
Namespace of the authorization provider, where user/group resides. | |
nested_attributes list added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
user_name - |
Username 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. |
Notes
Note
- This module creates a new top-level
ovirt_permissions
fact, which contains a list of permissions. - 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 facts about all permissions of user with username C(john):
- ovirt_permission_facts:
user_name: john
authz_name: example.com-authz
- debug:
var: ovirt_permissions
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_permissions list |
On success. |
List of dictionaries describing the permissions. Permission attributes are mapped to dictionary keys, all permissions attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/permission.
|
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.8/modules/ovirt_permission_facts_module.html