hitachivantara.vspone_block.sds_block.hv_sds_block_user module – Create and update users from storage system

Note

This module is part of the hitachivantara.vspone_block collection (version 4.3.0).

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.

New in hitachivantara.vspone_block 4.1.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 to be added to or updated in storage.

authentication

string

Authentication method for the user.

Choices:

  • "local" ← (default)

  • "external"

current_password

string

Current password for the user.

is_enabled_console_login

boolean

Whether the user can log in to the console.

Choices:

  • false

  • true ← (default)

new_password

string

New password for the user.

password

string

Password for the user.

user_group_ids

list / elements=string

List of user group IDs to which the user belongs.

user_id

string

User ID (username) to be created or updated.

state

string

The level of the user task.

Choices:

  • "present" ← (default)

  • "update"

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Create a new user
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      user_id: "new_user"
      password: "CHANGE_ME_SET_YOUR_PASSWORD"
      user_group_ids:
        - "admin_group"
      authentication: "local"
      is_enabled_console_login: true

- name: Update an existing user password
  hitachivantara.vspone_block.sds_block.hv_sds_block_user:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: update
    spec:
      user_id: "existing_user"
      current_password: "CHANGE_ME_SET_YOUR_PASSWORD"
      new_password: "CHANGE_ME_SET_YOUR_PASSWORD"

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

data

list / elements=dictionary

List of user account entries.

Returned: success

authentication

string

Authentication method used by the user (e.g., local or LDAP).

Returned: success

Sample: "local"

isBuiltIn

boolean

Indicates if the user is a built-in system account.

Returned: success

Sample: true

isEnabled

boolean

Indicates if the user account is enabled.

Returned: success

Sample: true

isEnabledConsoleLogin

boolean

Indicates whether the user can log in to the console.

Returned: success

passwordExpirationTime

string

Timestamp indicating when the password will expire.

Returned: success

Sample: "2022-11-30T07:21:21Z"

privileges

list / elements=dictionary

List of privileges assigned to the user.

Returned: success

roleNames

list / elements=string

Roles granted within the specified scope.

Returned: success

Sample: ["Audit", "Security", "Storage", "Monitor", "Service", "Resource"]

scope

string

Scope to which the privileges apply.

Returned: success

Sample: "system"

roleNames

list / elements=string

List of roles assigned to the user.

Returned: success

Sample: ["Security", "Storage", "Monitor", "Service", "Audit", "Resource"]

userGroups

list / elements=dictionary

List of groups the user belongs to.

Returned: success

userGroupId

string

ID of the user group.

Returned: success

Sample: "SystemAdministrators"

userGroupObjectId

string

Object ID of the user group.

Returned: success

Sample: "SystemAdministrators"

userId

string

Username of the account.

Returned: success

Sample: "admin"

userObjectId

string

Unique object identifier for the user.

Returned: success

Sample: "admin"

vpsId

string

VPS identifier associated with the user account.

Returned: success

Sample: "(system)"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)