hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_bmc_connection module – Manages BMC connection settings for a storage node on VSP One SDS Block and Cloud systems.

Note

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

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_node_bmc_connection.

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 / required

Specification for the BMC connection settings.

bmc_name

string

The host name or IP address (IPv4) of the BMC. Required for the Update BMC connection information for one storage node by id /Update BMC connection information for one storage node by name tasks.

bmc_password

string

The password for BMC connection. Required for the Update BMC connection information for one storage node by id /Update BMC connection information for one storage node by name tasks.

bmc_user

string

The username for BMC connection. Required for the Update BMC connection information for one storage node by id /Update BMC connection information for one storage node by name tasks.

id

string

The UUID of the storage node. Required for the Update BMC connection information for one storage node by id task.

name

string

The name of the storage node. Required for the Update BMC connection information for one storage node by name task.

state

string

The desired state of the storage pool.

Choices:

  • "present" ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Update BMC connection information for one storage node by id
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_bmc_connection:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      id: "72ecacd0-1d4c-431c-80e8-80924a1b8f28"
      bmc_name: "10.76.45.222"
      bmc_user: "admin"
      bmc_password: "CHANGE_ME_SET_YOUR_PASSWORD"

- name: Update BMC connection information for one storage node by name
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_bmc_connection:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "SN01"
      bmc_name: "10.76.45.222"
      bmc_user: "admin"
      bmc_password: "CHANGE_ME_SET_YOUR_PASSWORD"

Return Values

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

Key

Description

storage_node_bmc_connection_information

dictionary

BMC connection information of the storage node.

Returned: always

bmc_name

string

The host name or IP address (IPv4) of the BMC. An empty string “” is output if nothing is set.

Returned: success

Sample: "10.164.118.96"

bmc_user

string

The username for BMC connection. An empty string “” is output if nothing is set.

Returned: success

Sample: "administrator@local,10.164.118.96-ptfm-endo_SN01"

id

string

Storage node ID.

Returned: success

Sample: "44f1d113-405e-448f-ad77-fd5554971c36"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)