community.vmware.vmware_local_user_manager module – Manage local users on an ESXi host
Note
This module is part of the community.vmware collection (version 4.8.0).
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_local_user_manager
.
Synopsis
Manage local users on an ESXi host
Parameters
Parameter |
Comments |
---|---|
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 |
|
Description for the user. |
|
The local user name to be changed. |
|
The password to be set. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
Indicate desired state of the user. If the user already exists when Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
Be sure that the ESXi user used for login, has the appropriate rights to create / delete / edit users
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: Add local user to ESXi
community.vmware.vmware_local_user_manager:
hostname: esxi_hostname
username: root
password: vmware
local_user_name: foo
local_user_password: password
delegate_to: localhost