hitachivantara.vspone_block.sds_block.hv_sds_block_user module – Create and update users on 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.

New in hitachivantara.vspone_block 4.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Create and update users on the 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. Required for the Create a user task. Choices: `"local"` ← (default) `"external"`
current_password string	Current password for the user. Required for the Update user password task.
id aliases: user_id string	The user ID. This is an alias of user_id. Required for the Create a user /Update user password tasks.
is_enabled boolean	Enables or disables the user. Choices: `false` `true` ← (default)
is_enabled_console_login boolean	Whether the user can log in to the console. Required for the Create a user task. Choices: `false` `true` ← (default)
new_password string	New password for the user. Required for the Update user password task.
password string	Password for the user. Required for the Create a user task.
user_group_ids list / elements=string	List of user group IDs to which the user belongs. Required for the Create a user task.
state string	The level of the user task. Choices: `"present"` ← (default) `"update"` `"absent"` `"add_user_group"` `"remove_user_group"`

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_NEW_PASSWORD"

- name: Update user settings
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
    state: present
    spec:
      id: "radey-vps02-admin-5"
      password: "CHANGE_ME_SET_YOUR_NEW_PASSWORD"
      is_enabled: false

- name: Delete a user
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
    state: absent
    spec:
      id: "radey-vps02-admin-4"

- name: Add user to user groups
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
    state: add_user_group
    spec:
      id: "radey-admin"
      user_group_ids: ["admin_4", "admin_1"]

- name: Remove user to user groups
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
    state: remove_user_group
    spec:
      id: "radey-admin"
      user_group_ids: ["admin_4", "admin_1"]

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-11-27T10:35:36Z"`
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: `"testqw"`
user_object_id string	Object ID of the user. Returned: success Sample: `"testqw"`
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

© 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_module.html