hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool_estimated_capacity_facts module – Obtains the preliminary calculation results of the storage pool logical capacity (unit TiB).

Note

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

New in hitachivantara.vspone_block 4.2.0

Synopsis

• Obtains the preliminary calculation results of the storage pool logical capacity (unit TiB) in the specified configuration and when adding resources or changing resources to the current configuration.

• For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/estimated_capacity_facts.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	Parameters for getting estimated capacity for specified configuration or updated configuration. This feature is available only with a Floating base license and for the AWS cloud model.
id string	The ID of the storage pool.
name string	The name of the storage pool.
number_of_drives integer / required	The number of drives for each storage node.
number_of_storage_nodes integer / required	The number of storage nodes.
number_of_tolerable_drive_failures integer / required	The number of drive failures that can be allowed.
query string / required	Whether the estimates is for current configuration or updated configuration. Choices: "specified_configuration" "updated_configuration"

Attributes

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

Examples

- name: Retrieve storage pool estimated capacity for specified configuration
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool_estimated_capacity_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "5b2d757a-ffec-42f0-979c-4d5d7b8af05e"
      number_of_storage_nodes: 2
      number_of_drives: 6
      number_of_tolerable_drive_failures: 0
      query: "specified_configuration"

- name: Retrieve storage pool estimated capacity for updated configuration
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool_estimated_capacity_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "5b2d757a-ffec-42f0-979c-4d5d7b8af05e"
      number_of_storage_nodes: 2
      number_of_drives: 6
      number_of_tolerable_drive_failures: 0
      query: "updated_configuration"

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
estimated_capacity dictionary	Dictionary of estimated_capacity. Returned: success
difference_capacit_in_tb integer	Difference pool capacity in TiB. Returned: success Sample: 3
estimated_pool_capacit_in_tb integer	Estimated pool capacity in TiB. Returned: success Sample: 3
number_of_drives integer	The number of drives for each storage node. Returned: success Sample: 6
number_of_storage_nodes integer	The number of storage nodes. Returned: success Sample: 2
number_of_tolerable_drive_failures integer	The number of drive failures that can be allowed. Returned: success Sample: 0

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)