community.vmware.vmware_object_role_permission module – Manage local roles on an ESXi host or vCenter

Note

This module is part of the community.vmware collection (version 4.7.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_object_role_permission.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module can be used to manage object permissions on the given host or vCenter.

Parameters

Parameter	Comments
group string	The group to be assigned permission. Required if `principal` is not specified.
hostname string	The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_HOST` will be used instead.
object_name string / required	The object name to assigned permission.
object_type string	The object type being targeted. Choices: `"Folder"` ← (default) `"VirtualMachine"` `"Datacenter"` `"ResourcePool"` `"Datastore"` `"Network"` `"HostSystem"` `"ComputeResource"` `"ClusterComputeResource"` `"DistributedVirtualSwitch"` `"DistributedVirtualPortgroup"` `"StoragePod"`
password aliases: pass, pwd string	The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_PASSWORD` will be used instead.
port integer	The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_PORT` will be used instead. Default: `443`
principal string	The user to be assigned permission. Required if `group` is not specified. If specifying domain user, required separator of domain uses backslash.
proxy_host string	Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable `VMWARE_PROXY_HOST` will be used instead.
proxy_port integer	Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable `VMWARE_PROXY_PORT` will be used instead.
recursive boolean	Should the permissions be recursively applied. Choices: `false` `true` ← (default)
role string / required	The role to be assigned permission. User can also specify role name presented in Web UI.
state string	Indicate desired state of the object’s permission. When `present`, the permission will be added if it doesn’t already exist. When `absent`, the permission is removed if it exists. Choices: `"present"` ← (default) `"absent"`
username aliases: admin, user string	The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_USER` will be used instead.
validate_certs boolean	Allows connection when SSL certificates are not valid. Set to `false` when certificates are not trusted. If the value is not specified in the task, the value of environment variable `VMWARE_VALIDATE_CERTS` will be used instead. Choices: `false` `true` ← (default)

Notes

Note

The 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.
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.

Examples

- name: Assign user to VM folder
  community.vmware.vmware_object_role_permission:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    role: Admin
    principal: user_bob
    object_name: services
    state: present
  delegate_to: localhost

- name: Remove user from VM folder
  community.vmware.vmware_object_role_permission:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    role: Admin
    principal: user_bob
    object_name: services
    state: absent
  delegate_to: localhost

- name: Assign finance group to VM folder
  community.vmware.vmware_object_role_permission:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    role: Limited Users
    group: finance
    object_name: Accounts
    state: present
  delegate_to: localhost

- name: Assign view_user Read Only permission at root folder
  community.vmware.vmware_object_role_permission:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    role: ReadOnly
    principal: view_user
    object_name: rootFolder
    state: present
  delegate_to: localhost

- name: Assign domain user to VM folder
  community.vmware.vmware_object_role_permission:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    role: Admin
    principal: "vsphere.local\\domainuser"
    object_name: services
    state: present
  delegate_to: localhost

Return Values

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

Key	Description
changed boolean	whether or not a change was made to the object’s role Returned: always

Authors

Derek Rushing (@kryptsi)
Joseph Andreatta (@vmwjoseph)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_object_role_permission_module.html