hitachivantara.vspone_block.vsp.hv_resource_group_lock module – Allows the locking and unlocking of resource groups 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_resource_group_lock.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module allows the locking and unlocking of resource groups on VSP block 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.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.
secondary_connection_info dictionary	Information required to establish a connection to the remote storage system.
address string / required	IP address or hostname of the storage system.
api_token string	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 string	Password for authentication for secondary storage. This is a required field if api_token is not provided.
username string	Username for authentication for secondary storage. This is a required field if api_token is not provided.
spec dictionary	Specification for the resource group lock.
lock_timeout_sec integer	The time that elapses before a lock timeout (in seconds). Specify a value from 0 to 7200. Default is 0. Required for the Lock Resource Groups task.
state string	Set state to `present` for locking resource group. Set state to `absent` for unlocking resource group. Choices: `"present"` ← (default) `"absent"`
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: none	Determines if the module should run in check mode.

Notes

Note

The input parameters id and name were 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, 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.
For Lock Resource Groups
1. For Direct Connect, if a lock token remains unused for Ansible tasks for more than 5 minutes, the resource groups will automatically unlock. To prevent this, save the lock token and reference it in the appropriate playbooks, or include both lock and unlock tasks within a single playbook workflow.

Examples

- 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

- 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

Return Values

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

Key	Description
locked_resource_groups dictionary	Information of the locked resource group. When secondary_connection_info is provided, remote_lock_session_id, remote_lock_token, and remote_locked_resource_groups are populated in the output. Returned: always
lock_session_id integer	ID of the session that locked the local resources. Returned: success Sample: `26945`
lock_token string	Token that should be used to do operations on local resources. Returned: success Sample: `"62316257-5362-458a-8a9a-8922beaf7460"`
locked_resource_groups list / elements=dictionary	List of local resource groups that are locked. Returned: success
id integer	The ID of the resource group. Returned: success Sample: `1`
name string	Name of the resource group. Returned: success Sample: `"test-rg-1"`
remote_lock_session_id integer	ID of the session that locked the remote resources. Returned: success Sample: `16945`
remote_lock_token string	Token that should be used to do operations on remote resources. Returned: success Sample: `"72316257-5362-458a-8a9a-8922beaf7460"`
remote_locked_resource_groups list / elements=dictionary	List of remote resource groups that are locked. Returned: success
id integer	The ID of the resource group. Returned: success Sample: `2`
name string	Name of the resource group. Returned: success Sample: `"test-rg-2"`

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