New in version 2.8.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| administrative boolean |
| Defines the role as administrative-only or not. | |
| auth dictionary / required | Dictionary with values needed to create HTTP/HTTPS connection to oVirt: | ||
| ca_file string | 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. | ||
| headers dictionary | Dictionary of HTTP headers to be added to each API call. | ||
| hostname string | A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by OVIRT_HOSTNAME environment variable.Either url or hostname is required. | ||
| insecure boolean |
| A boolean flag that indicates if the server TLS certificate and host name should be checked. | |
| kerberos boolean |
| A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. | |
| password string / required | The password of the user. Default value is set by OVIRT_PASSWORD environment variable. | ||
| token string | Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable. | ||
| url string | A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable.Either url or hostname is required. | ||
| username string / required | The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable. | ||
| description - | Description of the role. | ||
| fetch_nested boolean |
| 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. | |
| id - | ID of the role to manage. | ||
| name - | Name of the role to manage. | ||
| nested_attributes list | Specifies list of the attributes which should be fetched from the API. This parameter apply only when fetch_nested is true. | ||
| permits - | List of permits which role will have Permit 'login' is default and all roles will have it. List can contain name of permit. | ||
| poll_interval integer | Default: 3 | Number of the seconds the module waits until another poll request on entity status is sent. | |
| state - |
| Should the role be present/absent. | |
| timeout integer | Default: 180 | The amount of time in seconds the module should wait for the instance to get into desired state. | |
| wait boolean |
| yes if the module should wait for the entity to get into desired state. | |
Note
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create administrative role with two permits
- ovirt_role:
name: role
administrative: true
permits:
- manipulate_permissions
- create_instance
# Remove role
- ovirt_role:
name: role
state: absent
# Remove all permit
- ovirt_role:
name: role
administrative: ture
permits:
- login
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| ovirt_role list | On success. | List of dictionaries describing the Roles. Role attributes are mapped to dictionary keys, all Roles attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/role. |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 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_role_module.html