hitachivantara.vspone_block.sds_block.hv_sds_block_remote_path_group module – Manages remote path groups on VSP One SDS Block and Cloud systems.

Note

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

New in hitachivantara.vspone_block 4.5.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.

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 remote path group.

id

string

The ID of the remote path group. Required for update and delete operation.

local_port

string

Port number of the local storage system in CLx-y format. Required for create operation.

path_group_id

integer

Path group ID. Required for create operation. Value must be between 1 and 255.

remote_io_timeout_in_sec

integer

Timeout setting value for the RIO (remote IO) between the local storage system and remote storage system in seconds. Optional for create operation. Value must be between 10 and 80. Default value is 15.

remote_port

string

Port number of the remote storage system in CLx-y format. Required for create operation.

remote_serial

string

Serial number of the remote storage system. Required for create operation.

remote_storage_system_type

string

ID indicating the remote storage system model. Required for create operation.

Choices:

  • "R9"

  • "M8"

state

string

The desired state of the remote path group.

Choices:

  • "present" ← (default)

  • "absent"

  • "add_remote_path"

  • "remove_remote_path"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Create a remote path group
  hitachivantara.vspone_block.sds_block.hv_sds_block_remote_path_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      remote_serial: "810045"
      remote_storage_system_type: "M8"
      local_port: "CL1-C"
      remote_port: "CL2-C"
      path_group_id: 20
      remote_io_timeout_in_sec: 200

- name: Delete a remote path group
  hitachivantara.vspone_block.sds_block.hv_sds_block_remote_path_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "restore"
    spec:
      id: "3d0997ce-7065-4e4a-9095-4dc62b36f300"

Return Values

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

Key

Description

remote_path_groups

dictionary

Details of the remote path group configuration.

Returned: always

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: "72b765af-5159-405d-9d60-a899ad8f751c"

local_storage_controller_id

string

Identifier of the local storage controller associated with the path group.

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: 25

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: "810050"

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)