W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_resource_group_facts module – Retrieves resource group information from Hitachi VSP storage systems.

Note

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

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

This field is used to pass the value of the lock token 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 if api_token is not provided.

username

string

Username for authentication. This is a required field if api_token is not provided.

spec

dictionary

Specification for the resource group facts to be gathered.

id

integer

The id of the specific resource group to retrieve.

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.

Choices:

  • false
  • true

name

string

The name of the specific resource group to retrieve.

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.

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.

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 host group.

Returned: success

Sample: 1

name

string

The name of the host group.

Returned: success

Sample: "my_host_group_1"

port

string

The port 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

The port of the iSCSI target.

Returned: success

Sample: "CL1-C"

ldevs

list / elements=integer

List of LDEVs in the resource group.

Returned: success

Sample: [1, 2, 3]

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"]

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)

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