W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_user module – Manages users on Hitachi VSP storage systems.

Note

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

New in hitachivantara.vspone_block 3.3.0

Synopsis

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.

password

string

Password for authentication. This is a required field.

username

string

Username for authentication. This is a required field.

spec

dictionary / required

Specification for the user.

authentication

string

The authentication method for the user. Required for user creation.

Choices:

  • "local" ← (default)
  • "external"

group_names

list / elements=string

User group name. You can specify up to 8 group names.

id

string

The ID of the user.

name

string

The name of the user.

password

string

The password of the user.

state

string

Operation to be performed on the user.

add_user_group - To add the user to the user groups.

remove_user_group - To remove the user from the user groups.

Choices:

  • "add_user_group"
  • "remove_user_group"

state

string

The desired state of the user task.

Choices:

  • "present" ← (default)
  • "absent"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Notes

Note

  • Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Create a User
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "devUser"
      authentication: "local"
      password: "devPassword"
      group_names: [
        "Audit Log Administrator (View Only) User Group",
        "Storage Administrator (View & Modify) User Group"]

- name: Change User Password by User Name
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "devUser"
      password: "devPassword3"

- name: Add Resource Groups to a User Group
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      state: add_user_group
      id: "devUser"
      group_names: ["devGroup3_new_4"]

- name: Remove User from  User Groups by User ID
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      state: remove_user_group
      id: "devUser"
      group_names: ["devGroup3_new_4"]

- name: Delete a User Group by ID
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: absent
    spec:
      id: "devUser"

Return Values

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

Key

Description

users

dictionary

The user information.

Returned: always

authentication

string

The authentication method.

Returned: success

Sample: "local"

group_names

list / elements=string

The user group names.

Returned: success

Sample: ["Audit Log Administrator (View Only) User Group", "Storage Administrator (View & Modify) User Group"]

id

string

The ID of the user.

Returned: success

Sample: "devUser"

is_account_status

boolean

The account status of the user.

Returned: success

Sample: true

is_built_in

boolean

The user is built-in or not.

Returned: success

Sample: false

name

string

The name of the user.

Returned: success

Sample: "devUser"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)

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