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

Note

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

• This module allows the creation and deletion of users on VSP block storage systems.

• It also enables add/remove user to/from the user groups.

• For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/user.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.
api_token string	Token used to operate on locked resources.
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. Optional for the Create a User Account /Add User to User Groups by User ID /Add User to User Groups by User Name /Remove User from User Groups by User ID /Remove User from User Groups by Name tasks.
id string	The ID of the user. Required for the Change User Password by User ID /Add User to User Groups by User ID /Remove User from User Groups by User ID /Delete User by ID tasks.
name string	The name of the user. Required for the Create a User Account /Change User Password by User Name /Add User to User Groups by User Name /Remove User from User Groups by Name /Delete User by name tasks.
password string	The password of the user. Required for the Create a User Account /Change User Password by User ID /Change User Password by User Name tasks.
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. Required for the Add User to User Groups by User ID /Add User to User Groups by User Name /Remove User from User Groups by User ID /Remove User from User Groups by Name tasks. 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: "CHANGE_ME_SET_YOUR_PASSWORD"
      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: "CHANGE_ME_SET_YOUR_PASSWORD"

- 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"
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"
user_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"]

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)