hitachivantara.vspone_block.sds_block.hv_sds_block_user_group_facts module – Get user groups from 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_group_facts.

New in hitachivantara.vspone_block 4.4.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

Get users from the storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_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.
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 retrieving user group information.
id string	Filter user groups by ID (UUID format).
vps_id string	Filter user groups by VPS ID.
vps_name string	Filter user groups by VPS name.

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

- name: Retrieve information about all user groups
  hitachivantara.vspone_block.sds_block.hv_sds_block_user_group_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about user group by specifying id
  hitachivantara.vspone_block.sds_block.hv_sds_block_user_group_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin_group"
      password: "password"
    spec:
      id: "1"

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 dictionary	User group details. Returned: success
external_group_name string	Name of the external directory group, if applicable. Returned: success Sample: `""`
is_built_in boolean	Indicates whether the user group is a built-in system group. Returned: success Sample: `false`
member_users list / elements=string	List of users who are members of the group. Returned: success Sample: `[]`
role_names list / elements=string	List of roles assigned to the user group. Returned: success Sample: `["Security", "Storage", "Monitor", "Service", "Audit"]`
scope list / elements=string	List of scopes where the group roles are applicable. Returned: success Sample: `["system"]`
user_group_id string	Unique identifier of the user group. Returned: success Sample: `"testG"`
user_group_object_id string	Object ID of the user group. Returned: success Sample: `"testG"`
vps_id string	Virtual Partition System (VPS) identifier associated with the group. 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_group_facts_module.html