hitachivantara.vspone_block.vsp.hv_vsp_one_server_hba_facts module – Retrieves server HBA information from VSP E series, VSP One Block 20 series, and VSP One Block 80 series storage systems.

Note

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

• This module retrieves HBA (Host Bus Adapter) information about servers from VSP E series, VSP One Block 20 series, and VSP One Block 80 series storage systems.

• Utilizes the Hitachi Virtual Storage Platform One Simple API for server HBA facts retrieval across VSP One B20 series, VSP One B80 series, and VSP E series models.

• For usage examples, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_server_hba_facts.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.
api_token string	Token used to operate on locked resources.
ca_cert string	Path to a CA certificate file or directory on the Ansible control node used to verify the storage system SSL certificate. Required when connection_info.validate_cert is true and the storage system uses a self-signed or privately issued certificate. Accepts a PEM file path or a directory of hashed CA certificates.
client_cert string	Path to client SSL certificate file or CA certificate directory for mutual TLS authentication. Must be provided together with connection_info.client_key.
client_key string	Path to the client private key file for mutual TLS authentication. Must be provided together with connection_info.client_cert.
password string	Password for authentication. This is a required field.
suppress_validate_cert_warning boolean	Whether to suppress the SSL certificate validation warning. When set to false (default), a warning is displayed if certificate validation is disabled. Set to true to suppress the warning. Choices: false ← (default) true
username string	Username for authentication. This is a required field.
validate_cert boolean	Whether to validate the storage system SSL certificate. When set to false (default), certificate validation is disabled. A security warning will be displayed unless connection_info.suppress_validate_cert_warning is true. Set to true to enable certificate validation. When true, provide connection_info.ca_cert if the storage system uses a self-signed certificate. Note: Starting with major version 5.0, the default value will change to true. It is strongly recommended to enable certificate validation in production environments. Choices: false ← (default) true
spec dictionary	Query parameters for retrieving server HBA information.
hba_wwn string	HBA WWN to filter servers. Required for the Get server HBA information by HBA WWN task.
iscsi_name string	iSCSI name to filter servers. Required for the Get server HBA information by iSCSI name task.
nickname aliases: nick_name string	Server nickname to filter servers. Required for the Get all hbas using server nickname task.
server_id integer	Server identifier to retrieve specific server HBA information. Required for the Get all hbas using server_id /Get server HBA information by HBA WWN /Get server HBA information by iSCSI name tasks.

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"
nick_name string	Deprecated. Use nickname instead. Returned: success Sample: "WebServer414"
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)

Collection links

• Issue Tracker
• Repository (Sources)