You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

vmware_local_user_manager - Manage local users on an ESXi host¶

New in version 2.2.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis ¶

Manage local users on an ESXi host

Requirements (on host that executes module)¶

python >= 2.6

PyVmomi installed

Options ¶

parameter	required	default	choices	comments
hostname	yes			The hostname or IP address of the vSphere vCenter.
local_user_description	no			Description for the user
local_user_name	yes			The local user name to be changed
local_user_password	no			The password to be set
password	yes			The password of the vSphere vCenter. aliases: pass, pwd
state	no	present	present absent	Indicate desired state of the user. If the user already exists when `state=present`, the user info is updated
username	yes			The username of the vSphere vCenter. aliases: user, admin
validate_certs	no	True	True False	Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

Examples ¶

# Example vmware_local_user_manager command from Ansible Playbooks
- name: Add local user to ESXi
  local_action:
      module: vmware_local_user_manager
      hostname: esxi_hostname
      username: root
      password: vmware
      local_user_name: foo

Notes ¶

Note

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

Status ¶

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

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