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.9.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¶
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:
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)