hitachivantara.vspone_block.vsp.hv_clpr_facts module – Retrieves information about clprs from VSP block storage systems.

Note

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

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about clprs from VSP block storage systems.
It provides details about CLPR such as ID, status and other relevant information.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/clpr_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.
api_token string	Token used 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.
username string	Username for authentication. This is a required field.
spec dictionary	Specification for retrieving clpr information.
clpr_id integer	CLPR id. Required for Get one CLPR using clpr_id.
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 output parameters entitlement_status, subscriber_id and partner_id were removed in version 3.4.0. They were also 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: Retrieve information about all clprs
  hitachivantara.vspone_block.vsp.hv_clpr_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"

    storage_system_info:
      serial: 811150

- name: Retrieve information about a specific clpr
  hitachivantara.vspone_block.vsp.hv_clpr_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      clpr_id: 274

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
clprs list / elements=dictionary	List of CLPR objects. Returned: success
cache_memory_capacity_in_gb float	Cache memory capacity in gigabytes. Returned: success Sample: `498.0`
cache_memory_capacity_in_mb integer	Cache memory capacity in megabytes. Returned: success Sample: `509952`
cache_memory_used_capacity_in_gb float	Used cache memory capacity in gigabytes. Returned: success Sample: `9.6162109375`
cache_memory_used_capacity_in_mb integer	Used cache memory capacity in megabytes. Returned: success Sample: `9847`
cache_usage_rate integer	Cache usage rate as percentage. Returned: success Sample: `2`
clpr_id integer	CLPR ID. Returned: success Sample: `0`
clpr_name string	Name of the CLPR. Returned: success Sample: `"CLPR0"`
side_files_capacity_in_gb float	Side files capacity in gigabytes. Returned: success Sample: `0.0`
side_files_capacity_in_mb integer	Side files capacity in megabytes. Returned: success Sample: `0`
side_files_usage_rate integer	Side files usage rate as percentage. Returned: success Sample: `0`
write_pending_data_capacity_in_gb float	Write pending data capacity in gigabytes. Returned: success Sample: `0.0595703125`
write_pending_data_capacity_in_mb integer	Write pending data capacity in megabytes. Returned: success Sample: `61`
write_pending_data_rate integer	Write pending data rate as percentage. Returned: success Sample: `1`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

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