vmware_local_user_manager - Manage local users on an ESXi host¶

New in version 2.2.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Author

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 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 supported added in version 2.6.
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 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 supported 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 supported added in version 2.6.
state	Choices: present ← absent	Indicate desired state of the user. If the user already exists when `state=present`, the user 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 supported 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 supported 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.0
Be sure that the ESXi user used for login, has the appropriate rights to create / delete / edit users

Examples ¶

- name: Add local user to ESXi
  vmware_local_user_manager:
    hostname: esxi_hostname
    username: root
    password: vmware
    local_user_name: foo
  delegate_to: localhost

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 ¶

Andreas Nafpliotis (@nafpliot-ibm)

Hint

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