hitachivantara.vspone_block.vsp.hv_external_path_group_facts module – Retrieves information about External Path Group 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_external_path_group_facts.

New in hitachivantara.vspone_block 3.5.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about External Volume from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/external_path_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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary	Specification for retrieving External Path Group information.
external_path_group_id integer	The external path group ID. Required for the Get a specific external path group task.
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: Retrieve information about all External Path Groups
  hitachivantara.vspone_block.vsp.hv_external_path_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"

- name: Retrieve information about a specific External Path Groups
  hitachivantara.vspone_block.vsp.hv_external_path_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"
    spec:
      external_path_group_id: 1

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
external_parity_groups list / elements=dictionary	The list of external parity groups. Returned: success
cache_mode string	Cache mode. Returned: success Sample: `"E"`
external_luns list / elements=dictionary	External lun IDs. Returned: success
external_lun integer	External lun. Returned: success Sample: `2`
external_wwn string	External WWN. Returned: success Sample: `"50060e8012277d61"`
path_status string	Path status. Returned: success Sample: `"NML"`
port_id string	Path status. Returned: success Sample: `"CL6-B"`
priority integer	External lun. Returned: success Sample: `2`
external_parity_group_id string	External parity group ID. Returned: success Sample: `"1-3"`
external_parity_group_status string	External Parity Group Status. Returned: success Sample: `"NML"`
is_data_direct_mapping boolean	Data direct mapping. Returned: success Sample: `false`
load_balance_mode string	Load balance mode. Returned: success Sample: `"N"`
mp_blade_id integer	Load balance mode. Returned: success Sample: `0`
path_mode string	Load balance mode. Returned: success Sample: `"M"`
external_path_group_id integer	External path group ID. Returned: success Sample: `1`
external_paths list / elements=dictionary	The list of external paths. Returned: success
blocked_path_monitoring integer	Blocked path monitoring. Returned: success Sample: `0`
external_wwn string	External WWN. Returned: success Sample: `"50060e8012277d61"`
io_time_out integer	IO timeout. Returned: success Sample: `30`
port_id string	Port ID. Returned: success Sample: `"CL6-B"`
q_depth string	Queue depth. Returned: success Sample: `"32"`
external_product_id string	External product ID. Returned: success Sample: `"VSP Gx00"`
external_serial_number string	External serial number. Returned: success Sample: `"410109"`
storage_serial_number string	Storage serial number. Returned: success Sample: `"810050"`

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