hitachivantara.vspone_block.vsp.hv_user_group module – Manages user groups on VSP block storage systems.

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.vsp.hv_user_group.

New in hitachivantara.vspone_block 3.3.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module allows the creation and deletion of user groups on VSP block storage systems.
It also enables adding or removing resource groups to/from the user group.
This module is supported for direct connection types.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/user_group.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 group.
id string	The ID of the user group. Required for the Change User Group Name /Add Resource Groups to a User Group /Remove Resource Groups from a User Group /Delete User Group by ID /Add roles to a user group /Remove roles from a user group tasks.
name string	The name of the user group. Required for the Create a User Group /Change User Group Name /Delete User Group by name tasks.
resource_group_ids list / elements=integer	List of resource group IDs to be added or removed from the user group. The following six role names has access to all the resource groups, so this field will be ignored if you specify any one of them in the role_names field. AUDIT_LOG_ADMIN_VIEW_N_MODIFY AUDIT_LOG_ADMIN_VIEW_ONLY SECURITY_ADMIN_VIEW_N_MODIFY SECURITY_ADMIN_VIEW_ONLY SUPPORT_PERSONNEL USER_MAINTENANCE Optional for the Create a User Group /Add Resource Groups to a User Group /Remove Resource Groups from a User Group tasks.
role_names list / elements=string	The role name. Specify one or more of the following role names. AUDIT_LOG_ADMIN_VIEW_N_MODIFY AUDIT_LOG_ADMIN_VIEW_ONLY SECURITY_ADMIN_VIEW_N_MODIFY SECURITY_ADMIN_VIEW_ONLY STORAGE_ADMIN_INIT_CONFIG STORAGE_ADMIN_LOCAL_COPY STORAGE_ADMIN_PERF_MGMT STORAGE_ADMIN_PROVISION STORAGE_ADMIN_REMOTE_COPY STORAGE_ADMIN_SYS_RESOURCE_MGMT STORAGE_ADMIN_VIEW_ONLY SUPPORT_PERSONNEL USER_MAINTENANCE Optional for the Create a User Group /Add roles to a user group /Remove roles from a user group tasks.
state string	Operation to be performed on the resource groups in the user group. `add_resource_group` - To add resource groups to the user group. `remove_resource_group` - To remove resource groups from the user group. `add_role` - To add roles to the user group. `remove_role` - To remove roles from the user group. Required for the Add Resource Groups to a User Group /Remove Resource Groups from a User Group /Add roles to a user group /Remove roles from a user group tasks. Choices: `"add_resource_group"` `"remove_resource_group"` `"add_role"` `"remove_role"`
state string	The desired state of the user group 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 Group for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "devGroup"
      role_names: ["STORAGE_ADMIN_PERF_MGMT", "STORAGE_ADMIN_PROVISION"]
      resource_group_ids: [8, 9]

- name: Change User Group Name for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      id: "devGroup3_new_3"
      name: "devGroup3_new_4"

- name: Add Resource Groups to a User Group for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      state: add_resource_group
      id: "devGroup3"
      resource_group_ids: [1, 2]

- name: Remove Resource Groups from a User Group for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      state: remove_resource_group
      id: "devGroup3"
      resource_group_ids: [1, 2]

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

Return Values

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

Key	Description
user_groups dictionary	The user group information. Returned: always
has_all_resource_group boolean	Indicates whether the user group has access to all resource groups. Returned: success Sample: `false`
id string	The ID of the user group. Returned: success Sample: `"devGroup8"`
is_built_in boolean	Indicates whether the user group is a built-in user group. Returned: success Sample: `false`
name string	The name of the user group. Returned: success Sample: `"devGroup8"`
resource_group_ids list / elements=integer	The list of resource group IDs. Returned: success Sample: `[0, 8, 9, 1023]`
role_names list / elements=string	The list of role names. Returned: success Sample: `["Storage Administrator (Performance Management)", "Storage Administrator (Provisioning)"]`

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/vsp.hv_user_group_module.html