W3cubDocs

/Ansible

hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node module – Manages Hitachi SDS block storage system compute nodes.

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.sds_block.hv_sds_block_compute_node.

New in hitachivantara.vspone_block 3.0.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.

username

string / required

Username for authentication.

spec

dictionary / required

Specification for the compute node task.

host_nqns

list / elements=string

The array of NQN Initiators.

id

string

ID of the compute node.

iscsi_initiators

list / elements=string

The array of iSCSI Initiators.

name

string

Name of the compute node.

os_type

string

The OS type of the compute node.

should_delete_all_volumes

boolean

Will delete the volumes that are not attached to any compute node.

Choices:

  • false
  • true

state

string

The state of the compute node task.

Choices:

  • "add_iscsi_initiator"
  • "remove_iscsi_initiator"
  • "attach_volume"
  • "detach_volume"
  • "add_host_nqn"
  • "remove_host_nqn"

volumes

list / elements=string

The array of name of volumes.

state

string

The level of the compute node task. Choices are present and absent.

Choices:

  • "present" ← (default)
  • "absent"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Create compute node
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "computenode1"
      os_type: "VMWARE"
      iscsi_initiators: ["iqn.1991-05.com.hitachi:test-iscsi-iqn1", "iqn.1991-05.com.hitachi:test-iscsi-iqn2"]
      volumes: ["test-volume1", "test-volume2"]

- name: Delete compute node by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "3d971bb3-40fd-4cb5-bf68-2010b30aa74d"

- name: Delete compute node by name
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "computenode1"
      should_delete_all_volumes: true

- name: Update compute node name
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "3d971bb3-40fd-4cb5-bf68-2010b30aa74d"
      name: "computenode1a"
      os_type: "LINUX"

- name: Add iqn initiators to compute node
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      state: "add_iscsi_initiator"
      name: "computenode1"
      os_type: "VMWARE"
      iscsi_initiators: ["iqn.1991-05.com.hitachi:test-iscsi-iqn3", "iqn.1991-05.com.hitachi:test-iscsi-iqn4"]

- name: Remove iqn initiators from compute node
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      state: "remove_iscsi_initiator"
      name: "computenode1"
      os_type: "VMWARE"
      iscsi_initiators: ["iqn.1991-05.com.hitachi:test-iscsi-iqn3", "iqn.1991-05.com.hitachi:test-iscsi-iqn4"]

- name: Attach volumes to compute node
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      state: "attach_volume"
      name: "computenode1"
      volumes: ["test-volume3", "test-volume4"]

- name: Detach volumes from compute node
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_node:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      state: "detach_volume"
      name: "computenode1"
      volumes: ["test-volume3", "test-volume4"]

Return Values

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

Key

Description

compute_nodes

dictionary

Dictionary containing the discovered properties of the compute nodes.

Returned: always

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)

© 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/sds_block.hv_sds_block_compute_node_module.html