hitachivantara.vspone_block.sds_block.hv_sds_block_user_facts module – Get users from the storage system

Note

This module is part of the hitachivantara.vspone_block collection (version 4.8.1).

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 hitachivantara.vspone_block. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_block.sds_block.hv_sds_block_user_facts.

New in hitachivantara.vspone_block 4.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

Get users from the storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_user_facts.yml

Requirements

The below requirements are needed on the host that executes this module.

python >= 3.9

Parameters

Parameter	Comments
connection_info dictionary / required	Information required to establish a connection to the storage system.
address string / required	IP address or hostname of the storage system.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary	Specification for retrieving user information.
id string	Filter users by ID (UUID format). Required for the Get one user by ID task.
vps_id string	Filter users by VPS ID (UUID format).
vps_name string	Filter users by VPS name.

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

- name: Retrieve information about all users
  hitachivantara.vspone_block.sds_block.hv_sds_block_user_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about user by specifying id
  hitachivantara.vspone_block.sds_block.hv_sds_block_user_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "1"

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key	Description
users dictionary	Dictionary describing a single user account entry. Returned: success
authentication string	Authentication method used by the user (e.g., local or LDAP). Returned: success Sample: `"local"`
is_built_in boolean	Indicates if the user is a built-in system account. Returned: success Sample: `true`
is_enabled boolean	Indicates if the user account is enabled. Returned: success Sample: `true`
is_enabled_console_login boolean	Indicates whether the user can log in to the console. Returned: success Sample: `true`
password_expiration_time string	Timestamp indicating when the password will expire. Returned: success Sample: `"2026-01-05T21:59:04Z"`
privileges list / elements=dictionary	List of privileges assigned to the user. Returned: success
role_names list / elements=string	Roles granted within the specified scope. Returned: success Sample: `["Audit", "Security", "Storage", "Monitor", "Service", "Resource", "RemoteCopy"]`
scope string	Scope to which the privileges apply. Returned: success Sample: `"system"`
role_names list / elements=string	List of roles assigned to the user. Returned: success Sample: `["Security", "Storage", "Monitor", "Service", "Audit", "Resource", "RemoteCopy"]`
user_groups list / elements=dictionary	List of groups the user belongs to. Returned: success
user_group_id string	ID of the user group. Returned: success Sample: `"SystemAdministrators"`
user_group_object_id string	Object ID of the user group. Returned: success Sample: `"SystemAdministrators"`
user_id string	Username of the account. Returned: success Sample: `"admin"`
user_object_id string	Unique object identifier for the user. Returned: success Sample: `"admin"`
vps_id string	VPS identifier associated with the user account. Returned: success Sample: `"(system)"`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/hitachivantara/vspone_block/sds_block.hv_sds_block_user_facts_module.html