vmware_local_user_facts – Gather facts about users on the given ESXi host¶
New in version 2.6.
DEPRECATED¶
Removed in Ansible: | |
---|---|
version: 2.13 | |
Why: | Deprecated in favour of _info module. |
Alternative: | Use 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
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 version 2.13. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Abhijeet Kasurde (@Akasurde)
- Christian Kotte (@ckotte)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.