New in version 2.6.
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
added in 2.5 |
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.
|
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
yes , 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
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:
[{'group': False, 'description': 'Administrator', 'role': 'admin', 'full_name': 'Administrator', 'user_group': False, 'user_id': 0, 'shell_access': True, 'user_name': 'root', 'principal': 'root'}, {'group': False, 'description': 'DCUI User', 'role': 'admin', 'full_name': 'DCUI User', 'user_group': False, 'user_id': 100, 'shell_access': False, 'user_name': 'dcui', 'principal': 'dcui'}]
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.