Documentation

vmware_local_user_manager - Manage local users on an ESXi host

New in version 2.2.

Synopsis

  • Manage local users on an ESXi host

Requirements

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

  • python >= 2.6
  • PyVmomi installed

Parameters

Parameter
Choices/Defaults
Comments
hostname
required
The hostname or IP address of the vSphere vCenter.
local_user_description
Description for the user.
local_user_name
required
The local user name to be changed.
local_user_password
The password to be set.
password
required
The password of the vSphere vCenter.

aliases: pass, pwd
port
(added in 2.5)
Default:
443
The port number of the vSphere vCenter or ESXi server.
state
    Choices:
  • present ←
  • absent
Indicate desired state of the user. If the user already exists when state=present, the user info is updated
username
required
The username of the vSphere vCenter.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

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

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

Status

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

Author

  • Andreas Nafpliotis

Hint

If you notice any issues in this documentation you can edit this document to improve it.