hitachivantara.vspone_block.vsp.hv_resource_group_facts module – Retrieves resource group information 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_resource_group_facts.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about resource groups from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/resource_group_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 the resource group facts to be gathered.
id integer	The id of the specific resource group to retrieve. Required for the Get Resource Group by id task.
is_locked boolean	If this field is not present, all resource groups will be retrieved. If this field is true, only the locked resource groups will be retrieved. If this field is false, only the unlocked resource groups will be retrieved. Required for the Get all information about the Resource Groups that are locked /Get all information about the Resource Groups that are unlocked tasks. Optional for the Get information about the Resource Groups that are unlocked and specified in the query task. Choices: `false` `true`
is_simple boolean	If this field is true, only basic information about all the resource groups will be retrieved including meta resource group information. If this field is false or not present, detailed information about the resource groups will be retrieved. Optional for all tasks. If this is true, all other parameters will be ignored. Default is false. Choices: `false` ← (default) `true`
name string	The name of the specific resource group to retrieve. Required for the Get Resource Group by name task.
query list / elements=string	The field allows to query resource groups for different types of resources. Types of resources are: ldevs, parity_groups, ports, host_groups, iscsi_targets, nvm_subsystem_ids, and storage_pool_ids. If this field is not present, all resources information of the resource group will be retrieved except storage_pool_ids. When storage_pool_ids is present, all the ldevs that constitute the storage pool will be included in the response under the ldevs field. Optional for the Get information about the Resource Groups that are specified in the query /Get information about the Resource Groups that are unlocked and specified in the query tasks.
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

Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.
To add or remove NVM subsystems from a VSM, the NVM subsystem must not already exist or be created.

Examples

- name: Get all Resource Groups
  hitachivantara.vspone_block.vsp.hv_resource_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Get Resource Group by name
  hitachivantara.vspone_block.vsp.hv_resource_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      name: "my_resource_group"

- name: Get information about the Resource Groups specified in the query
  hitachivantara.vspone_block.vsp.hv_resource_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      query:
        # Logical Devices (LDEVs)
        - ldevs
        # Parity Groups
        - parity_groups
        # Ports
        - ports
        # Host Groups
        - host_groups
        # iSCSI Targets
        - iscsi_targets
        # Non-Volatile Memory Subsystem IDs
        - nvm_subsystem_ids

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
resource_groups list / elements=dictionary	The resource group information. Returned: always
host_groups list / elements=dictionary	List of host groups in the resource group. Returned: success
id integer	The ID of the iSCSI target. Returned: success Sample: `1`
name string	The name of the host group. Returned: success Sample: `"GK-TC-HG1"`
port string	Deprecated. Use port_id instead. Returned: success Sample: `"CL1-A"`
port_id string	The port ID of the host group. Returned: success Sample: `"CL1-A"`
id integer	The ID of the resource group. Returned: success Sample: `4`
iscsi_targets list / elements=dictionary	List of iSCSI targets in the resource group. Returned: success
id integer	The ID of the iSCSI target. Returned: success Sample: `1`
name string	The name of the iSCSI target. Returned: success Sample: `"my_iscsi_target_1"`
port string	Deprecated. Use port_id instead. Returned: success Sample: `"CL1-C"`
port_id string	The port ID of the iSCSI target. Returned: success Sample: `"CL1-C"`
ldevs list / elements=integer	List of LDEVs in the resource group. Returned: success Sample: `[1149, 1233]`
ldevs_hex list / elements=string	List of LDEVs in hexadecimal format. Returned: success Sample: `["00:04:7D", "00:04:D1"]`
lock_status string	The lock status of the resource group. Returned: success Sample: `"Unlocked"`
name string	The name of the resource group. Returned: success Sample: `"my_resource_group"`
parity_groups list / elements=string	List of parity groups in the resource group. Returned: success Sample: `["PG1", "PG2"]`
ports list / elements=string	List of ports in the resource group. Returned: success Sample: `["CL1-A", "CL1-C"]`
storage_serial_number string	The serial number of the storage system. Returned: success Sample: `"810045"`
virtual_model string	The virtual model of the storage system. Returned: success Sample: `"VSP One B28"`
virtual_serial_number string	The virtual serial number of the storage system. Returned: success Sample: `"810076"`
virtual_storage_id integer	The virtual storage ID. 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_resource_group_facts_module.html