hitachivantara.vspone_block.vsp.hv_resource_group_lock module – Allows the locking and unlocking of resource groups on Hitachi VSP storage systems.
Note
This module is part of the hitachivantara.vspone_block collection (version 3.4.2).
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_resource_group_lock.
New in hitachivantara.vspone_block 3.2.0
Synopsis
This module allows the locking and unlocking of resource groups on Hitachi VSP storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/resource_management_with_lock/vsp_direct
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8
Parameters
Parameter |
Comments |
|---|---|
Information required to establish a connection to the storage system. |
|
IP address or hostname of the storage system. |
|
This token is required while working on locked resources. Provide the lock_token value returned by lock resource group task for primary storage system. |
|
Type of connection to the storage system. Choices:
|
|
Password for authentication. This is a required field. |
|
Username for authentication. This is a required field. |
|
Information required to establish a connection to the remote storage system. |
|
IP address or hostname of the storage system. |
|
This token is required while working on locked resources. Provide the lock_token value returned by lock resource group task for secondary storage system. |
|
Password for authentication. Required if api_token is not provided. |
|
Username for authentication. Required if api_token is not provided. |
|
Specification for the resource group lock. |
|
The time that elapses before a lock timeout (in seconds). Specify a value from 0 to 7200. Default is 0. |
|
Set state to Set state to Choices:
|
|
Information about the storage system. This field is an optional field. |
|
The serial number of the storage system. |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: none |
Determines if the module should run in check mode. |
Notes
Note
The input parameters
idandnamewere removed in version 3.4.0. They were deprecated due to internal API simplification and are no longer supported.The output parameters
entitlement_status,subscriber_id, andpartner_idwere removed in version 3.4.0. They were also deprecated due to internal API simplification and are no longer supported.Connection type
gatewaywas removed starting from version 3.4.0. Please use an earlier version if you require this connection type.
Examples
- name: Resource management with Resource Group Lock where single storage system is involved
tasks:
- name: Lock resource groups
hitachivantara.vspone_block.vsp.hv_resource_group_lock:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
lock_timeout_sec: 300
register: response
- name: Debug lock resource group result
ansible.builtin.debug:
var: response
- name: Create ldev
hitachivantara.vspone_block.vsp.hv_ldevs:
connection_info:
address: storage1.company.com
api_token: lock_token_value
spec:
pool_id: 0
size: 2GB
name: RD_LOCK_TEST_120424
register: create_ldev_result
- name: Debug lock resource group result
ansible.builtin.debug:
var: create_ldev_result
- name: Unlock the Resource Groups that were locked
hitachivantara.vspone_block.vsp.hv_resource_group_lock:
connection_info:
address: storage1.company.com
api_token: lock_token_value
state: absent
register: result
- name: Debug lock resource group result
ansible.builtin.debug:
var: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
First lock resource groups output, then ldev creation output and finally unlock resource group output. Ansible sorts the output, so the outputs were jumbled with three tasks. Ignore the underscores (_) in the beginning of the variables, they are added to keep the output in order with the tasks. For first task three (___), for the second task two (__), and for the third task one (_) underscores are added in the beginning. Returned: always Sample: |