community / community.vmware / 4.2.0 / module / vmware_host_user_manager Manage users of ESXi Authors: sky-joker (@sky-joker)community.vmware.vmware_host_user_manager (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can add, update or delete local users on ESXi host.
- name: Add new local user to ESXi host community.vmware.vmware_host_user_manager: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" validate_certs: false esxi_hostname: "{{ esxi1 }}" user_name: example user_description: "example user" user_password: "{{ local_user_password }}" state: present
- name: Update the local user password in ESXi host community.vmware.vmware_host_user_manager: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" validate_certs: false esxi_hostname: "{{ esxi1 }}" user_name: example user_description: "example user" user_password: "{{ local_user_password }}" override_user_password: true state: present
- name: Delete the local user in ESXi host community.vmware.vmware_host_user_manager: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" validate_certs: false esxi_hostname: "{{ esxi1 }}" user_name: example state: absent
port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int state: choices: - present - absent default: present description: - If set to V(present), add a new local user or update information. - If set to V(absent), delete the local user. type: str hostname: description: - 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 E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str user_name: aliases: - local_user_name description: - Name of the local user. required: true type: str proxy_host: description: - 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 E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - 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 E(VMWARE_PROXY_PORT) will be used instead. required: false type: int esxi_hostname: description: - Name of the ESXi host that is managing the local user. required: true type: str user_password: aliases: - local_user_password description: - The local user password. - If you'd like to update the password, requires O(override_user_password=true). type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool user_description: aliases: - local_user_description description: - The local user description. type: str override_user_password: default: false description: - If the local user exists and updates the password, change this parameter value is true. type: bool
msg: description: The executed result for the module. returned: always sample: "{\n \"msg\": \"Added the new user.\n}" type: str