hitachivantara.vspone_block.sds_block.hv_sds_block_capacity_management_settings_facts module – Retrieves capacity management settings from VSP One SDS Block and Cloud system cluster.

Note

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

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

ca_cert

string

Path to a CA certificate file or directory on the Ansible control node used to verify the storage system SSL certificate.

Required when connection_info.validate_cert is true and the storage system uses a self-signed or privately issued certificate.

Accepts a PEM file path or a directory of hashed CA certificates.

client_cert

string

Path to client SSL certificate file or CA certificate directory for mutual TLS authentication.

Must be provided together with connection_info.client_key.

client_key

string

Path to the client private key file for mutual TLS authentication.

Must be provided together with connection_info.client_cert.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string / required

Password for authentication. This is a required field.

suppress_validate_cert_warning

boolean

Whether to suppress the SSL certificate validation warning.

When set to false (default), a warning is displayed if certificate validation is disabled.

Set to true to suppress the warning.

Choices:

  • false ← (default)

  • true

username

string / required

Username for authentication. This is a required field.

validate_cert

boolean

Whether to validate the storage system SSL certificate.

When set to false (default), certificate validation is disabled. A security warning will be displayed unless connection_info.suppress_validate_cert_warning is true.

Set to true to enable certificate validation. When true, provide connection_info.ca_cert if the storage system uses a self-signed certificate.

Note: Starting with major version 5.0, the default value will change to true. It is strongly recommended to enable certificate validation in production environments.

Choices:

  • false ← (default)

  • true

spec

dictionary

Parameters for filtering or identifying capacity management settings to gather facts about.

storage_controller_id

string

Filter capacity management settings by storage_controller ID. Required for the Get capacity management settings for the cluster and for a specific storage controller task.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Retrieve capacity management settings for the cluster and for all storage controllers
  hitachivantara.vspone_block.sds_block.hv_sds_block_capacity_management_settings_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve capacity management settings for the cluster and for a specific storage controller
  hitachivantara.vspone_block.sds_block.hv_sds_block_capacity_management_settings_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      storage_controller_id: "126f360e-c79e-4e75-8f7c-7d91bfd2f0b8"

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

capacity_management_settings

dictionary

Dictionary of capacity_management_settings.

Returned: success

is_storage_cluster_capacity_balancing_enabled

boolean

Capacity balancing settings of the storage cluster.

Returned: success

Sample: true

storage_controllers_capacity_balancing_settings

list / elements=dictionary

A list of storage controller capacity balancing output objects.

Returned: success

id

string

Storage controller ID.

Returned: success

Sample: "25244614-4af4-4922-839a-8528c9e4fd7f"

is_enabled

boolean

Specify whether to enable or disable capacity balancing of a storage controller. If this is enabled, capacity balancing applies to this storage controller. If this is disabled, capacity balancing does not apply to this storage controller.

Returned: success

Sample: true

status

string

Capacity balancing status of a storage controller. Either Enabled or Disabled.

Returned: success

Sample: "Enabled"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)