hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node_facts module – Retrieves information about Hitachi SDS block storage system compute nodes.

Note

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

New in hitachivantara.vspone_block 3.0.0

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.8

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.

username

string / required

Username for authentication.

spec

dictionary

Specification for retrieving compute node information.

hba_name

string

A WWN or an iSCSI name.

names

list / elements=string

The names of the compute nodes.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Retrieve information about all compute nodes
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about compute nodes by hba_name
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      hba_name: 'iqn.1991-05.com.hitachi:test-iscsi-iqn1'

- name: Retrieve information about compute nodes by names
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      names: ['computenode1', 'computenode2']

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

compute_nodes

list / elements=dictionary

A list of compute nodes.

Returned: success

compute_node_info

dictionary

Information about the compute node.

Returned: success

id

string

Unique identifier for the compute node.

Returned: success

Sample: "ca1beba6-4392-4d21-a161-3e3e94fb45e2"

lun

integer

Logical Unit Number.

Returned: success

Sample: -1

nickname

string

Nickname of the compute node.

Returned: success

Sample: "spc-iqn.1994-05.com.redhat:5475aab33df5"

number_of_paths

integer

Number of paths.

Returned: success

Sample: -1

number_of_volumes

integer

Number of volumes.

Returned: success

Sample: 2

os_type

string

Operating system type.

Returned: success

Sample: "Linux"

paths

list / elements=dictionary

List of paths.

Returned: success

hba_name

string

HBA name.

Returned: success

Sample: "iqn.1994-05.com.redhat:5475aab33df5"

port_ids

list / elements=string

List of port IDs.

Returned: success

Sample: ["932962b5-ab61-429f-ba06-cd976e1a8f97", "181d4ed3-ae8a-418d-9deb-72a4eb1e2204", "0f13e320-53e7-4088-aa11-418636b58376"]

total_capacity_mb

integer

Total capacity in MB.

Returned: success

Sample: 90112

used_capacity_mb

integer

Used capacity in MB.

Returned: success

Sample: 4998

vps_id

string

VPS ID.

Returned: success

Sample: "(system)"

vps_name

string

VPS name.

Returned: success

Sample: "(system)"

volume_info

list / elements=dictionary

Information about the volumes.

Returned: success

id

string

Unique identifier for the volume.

Returned: success

Sample: "3ac02c92-05f0-4eba-9c00-3503afc18290"

name

string

Name of the volume.

Returned: success

Sample: "spc-a879277ec4"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)