hitachivantara.vspone_block.sds_block.hv_sds_block_compute_port module – Manages compute ports in VSP One SDS Block and Cloud systems.

Note

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

New in hitachivantara.vspone_block 4.3.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module allows to change the settings and protocol of the compute port on Hitachi SDS Block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/compute_port.yml

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 compute port.
id string	The ID of the compute port. Required for the Edit compute port settings task.
name string	The name of the compute port. Required for the Edit compute port settings task.
nickname aliases: nick_name string	The nickname of the compute port. Required for the Edit compute port settings task.
protocol string	The protocol of the compute port. Required for the Change the compute port protocol (Bare metal only) task. Choices: `"iscsi"` `"nvme_tcp"`
state string	The desired state of the compute port. Choices: `"present"` ← (default)

Attributes

Attribute	Support	Description
check_mode	Support: none	Determines if the module should run in check mode.

Examples

- name: Expand storage pool by pool name
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "expand"
    spec:
      name: "SP01"
      drive_ids: ["6a14d3cb-264f-41b1-81c0-cdbfab73d358"]

- name: Edit compute port settings
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "expand"
    spec:
      id: "3f9bcecc-9ac5-4c21-abed-5b03e682e7b4"
      drive_ids: ["6a14d3cb-264f-41b1-81c0-cdbfab73d358"]

Return Values

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

Key	Description
compute_ports dictionary	Detailed information about the port. Returned: always
configured_port_speed string	Configured port speed. Returned: success Sample: `"Auto"`
fc_information dictionary	Fibre Channel information. Returned: success Sample: `""`
id string	Unique identifier for the port. Returned: success Sample: `"932962b5-ab61-429f-ba06-cd976e1a8f97"`
interface_name string	Name of the interface. Returned: success Sample: `"eth2"`
iscsi_information dictionary	iSCSI information. Returned: success
delayed_ack boolean	Indicates if delayed ACK is enabled. Returned: success Sample: `true`
ip_mode string	IP mode. Returned: success Sample: `"ipv4"`
ipv4_information dictionary	IPv4 information. Returned: success
address string	IPv4 address. Returned: success Sample: `"10.76.34.51"`
default_gateway string	Default gateway. Returned: success Sample: `"10.76.34.1"`
subnet_mask string	Subnet mask. Returned: success Sample: `"255.255.255.0"`
ipv6_information dictionary	IPv6 information. Returned: success
default_gateway string	Default gateway. Returned: success Sample: `""`
global_address1 string	Global address 1. Returned: success Sample: `""`
global_address_mode string	Global address mode. Returned: success Sample: `"Manual"`
linklocal_address string	Link-local address. Returned: success Sample: `""`
linklocal_address_mode string	Link-local address mode. Returned: success Sample: `"Auto"`
subnet_prefix_length1 integer	Subnet prefix length 1. Returned: success Sample: `0`
is_isns_client_enabled boolean	Indicates if iSNS client is enabled. Returned: success Sample: `false`
isns_servers list / elements=dictionary	List of iSNS servers. Returned: success
index integer	Index of the iSNS server. Returned: success Sample: `1`
port integer	Port of the iSNS server. Returned: success Sample: `3205`
server_name string	Name of the iSNS server. Returned: success Sample: `""`
mac_address string	MAC address. Returned: success Sample: `"b4:96:91:c8:75:bc"`
mtu_size integer	MTU size. Returned: success Sample: `9000`
name string	Name of the port. Returned: success Sample: `"iqn.1994-04.jp.co.hitachi:rsd.sph.t.0a85a.000"`
nickname string	Nickname of the port. Returned: success Sample: `"000-iSCSI-000"`
nvme_tcp_information dictionary	NVMe over TCP information. Returned: success
port_speed string	Port speed. Returned: success Sample: `"25G"`
port_speed_duplex string	Port speed duplex. Returned: success Sample: `"25Gbps Full"`
protection_domain_id string	Protection domain ID. Returned: success Sample: `"645c36b6-da9e-44bb-b711-430e06c7ad2b"`
protocol string	Protocol used by the port. Returned: success Sample: `"iSCSI"`
status string	Status of the port. Returned: success Sample: `"Normal"`
status_summary string	Summary of the port status. Returned: success Sample: `"Normal"`
storage_node_id string	Storage node ID. Returned: success Sample: `"01f598b8-dc1c-45fc-b821-5ea108d42593"`
type string	Type of the port. Returned: success Sample: `"Universal"`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

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