hitachivantara.vspone_block.vsp.hv_vsp_one_server_hba_facts module – Retrieves server HBA information from Hitachi VSP One storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.3.0).

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_vsp_one_server_hba_facts.

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

api_token

string

Token used to operate on locked resources.

password

string

Password for authentication. This is a required field.

username

string

Username for authentication. This is a required field.

spec

dictionary

Query parameters for retrieving server HBA information.

hba_wwn

string

HBA WWN to filter servers.

iscsi_name

string

iSCSI name to filter servers.

nick_name

string

Server nickname to filter servers.

server_id

integer

Server identifier to retrieve specific server HBA information.

Attributes

Attribute

Support

Description

check_mode

Support: full

Specifies whether the module operates in check mode.

Examples

- name: Get server HBA information by server ID
  hitachivantara.vspone_block.vsp.hv_vsp_one_server_hba_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 31

- name: Get server HBA information by HBA WWN
  hitachivantara.vspone_block.vsp.hv_vsp_one_server_hba_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      hba_wwn: "210003e08b0256f9"
      server_id: 31

- name: Get server HBA information by iSCSI name
  hitachivantara.vspone_block.vsp.hv_vsp_one_server_hba_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      iscsi_name: "iqn.1994-04.jp.co.hitachi:rsd.has.i.00001d.1c"
      server_id: 31

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

hbas

dictionary

Server HBA information retrieved from the storage system.

Returned: always

hba_wwn

string

HBA WWN address.

Returned: success

Sample: ""

iscsi_name

string

iSCSI name for the HBA.

Returned: success

Sample: "iqn.1994-04.jp.co.hitachi:rsd.has.i.00001d.1c"

port_ids

list / elements=string

List of port identifiers associated with this HBA.

Returned: success

Sample: ["CL1-C"]

server_id

integer

Server identifier that this HBA belongs to.

Returned: success

Sample: 31

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)