community.vmware.vmware_local_user_facts module – Gather facts about users on the given ESXi host

Note

This module is part of the community.vmware collection (version 1.18.2).

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.

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

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

aliases: pass, pwd

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.

port

integer

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.

Default: 443

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

aliases: admin, user

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.

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.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • Tested on ESXi 6.5

  • The full_name, principal, and user_group properties are deprecated starting from Ansible v2.12

  • All modules requires API write access and hence is not supported on a free ESXi license.

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

Description

local_user_facts

dictionary

metadata about all local users

Returned: always

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)