hitachivantara.vspone_block.vsp.hv_iscsi_target_facts module – Retrieves information about iscsi targets from 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_iscsi_target_facts.

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

api_token

string

This field is used to pass the value of the lock token to operate on locked resources.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string

Password for authentication. This is a required field if api_token is not provided.

username

string

Username for authentication. This is a required field if api_token is not provided.

spec

dictionary / required

Specification for retrieving iscsi target information.

iscsi_id

integer

ID of the iscsi target.

name

string

Name of the iscsi target.

ports

list / elements=string

List of ports of the iscsi target.

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

  • The output parameters subscriber_id and partner_id were removed in version 3.4.0. They were also deprecated due to internal API simplification and are no longer supported.

  • Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Get all iscsi targets
  hitachivantara.vspone_block.vsp.hv_iscsi_target_facts:
    connection_info:
      address: storage1.example.com
      username: "dummy_username"
      password: "dummy_password"

- name: Get iscsi targets by ports
  hitachivantara.vspone_block.vsp.hv_iscsi_target_facts:
    connection_info:
      address: storage1.example.com
      username: "dummy_username"
      password: "dummy_password"
    spec:
      ports: ['CL4-C']

- name: Get iscsi targets by ports and name
  hitachivantara.vspone_block.vsp.hv_iscsi_target_facts:
    connection_info:
      address: storage1.example.com
      username: "dummy_username"
      password: "dummy_password"
    spec:
      name: 'iscsi-target-server-1'
      ports: ['CL4-C']

- name: Get iscsi targets by iscsi_id
  hitachivantara.vspone_block.vsp.hv_iscsi_target_facts:
    connection_info:
      address: storage1.example.com
      username: "dummy_username"
      password: "dummy_password"
    spec:
      iscsi_id: 10

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

iscsi_targets

list / elements=dictionary

List of iSCSI targets with their attributes.

Returned: success

auth_param

dictionary

Authentication parameters for the iSCSI target.

Returned: success

authentication_mode

string

Mode of authentication.

Returned: success

Sample: "BOTH"

is_chap_enabled

boolean

Indicates if CHAP is enabled.

Returned: success

Sample: true

is_chap_required

boolean

Indicates if CHAP is required.

Returned: success

Sample: false

is_mutual_auth

boolean

Indicates if mutual authentication is enabled.

Returned: success

Sample: false

chap_users

list / elements=string

List of CHAP users.

Returned: success

Sample: ["chapuser1"]

host_mode

dictionary

Host mode settings.

Returned: success

host_mode

string

Host mode.

Returned: success

Sample: "VMWARE"

host_mode_options

list / elements=dictionary

List of host mode options.

Returned: success

raid_option

string

RAID option.

Returned: success

Sample: "EXTENDED_COPY"

raid_option_number

integer

RAID option number.

Returned: success

Sample: 54

iqn

string

IQN of the iSCSI target.

Returned: success

Sample: "iqn.rest.example.of.iqn.host"

iqn_initiators

list / elements=string

List of IQN initiators.

Returned: success

Sample: ["iqn.2014-04.jp.co.hitachi:xxx.h70.i.62510.1a.ff"]

iscsi_id

integer

ID of the iSCSI target.

Returned: success

Sample: 1

iscsi_name

string

Name of the iSCSI target.

Returned: success

Sample: "iscsi-name"

logical_units

list / elements=dictionary

List of logical units.

Returned: success

host_lun_id

integer

Host LUN ID.

Returned: success

Sample: 0

logical_unit_id

integer

Logical unit ID.

Returned: success

Sample: 1

port_id

string

Port ID.

Returned: success

Sample: "CL4-C"

resource_group_id

integer

Resource group ID.

Returned: success

Sample: "0\""

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)