hitachivantara.vspone_block.sds_block.hv_sds_block_user_group module – Create and update user groups on the storage system.

Note

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

New in hitachivantara.vspone_block 4.5.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.

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 the user group task.

external_group_name

string

Name of the group registered with an external authorization server when the external authorization server is linked.

id

string

The user group ID.

role_names

list / elements=string

Role of the user group. At least one role must be specified. This is a required field to create user group.

scope

list / elements=string

An array of the IDs of virtual private storages (VPSs) that the user group can access.

vps_id

string

The ID of the virtual private storage (VPS) that the user group belongs to.

vps_name

string

The name of the virtual private storage (VPS) that the user group belongs to.

state

string

The level of the user group task.

Choices:

  • "present" ← (default)

  • "absent"

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Create a new user group
  hitachivantara.vspone_block.sds_block.hv_sds_block_user_group:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      id: "vps_admin_4"
      role_names:
        - "Security"
        - "Storage"
        - "Monitor"
      vps_id: "system"
      scope:
        - "system"
        - "3ffcf3c6-5696-477e-bd0c-6a8d6ab4a0af"

- name: Update an existing user group
  hitachivantara.vspone_block.sds_block.hv_sds_block_user_group:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      id: "admin-vps02"
      role_names:
        - "Security"
        - "Storage"
        - "Monitor"
      scope:
        - "system"
        - "2a843522-a819-47ab-a208-69d190809604"
        - "ae0f247c-dc56-491c-9cb9-4b2b6d33b345"

- name: Delete a user group
  hitachivantara.vspone_block.sds_block.hv_sds_block_user_group:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      id: "admin-vps02"

Return Values

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

Key

Description

user_groups

dictionary

Information about a specific user group configured on the system.

Returned: success

external_group_name

string

Name of the external directory group (LDAP/AD) associated with this user group; empty for local groups.

Returned: success

Sample: ""

is_built_in

boolean

Whether the group is built-in (system-defined) or user-created.

Returned: success

Sample: false

member_users

list / elements=string

List of users that belong to this user 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

Operational scopes where the roles apply (e.g., ‘system’ or VPS IDs).

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 representing the user group in the management system.

Returned: success

Sample: "testG"

vps_id

string

Identifier of the VPS or system context associated with the user group.

Returned: success

Sample: "(system)"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)