hitachivantara.vspone_block.vsp.hv_user_group_facts module – Retrieves user group information from 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_facts.

New in hitachivantara.vspone_block 3.3.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about user groups from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/user_group_facts.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	Specification for the user group facts to be gathered.
id string	The id of the specific user group to retrieve. Required for the Get User Group by ID task.
name string	The name of the specific user group to retrieve. Required for the Get User Group by name task.

Attributes

Attribute	Support	Description
check_mode	Support: full	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: Get all user groups for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Get user group by name for direct connection type
  hitachivantara.vspone_block.vsp.hv_user_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "my_user_group"

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key	Description
user_groups list / elements=dictionary	The user group information. Returned: success
has_all_resource_group boolean	Indicates whether the user group has 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 built-in. Returned: success Sample: `false`
name string	The name of the user group. Returned: success Sample: `"devGroup8"`
resource_group_ids list / elements=integer	The resource group IDs. Returned: success Sample: `[0, 8, 9, 1023]`
role_names list / elements=string	The role names. Returned: success Sample: `["Storage Administrator (Performance Management)", "Storage Administrator (Provisioning)"]`
users list / elements=string	The list of users belong to this user group. Returned: success Sample: `["oracle_sap", "RD-QA-User-14U-1"]`

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_facts_module.html