hitachivantara.vspone_block.sds_block.hv_sds_block_storage_controller module – Edits the settings for the storage controller on Hitachi SDS Block storage systems.

Note

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

New in hitachivantara.vspone_block 4.2.0

Synopsis

• This module edits the settings for the storage controller 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/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.
is_detailed_logging_mode boolean	Enable or disable the detailed logging mode. 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_pools dictionary	A list of storage pools. Returned: always
storage_controllers list / elements=dictionary	List of storage controller entries. Returned: success
activeStorageNodeId string	UUID of the active storage node. Returned: success Sample: "7eb3f987-804f-4bc5-9d40-aff9392d507d"
allocatableCapacity integer	Total allocatable capacity in GB. Returned: success Sample: 0
allocatableCapacityUsageRate integer	Percentage of allocatable capacity used. Returned: success Sample: 0
capacitiesExcludingSystemData dictionary	Capacity details excluding system data. Returned: success
compressedCapacity integer	Compressed capacity excluding system data. Returned: success Sample: 0
preCompressedCapacity integer	Pre-compressed capacity before optimization. Returned: success Sample: 0
preUsedCapacity integer	Pre-used capacity before compression. Returned: success Sample: 0
reclaimedCapacity integer	Reclaimed capacity excluding system data. Returned: success Sample: 0
systemDataCapacity integer	Capacity used by system data. Returned: success Sample: 0
usedVolumeCapacity integer	Used volume capacity excluding system data. Returned: success Sample: 0
capacityStatus string	Status of capacity health. Returned: success Sample: "Normal"
currentlyAllocatableCapacity integer	Currently allocatable capacity in GB. Returned: success Sample: 0
currentlyAllocatableCapacityUsageRate integer	Percentage of currently allocatable capacity used. Returned: success Sample: 0
dataRebalanceProgressRate integer	Progress rate of data rebalance in percentage. Returned: success
dataRebalanceStatus string	Current status of data rebalance operation. Returned: success Sample: "Stopped"
freeCapacity integer	Free capacity available in GB. Returned: success Sample: 0
id string	Unique identifier for the storage controller. Returned: success Sample: "25244614-4af4-4922-839a-8528c9e4fd7f"
isDetailedLoggingMode boolean	Indicates if detailed logging mode is enabled. Returned: success Sample: false
logicalLimit integer	Logical limit of capacity usage. Returned: success Sample: 0
metaDataRedundancyOfCacheProtection integer	Redundancy level for cache protection. Returned: success Sample: 1
otherVolumeCapacity integer	Capacity used by other volume types. Returned: success Sample: 0
pinInformation any	Additional pin-related configuration or state. Returned: success
primaryFaultDomainId string	UUID of the primary fault domain. Returned: success Sample: "355d32ce-c97f-4adf-9057-49d2e287974b"
provisionedVolumeCapacity integer	Provisioned volume capacity. Returned: success Sample: 0
secondaryStandbyStorageNodeId string	UUID of the secondary standby node, if any. Returned: success
standbyStorageNodeId string	UUID of the standby storage node. Returned: success Sample: "a8056f21-e4ee-4e3a-a139-bee4de98d8c7"
status string	Operational status of the storage controller. Returned: success Sample: "Normal"
temporaryVolumeCapacity integer	Capacity used by temporary volumes. Returned: success Sample: 0
totalVolumeCapacity integer	Total volume capacity. Returned: success Sample: 0
usedCapacity integer	Used capacity in GB. Returned: success Sample: 0
volumeMaximumCapacity integer	Maximum volume capacity. Returned: success Sample: 0

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)