hitachivantara.vspone_block.sds_block.hv_sds_block_storage_software_update module – Manages software update and downgrade on VSP One SDS Block and Cloud systems.

Note

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

New in hitachivantara.vspone_block 4.3.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 storage software update.

is_software_downgrade

boolean

Whether to perform storage software downgrade. Required for the Downgrade the storage software task.

Choices:

  • false ← (default)

  • true

should_stop_software_update

boolean

Should stop storage software update. Required for the Stop updating the storage software task.

Choices:

  • false ← (default)

  • true

software_update_file

string

The update file of the storage software to be transferred to the storage cluster. Required for the Upload the storage software update file task.

state

string

The desired state of the storage pool.

Choices:

  • "present" ← (default)

  • "software_update_file_present"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Update the storage software
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_software_update:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Downgrade the storage software
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_software_update:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      should_stop_software_update: true

- name: Upload the storage software update file
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_software_update:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      software_update_file: "/root/sdsb_sw_update/hsds-update-01170140-0007.tar"

- name: Downgrade the storage software
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_software_update:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      is_software_downgrade: true

Return Values

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

Key

Description

message

dictionary

Success or failure message for the storage software update.

Returned: always

Sample: "Successfully downgraded software. ID for this job = 822bd1fa-c5ee-4bea-a47d-f178146248cb."

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)