Docs4dev
Docs
ansible / 2.6 / modules / vmware_local_role_manager_module.html

vmware_local_role_manager - Manage local roles on an ESXi host

New in version 2.5.

Synopsis

  • Manage local roles on an ESXi host

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
force_remove
bool
    Choices:
  • no ←
  • yes
If set to False then prevents the role from being removed if any permissions are using it.
hostname
str
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.
Environment variable support added in version 2.6.
local_privilege_ids Default:
[]
The list of privileges that role needs to have.
local_role_name
required
The local role name to be managed.
password
str
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.
Environment variable support added in version 2.6.

aliases: pass, pwd
port
int

(added in 2.5)
Default:
443
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.
Environment variable support added in version 2.6.
state
    Choices:
  • present ←
  • absent
Indicate desired state of the role.
If the role already exists when state=present, the role info is updated.
username
str
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.
Environment variable support added in version 2.6.

aliases: admin, user
validate_certs
bool
    Choices:
  • no
  • yes ←
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.
Environment variable support added in version 2.6.
If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

  • Tested on ESXi 6.5
  • Be sure that the ESXi user used for login, has the appropriate rights to create / delete / edit roles

Examples

# Example vmware_local_role_manager command from Ansible Playbooks
- name: Add local role to ESXi
  vmware_local_role_manager:
      hostname: esxi_hostname
      username: root
      password: vmware
      local_role_name: vmware_qa
      state: present

- name: Add local role with privileges to ESXi
  vmware_local_role_manager:
      hostname: esxi_hostname
      username: root
      password: vmware
      local_role_name: vmware_qa
      local_privilege_ids: [ 'Folder.Create', 'Folder.Delete']
      state: present

- name: Remove local role from ESXi
  vmware_local_role_manager:
      hostname: esxi_hostname
      username: root
      password: vmware
      local_role_name: vmware_qa
      state: absent

Return Values

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

Key Returned Description
local_role_name
string
always
Name of local role

new_privileges
list
on update
List of privileges of role after update

old_privileges
list
on update
List of privileges of role before update

role_id
int
always
ESXi generated local role id



Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

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.6/modules/vmware_local_role_manager_module.html