W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_hg_facts module – Retrieves host group information from a specified Hitachi VSP storage system.

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_hg_facts.

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module fetches detailed information about host groups configured within a given Hitachi VSP storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/hostgroup_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	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 retrieving Host Group information.
host_group_number integer	Filters the host groups to those associated with the specified host group number.
lun integer	Filters the host groups to those associated with the specified LUN.
name string	If specified, filters the results to include only the host groups with this name.
ports list / elements=string	Filters the host groups to those associated with the specified Storage FC ports.
query list / elements=string	Determines what information to return about the host groups. Can specify ‘wwns’ for HBA WWNs, ‘ldevs’ for mapped LDEVs, or both. Choices: `"wwns"` `"ldevs"` Default: `[]`
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

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.

Examples

- name: Get all host groups
  hitachivantara.vspone_block.vsp.hv_hg_facts:
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"

- name: Get Host Groups of specific ports
  hitachivantara.vspone_block.vsp.hv_hg_facts:
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      ports: ['CL1-A', 'CL2-B']

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
hostGroups list / elements=dictionary	List of host groups retrieved from the storage system. Returned: always
host_group_id integer	ID of the host group. Returned: success Sample: `93`
host_group_name string	Name of the host group. Returned: success Sample: `"ansible-test-hg"`
host_mode string	Host mode of the host group. Returned: success Sample: `"STANDARD"`
host_mode_options list / elements=dictionary	List of host mode options. Returned: success
host_mode_option string	Host mode option. Returned: success Sample: `"EXTENDED_COPY"`
host_mode_option_number integer	Host mode option number. Returned: success Sample: `54`
lun_paths list / elements=dictionary	List of LUN paths. Returned: success
ldevId integer	LDEV ID. Returned: success Sample: `166`
lunId integer	LUN ID. Returned: success Sample: `0`
port string	Port associated with the host group. Returned: success Sample: `"CL1-A"`
resource_group_id integer	Resource group ID. Returned: success Sample: `0`
storage_id string	Storage ID. Returned: success Sample: `"storage-39f4eef0175c754bb90417358b0133c3"`
wwns list / elements=dictionary	List of WWNs. Returned: success
id string	WWN ID. Returned: success Sample: `"1212121212121212"`
name string	Name associated with the WWN. Returned: success Sample: `""`

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/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_hg_facts_module.html