hitachivantara.vspone_block.vsp.hv_clpr module – Manages CLPRs on 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.

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module manages Cache Logical Partitions (CLPRs) on VSP block storage systems.
Supports creating, updating, deleting CLPRs.
Create CLPR to logically partition cache memory, isolating workloads.

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.
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary / required	Specification for the CLPR operation.
cache_memory_capacity_mb integer	Cache memory capacity in MB. Required for Create and Update tasks. For VSP 5000 series storage systems, specify a multiple of 4096. For other storage systems, specify a multiple of 2048.
clpr_id integer	ID of the CLPR. Required for Update and Delete tasks.
clpr_name string	Name of the CLPR. Required for Create and Update tasks.
state string	The desired state of the CLPR. Choices: `"present"` ← (default) `"absent"` `"update"`

Attributes

Attribute	Support	Description
check_mode	Support: none	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: Create CLPR
  hitachivantara.vspone_block.vsp.hv_clpr:
    connection_info:
      address: "{{ storage_address }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: present
    spec:
      clpr_name: "CLPRDEV"
      cache_memory_capacity_mb: 12288

- name: Update CLPR cache capacity
  hitachivantara.vspone_block.vsp.hv_clpr:
    connection_info:
      address: "{{ storage_address }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: update
    spec:
      clpr_id: 1
      cache_memory_capacity_mb: 24576

- name: Delete CLPR
  hitachivantara.vspone_block.vsp.hv_clpr:
    connection_info:
      address: "{{ storage_address }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: absent
    spec:
      clpr_id: 1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
clpr_info dictionary	Details of the CLPR operation Returned: on success
cache_memory_capacity_in_gb float	Cache memory capacity in GB Returned: success Sample: `12.0`
cache_memory_capacity_in_mb integer	Cache memory capacity in MB Returned: success Sample: `12288`
cache_memory_used_capacity_in_gb float	Used cache memory in GB Returned: success Sample: `0.0`
cache_memory_used_capacity_in_mb integer	Used cache memory in MB Returned: success Sample: `0`
cache_usage_rate integer	Cache usage rate percentage Returned: success Sample: `0`
clpr_id integer	CLPR ID Returned: success Sample: `3`
clpr_name string	CLPR name Returned: success Sample: `"CLPRDEV34"`
side_files_capacity_in_gb float	Side files capacity in GB Returned: success Sample: `0.0`
side_files_capacity_in_mb integer	Side files capacity in MB Returned: success Sample: `0`
side_files_usage_rate integer	Side files usage rate percentage Returned: success Sample: `0`
write_pending_data_capacity_in_gb float	Write pending data capacity in GB Returned: success Sample: `0.0`
write_pending_data_capacity_in_mb integer	Write pending data capacity in MB Returned: success Sample: `0`
write_pending_data_rate integer	Write pending data rate percentage Returned: success Sample: `0`

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_module.html