Documentation

ovirt_permissions_facts - Retrieve facts about one or more oVirt permissions

New in version 2.3.

Synopsis

  • Retrieve facts about one or more oVirt permissions.

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 [email protected]. 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.
authz_name
yes
Authorization provider of the user/group. In previous versions of oVirt 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.
group_name
no
Name of the the group to manage.
namespace
no
Namespace of the authorization provider, where user/group resides.
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.
user_name
no
Username of the the user to manage. In most LDAPs it's uid of the user, but in Active Directory you must specify UPN of the user.

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_permissions_facts:
    user_name: john
    authz_name: example.com-authz
- debug:
    var: ovirt_permissions

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
ovirt_permissions List of dictionaries describing the permissions. Permission attribues are mapped to dictionary keys, all permissions attributes can be found at following url: https://ovirt.example.com/ovirt-engine/api/model#types/permission. On success. list


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.0.0

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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