vmware.vmware_rest.appliance_localaccounts_info module – Gather information about local accounts on the vCenter Server Appliance.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.0).

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 vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.appliance_localaccounts_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about local user accounts on the vCenter Server Appliance.

  • When username is provided, return the detailed properties of that single account, such as its full name, email, assigned roles, and password aging settings.

  • When username is omitted, list all local accounts on the appliance.

Parameters

Parameter

Comments

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

username

string

The name of the local account to retrieve detailed information for.

When omitted, information about all local accounts on the appliance is returned.

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: List all local accounts on the appliance
  vmware.vmware_rest.appliance_localaccounts_info:
  register: all_accounts

- name: Get information about a single local account
  vmware.vmware_rest.appliance_localaccounts_info:
    username: root
  register: root_account

- name: Display the roles assigned to the account
  ansible.builtin.debug:
    var: root_account.value.roles

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

string

The name of the queried local account.

Returned: When only one account, identified by username, was queried

Sample: "root"

info

list / elements=dictionary

A list of detailed information about local accounts on the appliance.

Returned: When username is not provided

Sample: [{"enabled": true, "fullname": "root", "has_password": true, "roles": ["superAdmin"]}]

value

dictionary

Detailed information about a single local account.

Returned: When only one account, identified by username, was queried

Sample: {"email": "admin@example.com", "enabled": true, "fullname": "root", "has_password": true, "last_password_change": "2026-06-01T00:00:00.000Z", "max_days_between_password_change": 90, "min_days_between_password_change": 1, "roles": ["superAdmin"], "warn_days_before_password_expiration": 7}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)