hitachivantara.vspone_block.sds_block.hv_sds_block_user module – Create and update users from storage system

Note

This module is part of the hitachivantara.vspone_block collection (version 4.4.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 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.

New in hitachivantara.vspone_block 4.1.0

Synopsis

• Create and update users from storage system.

• For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_users.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 the user task.
authentication string	Authentication method for the user. Choices: "local" ← (default) "external"
current_password string	Current password for the user.
is_enabled_console_login boolean	Whether the user can log in to the console. Choices: false true ← (default)
new_password string	New password for the user.
password string	Password for the user.
user_group_ids list / elements=string	List of user group IDs to which the user belongs.
user_id string	The user ID (username) whose information is to be retrieved.
state string	The level of the user task. Choices: "present" ← (default) "update"

Attributes

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

Examples

- name: Create a new user
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      user_id: "new_user"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
      user_group_ids:
        - "admin_group"
      authentication: "local"
      is_enabled_console_login: true

- name: Update an existing user password
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: update
    spec:
      user_id: "existing_user"
      current_password: "CHANGE_ME_SET_YOUR_PASSWORD"
      new_password: "CHANGE_ME_SET_YOUR_PASSWORD"

Return Values

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

Key	Description
users dictionary	Details of the user retrieved or managed by the module. Returned: always
authentication string	Type of authentication for the user. Returned: success Sample: "local"
is_built_in boolean	Indicates if the user is a built-in system user. Returned: success Sample: false
is_enabled boolean	Indicates if the user account is enabled. Returned: success Sample: true
is_enabled_console_login boolean	Indicates if console login is allowed for the user. Returned: success Sample: true
password_expiration_time string	Expiration time of the user’s password in ISO 8601 format. Returned: success Sample: "2025-10-17T17:49:42Z"
privileges list / elements=dictionary	List of privileges assigned to the user. Returned: success
role_names list / elements=string	List of role names assigned in this privilege. Returned: success Sample: ["Security", "Monitor"]
scope string	Scope of the privilege. Returned: success Sample: "system"
role_names list / elements=string	Roles assigned to the user. Returned: success Sample: ["Security", "Monitor"]
user_groups list / elements=dictionary	User groups the user belongs to. Returned: success
user_group_id string	Identifier of the user group. Returned: success Sample: "SecurityAdministrators"
user_group_object_id string	Object ID of the user group. Returned: success Sample: "SecurityAdministrators"
user_id string	Unique ID of the user. Returned: success Sample: "radey1"
user_object_id string	Object ID of the user. Returned: success Sample: "radey1"
vps_id string	ID of the VPS or system the user belongs to. Returned: success Sample: "(system)"

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)