vmware_object_role_permission – Manage local roles on an ESXi host¶
New in version 2.8.
Synopsis¶
This module can be used to manage object permissions on the given host.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
PyVmomi
Parameters¶
Notes¶
Note
Tested on ESXi 6.5, vSphere 6.7
The ESXi login user must have the appropriate rights to administer permissions.
Permissions for a distributed switch must be defined and managed on either the datacenter or a folder containing the switch.
Examples¶
- name: Assign user to VM folder
vmware_object_role_permission:
role: Admin
principal: user_bob
object_name: services
state: present
delegate_to: localhost
- name: Remove user from VM folder
vmware_object_role_permission:
role: Admin
principal: user_bob
object_name: services
state: absent
delegate_to: localhost
- name: Assign finance group to VM folder
vmware_object_role_permission:
role: Limited Users
group: finance
object_name: Accounts
state: present
delegate_to: localhost
- name: Assign view_user Read Only permission at root folder
vmware_object_role_permission:
role: ReadOnly
principal: view_user
object_name: rootFolder
state: present
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed
boolean
|
always |
whether or not a change was made to the object's role
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]