community.vmware.vmware_local_user_facts – Gather facts about users on the given ESXi host
community.vmware.vmware_local_user_facts – Gather facts about users on the given ESXi host
Note
This plugin is part of the community.vmware collection (version 1.7.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_local_user_facts
.
DEPRECATED
- Removed in
- major release after 2021-12-01
- Why
- Deprecated in favour of community.vmware.vmware_local_user_info module.
- Alternative
- Use community.vmware.vmware_local_user_info instead.
Synopsis
- This module can be used to gather facts about users present on the given ESXi host system in VMware infrastructure.
- All variables and VMware object names are case sensitive.
- User must hold the ‘Authorization.ModifyPermissions’ privilege to invoke this module.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
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 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 Environment variable support added in Ansible 2.6.
| |
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 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 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 | |
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 Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to |
Notes
Note
- Tested on ESXi 6.5
- The
full_name
,principal
, anduser_group
properties are deprecated starting from Ansible v2.12
Examples
- 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
Return Values
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'}] |
Status
- This module will be removed in a major release after 2021-12-01. [deprecated]
- For more information see DEPRECATED.
Authors
- Abhijeet Kasurde (@Akasurde)
- Christian Kotte (@ckotte)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_local_user_facts_module.html