hitachivantara.vspone_block.sds_block.hv_sds_block_storage_controller module – Edits the settings for the storage controller on 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_storage_controller.

New in hitachivantara.vspone_block 4.2.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module edits the settings for the storage controller on VSP One SDS Block and Cloud systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_storage_controller.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	Specification for the storage controller.
id string	The ID of the storage controller. This field is required if name is not specified. Required for the Edit storage controller settings by storage controller ID task.
is_detailed_logging_mode boolean	Enable or disable the detailed logging mode. Required for the Edit storage controller settings for all storage controllers /Edit storage controller settings by storage controller ID tasks. Choices: `false` `true`
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: Edit storage controller settings for all storage controllers
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_controller:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      is_detailed_logging_mode: true

- name: Edit storage controller settings by storage controller ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_controller:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      id: "3f9bcecc-9ac5-4c21-abed-5b03e682e7b4"
      is_detailed_logging_mode: true

Return Values

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

Key	Description
storage_controllers dictionary	A list of storage controllers. Returned: always
data list / elements=dictionary	List of storage controller entries. Returned: success
active_storage_node_id string	UUID of the active storage node. Returned: success Sample: `"1a21c76d-614a-45e1-bd02-6bd2c18dddd7"`
allocatable_capacity integer	Total allocatable capacity in GB. Returned: success Sample: `4960200`
allocatable_capacity_usage_rate integer	Percentage of allocatable capacity used. Returned: success Sample: `0`
capacities_excluding_system_data dictionary	Capacity details excluding system data. Returned: success
compressed_capacity integer	Compressed capacity excluding system data. Returned: success Sample: `0`
pre_compressed_capacity integer	Pre-compressed capacity before optimization. Returned: success Sample: `0`
pre_used_capacity integer	Pre-used capacity before compression. Returned: success Sample: `0`
reclaimed_capacity integer	Reclaimed capacity excluding system data. Returned: success Sample: `0`
system_data_capacity integer	Capacity used by system data. Returned: success Sample: `0`
used_volume_capacity integer	Used volume capacity excluding system data. Returned: success Sample: `0`
capacity_status string	Status of capacity health. Returned: success Sample: `"Normal"`
currently_allocatable_capacity integer	Currently allocatable capacity in GB. Returned: success Sample: `4960200`
currently_allocatable_capacity_usage_rate integer	Percentage of currently allocatable capacity used. Returned: success Sample: `0`
data_rebalance_progress_rate integer	Progress rate of data rebalance in percentage. Returned: success
data_rebalance_status string	Current status of data rebalance operation. Returned: success Sample: `"Stopped"`
free_capacity integer	Free capacity available in GB. Returned: success Sample: `4960200`
id string	Unique identifier for the storage controller. Returned: success Sample: `"5f35a02e-a334-4489-8bbd-615fc130645d"`
is_detailed_logging_mode boolean	Indicates if detailed logging mode is enabled. Returned: success Sample: `true`
logical_limit integer	Logical limit of capacity usage. Returned: success Sample: `100765686`
meta_data_redundancy_of_cache_protection integer	Redundancy level for cache protection. Returned: success Sample: `1`
other_volume_capacity integer	Capacity used by other volume types. Returned: success Sample: `0`
pin_information any	Additional pin-related configuration or state. Returned: success
primary_fault_domain_id string	UUID of the primary fault domain. Returned: success Sample: `"05c3b302-9d43-448d-b0fa-3bbc64d0666d"`
provisioned_volume_capacity integer	Provisioned volume capacity. Returned: success Sample: `11264`
secondary_standby_storage_node_id string	UUID of the secondary standby node, if any. Returned: success
standby_storage_node_id string	UUID of the standby storage node. Returned: success Sample: `"c29454ed-8de1-4736-b234-73cc9143f78b"`
status string	Operational status of the storage controller. Returned: success Sample: `"Normal"`
temporary_volume_capacity integer	Capacity used by temporary volumes. Returned: success Sample: `0`
total_volume_capacity integer	Total volume capacity. Returned: success Sample: `11264`
udp_port integer	UDP port used by the storage controller. Returned: success Sample: `52001`
used_capacity integer	Used capacity in GB. Returned: success Sample: `0`
volume_maximum_capacity integer	Maximum volume capacity. Returned: success Sample: `100760142`

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_storage_controller_module.html