W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_gateway_admin_password module – Updates password of gateway admin on Hitachi VSP storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.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.vsp.hv_gateway_admin_password.

New in hitachivantara.vspone_block 3.0.0

DEPRECATED

Removed in:

version 4.0.0

Why:

The connection type gateway is deprecated.

Alternative:

Not available.

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.

api_token

string / required

Token value to access UAI gateway. This is a required field for gateway connection type.

uai_gateway_address

string / required

IP address or hostname of UAI gateway.

spec

dictionary

Specification for updating admin password.

password

string / required

The new password value to be updated.

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Notes

Note

  • This module is deprecated and will be removed in a future release.

Examples

- name: Update password of UAI gateway admin
  hitachivantara.vspone_block.vsp.hv_gateway_admin_password:
    connection_info:
      uai_gateway_address: gateway.company.com
      api_token: "eyJhbGciOiJS......"
    spec:
      password: "changeMe!"

Return Values

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

Key

Description

data

string

Indicates whether gateway admin password task completed successfully or not.

Returned: success

Sample: "['Successfully updated apiadmin password']"

Status

  • This module will be removed in version 4.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_gateway_admin_password_module.html