hitachivantara.vspone_block.vsp.hv_remote_connection module – Manages Remote connections on 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_remote_connection.

New in hitachivantara.vspone_block 3.3.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 / required

Specification for the Create/update Remote connection task.

min_remote_paths

integer

Minimum number of remote paths, Specify a value that is no more than the number of remote paths registered in the remote connection.

path_group_id

integer / required

Path group ID.

remote_io_timeout_in_sec

integer

Remote IO timeout in seconds.

remote_paths

list / elements=dictionary

List of remote paths, For new remote connection, at least one remote path is required.

local_port

string / required

Port number of the local storage system

remote_port

string / required

Port number of the remote storage system

remote_storage_serial_number

string / required

Serial number of the remote storage system.

round_trip_in_msec

integer

Round trip time in milliseconds.

state

string

The level of the Remote connection task. Choices are present, absent.

Choices:

  • "present" ← (default)

  • "absent"

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: Create a new remote connection
  hitachivantara.vspone_block.vsp.hv_remote_connection:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      path_group_id: 101
      remote_storage_serial_number: "40014"
      remote_paths:
        - local_port: "CL7-C"
          remote_port: "CL7-C"
        - local_port: "CL7-D"
          remote_port: "CL7-D"
      min_remote_paths: 1
      remote_io_timeout_in_sec: 15
      round_trip_in_msec: 1

- name: update remote path of a existing remote connection
  hitachivantara.vspone_block.vsp.hv_remote_connection:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      path_group_id: 101
      remote_storage_serial_number: "40014"
      remote_paths:
        - local_port: "CL7-C"
          remote_port: "CL7-C"
        - local_port: "CL7-D"
          remote_port: "CL7-D"

- name: update remote connection settings
  hitachivantara.vspone_block.vsp.hv_remote_connection:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      path_group_id: 101
      remote_storage_serial_number: "40014"
      remote_io_timeout_in_sec: 15
      round_trip_in_msec: 1
      min_remote_paths: 1

- name: Delete a remote connection
  hitachivantara.vspone_block.vsp.hv_remote_connection:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      path_group_id: 101
      remote_storage_serial_number: "40014"

Return Values

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

Key

Description

remote_connection

dictionary

Newly created remote connection object.

Returned: success

cu_status

string

CU status.

Returned: success

Sample: "NML"

cu_type

string

CU type.

Returned: success

Sample: "REMOTE"

min_num_of_paths

integer

Minimum number of paths.

Returned: success

Sample: 1

num_of_paths

integer

Number of paths.

Returned: success

Sample: 1

path_group_id

integer

Path group ID.

Returned: success

Sample: 101

port_type

string

Port type.

Returned: success

Sample: "FIBRE"

remote_paths

list / elements=dictionary

List of remote paths.

Returned: success

cu_type

string

CU type.

Returned: success

Sample: "REMOTE"

local_port_id

string

Local port ID.

Returned: success

Sample: "CL7-C"

path_number

integer

Path number.

Returned: success

Sample: 0

path_status

string

Path status.

Returned: success

Sample: "NML_01"

port_type

string

Port type.

Returned: success

Sample: "FIBRE"

remote_port_id

string

Remote port ID.

Returned: success

Sample: "CL7-C"

remote_serial_number

string

Remote serial number.

Returned: success

Sample: "40014"

remote_storage_device_id

string

Remote storage device ID.

Returned: success

Sample: "900000040014"

remote_storage_model

string

Remote storage model.

Returned: success

Sample: "VSP 5600H"

remote_storage_type_id

string

Remote storage type ID.

Returned: success

Sample: "R9"

remotepath_group_id

string

Remote path group ID.

Returned: success

Sample: "40014,R9,101"

round_trip_time_in_milli_seconds

integer

Round trip time in milliseconds.

Returned: success

Sample: 1

timeout_value_for_remote_io_in_seconds

integer

Timeout value for remote IO in seconds.

Returned: success

Sample: 15

Authors

  • Hitachi Vantara, LTD. (@hitachi-vantara)