W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_storagesystem_facts module – retrieves storage system information from Hitachi VSP storage systems.

Note

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

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

api_token

string

This field is used to pass the value of the lock token to operate on locked resources.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string

Password for authentication. This is a required field if api_token is not provided.

username

string

Username for authentication. This is a required field if api_token is not provided.

spec

dictionary

Specification for the storage system facts to be gathered.

query

list / elements=string

Additional information to be gathered.

Choices:

  • "ports"
  • "quorumdisks"
  • "journalPools"
  • "freeLogicalUnitList"

storage_system_info

dictionary

Information about the storage system. This field is an optional field.

serial

string

The serial number of the storage system.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Notes

Note

  • The input parameter refresh was removed in version 3.4.0. They were deprecated due to internal API simplification and are no longer supported.
  • Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Get Storage System facts
  hitachivantara.vspone_block.vsp.hv_storagesystem_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Get Storage System using query
  hitachivantara.vspone_block.vsp.hv_storagesystem_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      query: ["ports", "quorumdisks", "journalPools", "freeLogicalUnitList"]

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

storage_system_info

dictionary

The storage system information.

Returned: always

controller_address

string

IP address of the controller.

Returned: success

Sample: "192.168.1.101"

device_limits

dictionary

Limits for various device parameters.

Returned: success

external_group_number_range

dictionary

Range for external group numbers.

Returned: success

is_valid

boolean

Indicates if the range is valid.

Returned: success

Sample: true

max_value

integer

Maximum value of the range.

Returned: success

Sample: 255

min_value

integer

Minimum value of the range.

Returned: success

Sample: 1

external_group_sub_number_range

dictionary

Range for external group sub-numbers.

Returned: success

is_valid

boolean

Indicates if the range is valid.

Returned: success

Sample: true

max_value

integer

Maximum value of the range.

Returned: success

Sample: 255

min_value

integer

Minimum value of the range.

Returned: success

Sample: 1

parity_group_number_range

dictionary

Range for parity group numbers.

Returned: success

is_valid

boolean

Indicates if the range is valid.

Returned: success

Sample: true

max_value

integer

Maximum value of the range.

Returned: success

Sample: 1

min_value

integer

Minimum value of the range.

Returned: success

Sample: 1

parity_group_sub_number_range

dictionary

Range for parity group sub-numbers.

Returned: success

is_valid

boolean

Indicates if the range is valid.

Returned: success

Sample: true

max_value

integer

Maximum value of the range.

Returned: success

Sample: 32

min_value

integer

Minimum value of the range.

Returned: success

Sample: 1

free_capacity

string

Free capacity of the storage system.

Returned: success

Sample: "15.92 TB"

free_capacity_in_mb

integer

Free capacity in megabytes.

Returned: success

Sample: 16696806

free_gad_consistency_group_id

integer

Free GAD consistency group ID.

Returned: success

Sample: -1

free_local_clone_consistency_group_id

integer

Free local clone consistency group ID.

Returned: success

Sample: 2

free_remote_clone_consistency_group_id

integer

Free remote clone consistency group ID.

Returned: success

Sample: 3

health_description

string

Description of the health status.

Returned: success

Sample: ""

health_status

string

Health status of the storage system.

Returned: success

Sample: "Normal"

management_address

string

Management IP address of the storage system.

Returned: success

Sample: "192.168.1.100"

microcode_version

string

Microcode version of the storage system.

Returned: success

Sample: "83-05-02/00"

model

string

Model of the storage system.

Returned: success

Sample: "VSP_5100H"

operational_status

string

Operational status of the storage system.

Returned: success

Sample: "Normal"

resource_state

string

Resource state of the storage system.

Returned: success

Sample: "Healthy"

serial_number

string

Serial number of the storage system.

Returned: success

Sample: "811150"

syslog_config

dictionary

Syslog configuration of the storage system.

Returned: success

detailed

boolean

Indicates if detailed logging is enabled.

Returned: success

Sample: true

syslog_servers

list / elements=dictionary

List of syslog servers.

Returned: success

id

integer

ID of the syslog server.

Returned: success

Sample: 1

syslog_server_address

string

Address of the syslog server.

Returned: success

Sample: "192.168.0.187"

syslog_server_port

integer

Port of the syslog server.

Returned: success

Sample: 514

total_capacity

string

Total capacity of the storage system.

Returned: success

Sample: "27.62 TB"

total_capacity_in_mb

integer

Total capacity in megabytes.

Returned: success

Sample: 28958728

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)

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