Note
This plugin is part of the community.vmware collection (version 1.15.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_facts.
major release after 2021-12-01
Deprecated in favour of community.vmware.vmware_local_user_info module.
Use community.vmware.vmware_local_user_info instead.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| hostname string | 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 support added in Ansible 2.6. | |
| password string | 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 support added in Ansible 2.6. aliases: pass, pwd | |
| port integer | 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 support added in Ansible 2.6. |
| proxy_host string | 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 VMWARE_PROXY_HOST will be used instead.This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 | |
| proxy_port integer | 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 VMWARE_PROXY_PORT will be used instead. | |
| username string | 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 support added in Ansible 2.6. aliases: admin, user | |
| validate_certs boolean |
| 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 support added in Ansible 2.6. If set to true, please make sure Python >= 2.7.9 is installed on the given machine. |
Note
full_name, principal, and user_group properties are deprecated starting from Ansible v2.12- name: Gather facts about all Users on given ESXi host system
community.vmware.vmware_local_user_facts:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
delegate_to: localhost
register: all_user_facts
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| local_user_facts dictionary | always | metadata about all local users Sample: [{'description': 'Administrator', 'full_name': 'Administrator', 'group': False, 'principal': 'root', 'role': 'admin', 'shell_access': True, 'user_group': False, 'user_id': 0, 'user_name': 'root'}, {'description': 'DCUI User', 'full_name': 'DCUI User', 'group': False, 'principal': 'dcui', 'role': 'admin', 'shell_access': False, 'user_group': False, 'user_id': 100, 'user_name': 'dcui'}] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_local_user_facts_module.html