hitachivantara.vspone_block.sds_block.hv_sds_block_remote_path_group_facts module – Get information about remote path groups from VSP One SDS Block and Cloud 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.sds_block.hv_sds_block_remote_path_group_facts.

New in hitachivantara.vspone_block 4.5.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

Get information about remote path groups from storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/remote_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	Parameters for filtering or identifying remote path groups to gather facts about.
id string	The ID of a remote path group.
local_storage_controller_id string	The ID of a local storage system controller. UUID format.
path_group_id integer	Path group ID.
remote_serial string	Serial number of the remote storage system.
remote_storage_system_type string	ID indicating the remote storage system model. Choices: `"R9"` `"M8"`

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

- name: Get all remote path groups
  hitachivantara.vspone_block.sds_block.hv_sds_block_remote_path_group_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Get remote path group by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_remote_path_group_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "da87655a-3958-4921-b4c0-437986397d11"

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
remote_path_groups list / elements=dictionary	List of remote path group details. Returned: success
cu_status string	Connection unit status of the remote path group. Returned: success Sample: `"Error"`
cu_type string	Type of the connection unit. Returned: success Sample: `"Remote"`
id string	Unique identifier of the remote path group. Returned: success Sample: `"20be7610-9e5e-4713-bff2-e9d993d1f6d4"`
local_storage_controller_id string	Identifier of the local storage controller. Returned: success Sample: `"3c65e322-ac62-4966-9489-072dbccdf430"`
number_of_paths integer	Number of paths in the remote path group. Returned: success Sample: `1`
path_group_id integer	Identifier of the remote path group. Returned: success Sample: `15`
protocol string	Communication protocol used for the remote connection. Returned: success Sample: `"iSCSI"`
remote_serial_number string	Serial number of the remote storage system. Returned: success Sample: `"810045"`
remote_storage_type_id string	Model or type identifier of the remote storage system. Returned: success Sample: `"M8"`
timeout_value_for_remote_io_in_seconds integer	Timeout value (in seconds) for remote I/O operations. Returned: success Sample: `15`

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/sds_block.hv_sds_block_remote_path_group_facts_module.html