W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_external_path_group module – Manages External Path Groups in the 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_external_path_group.

New in hitachivantara.vspone_block 3.5.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module adds and removes external paths to the external path group in the Hitachi VSP storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/external_path_group.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 the External Path Group management.
external_fc_paths list / elements=dictionary	List of external FC path objects.
external_wwn string / required	WWN of the external storage system.
port string / required	Number of the port on the local storage system.
external_iscsi_target_paths list / elements=dictionary	List of external iSCSI target path objects.
external_iscsi_ip_address string / required	IP address of the iSCSI target on the external storage system.
external_iscsi_name string / required	iSCSI name of the iSCSI target on the external storage system.
port string / required	Number of the port on the local storage system.
external_path_group_id integer / required	External path group number.
state string	The level of the External Path Group task. Choices: `"present"` ← (default) `"add_external_path"` `"remove_external_path"`
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: none	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: Add external paths to an external path group
  hitachivantara.vspone_block.vsp.hv_external_path_group:
    connection_info:
      address: storage1.company.com
      username: 'username'
      password: 'password'
    state: "add_external_path"
    spec:
      external_path_group_id: 1
      external_fc_paths:
        - port: "CL6-A"
          external_wwn: "50060e8012277d61"
      external_iscsi_target_paths:
        - port: "CL1-C"
          external_iscsi_ip_address: "172.25.59.214"
          external_iscsi_name: "iqn.1994-04.jp.co.hitachi:rsd.has.t.10045.1c020"

- name: Add external paths to an external path group
  hitachivantara.vspone_block.vsp.hv_external_path_group:
    connection_info:
      address: storage1.company.com
      username: 'username'
      password: 'password'
    state: "remove_external_path"
    spec:
      external_path_group_id: 1
      external_fc_paths:
        - port: "CL6-A"
          external_wwn: "50060e8012277d61"
      external_iscsi_target_paths:
        - port: "CL1-C"
          external_iscsi_ip_address: "172.25.59.214"
          external_iscsi_name: "iqn.1994-04.jp.co.hitachi:rsd.has.t.10045.1c020"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
data list / elements=dictionary	The External Path Group managed by the module. Returned: success
external_path_group dictionary	The list of external path groups. Returned: success
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	List of LUNs of the external storage system. Returned: success
external_lun integer	LUN within the ports of the external storage system. Returned: success Sample: `2`
external_wwn string	WWN of the external storage system. Returned: success Sample: `"50060e8012277d71"`
path_status string	Status of the external path. Returned: success Sample: `"NML"`
port_id string	Port number. Returned: success Sample: `"CL6-B"`
priority integer	Priority within the external path group. Returned: success Sample: `1`
external_parity_group_id string	External parity group ID. Returned: success Sample: `"1-3"`
external_parity_group_status string	Status of the external parity group. Returned: success Sample: `"NML"`
is_data_direct_mapping boolean	Whether the data direct mapping attribute is enabled. Returned: success Sample: `false`
is_inflow_control_enabled boolean	Inflow cache control. Returned: success Sample: `false`
load_balance_mode string	The load balancing method for I/O operations for the external storage system. Returned: success Sample: `"N"`
mp_blade_id integer	Inflow cache control. Returned: success Sample: `0`
path_mode string	Path mode of the external storage system. Returned: success Sample: `"M"`
external_path_group_id integer	External path group number. Returned: success Sample: `1`
external_serial_number string	Serial number of the external storage system. Returned: success Sample: `"410109"`
storage_serial_number string	Serial number of the storage system. Returned: success Sample: `"410109"`

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