hitachivantara.vspone_block.vsp.hv_external_paritygroup_facts module – Retrieves information about External Parity Group from Hitachi VSP storage systems.

Note

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

New in hitachivantara.vspone_block 3.5.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 retrieving External Parity Group information.

external_parity_group

string

The external parity group ID. Required for the Get a specific external parity group task.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Notes

Note

  • Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Retrieve information about all External Parity Groups
  hitachivantara.vspone_block.vsp.hv_external_path_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"

- name: Retrieve information about a specific External Parity Groups
  hitachivantara.vspone_block.vsp.hv_external_path_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"
    spec:
      external_parity_group: "1-1"

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

external_parity_groups

list / elements=dictionary

List of external parity group detail dicts.

Returned: success

available_volume_capacity_gb

integer

Available capacity in GB.

Returned: success

Sample: 13

available_volume_capacity_mb

integer

Available capacity in MB.

Returned: success

Sample: 13312

clpr_id

integer

CLPR identifier.

Returned: success

Sample: 0

emulation_type

string

Emulation type of the external storage.

Returned: success

Sample: "OPEN-V"

external_parity_group_id

string

External parity group ID.

Returned: success

Sample: "1-1"

external_path_group_id

integer

Associated external path group id.

Returned: success

Sample: -1

external_product_id

string

Product identifier of the external storage.

Returned: success

Sample: "OPEN-V"

external_serial_number

string

Serial number of the external storage (may be empty).

Returned: success

Sample: ""

external_storage_product_id

string

External storage product id (if any).

Returned: success

Sample: ""

num_of_ldevs

integer

Number of LDEVs in the external parity group.

Returned: success

Sample: 7

spaces

list / elements=dictionary

Free space and LDEVs defined in the external parity group.

Returned: success

Sample: []

storage_serial_number

string

Storage serial number.

Returned: success

Sample: "810045"

used_capacity_rate

integer

Usage rate of the external parity group (percentage).

Returned: success

Sample: 35

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)