hitachivantara.vspone_block.vsp.hv_vsp_one_server_facts module – Retrieves server 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_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 information.

hba_wwn

string

HBA WWN address to filter servers containing this WWN.

iscsi_name

string

iSCSI name to filter servers containing this iSCSI initiator.

nick_name

string

Server nickname to filter servers by name.

server_id

integer

Server identifier to retrieve specific server information.

Attributes

Attribute

Support

Description

check_mode

Support: full

Specifies whether the module operates in check mode.

Examples

- name: Get all servers
  hitachivantara.vspone_block.vsp.hv_vsp_one_server_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"

- name: Get server by server ID
  hitachivantara.vspone_block.vsp.hv_vsp_one_server_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 123

- name: Get servers by nickname
  hitachivantara.vspone_block.vsp.hv_vsp_one_server_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nick_name: "WebServer01"

- name: Get servers containing specific HBA WWN
  hitachivantara.vspone_block.vsp.hv_vsp_one_server_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      hba_wwn: "210003e08b0256f9"

- name: Get servers containing specific iSCSI name
  hitachivantara.vspone_block.vsp.hv_vsp_one_server_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      iscsi_name: "iqn.1991-05.com.microsoft:server01"

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

servers

dictionary

Server information retrieved from the storage system.

Returned: always

compatibility

string

Server compatibility information.

Returned: success

Sample: ""

has_non_fullmesh_lu_paths

boolean

Whether the server has non-fullmesh LU paths.

Returned: success

Sample: true

has_unaligned_os_type_options

boolean

Whether the server has unaligned OS type options.

Returned: success

Sample: true

has_unaligned_os_types

boolean

Whether the server has unaligned OS types.

Returned: success

Sample: true

id

integer

Server identifier.

Returned: success

Sample: 13

is_inconsistent

boolean

Whether the server configuration is inconsistent.

Returned: success

Sample: false

is_reserved

boolean

Whether the server is reserved.

Returned: success

Sample: false

modification_in_progress

boolean

Whether modification is in progress.

Returned: success

Sample: false

nickname

string

Server nickname.

Returned: success

Sample: "WebServer414"

number_of_paths

integer

Number of paths configured for the server.

Returned: success

Sample: 2

number_of_volumes

integer

Number of volumes attached to the server.

Returned: success

Sample: 1

os_type

string

Operating system type.

Returned: success

Sample: "Linux"

os_type_options

list / elements=integer

List of OS type option identifiers.

Returned: success

Sample: [68]

paths

list / elements=dictionary

List of server paths with HBA and port information.

Returned: success

Sample: [{"hba_wwn": "210003e08b0256f9", "iscsi_name": "", "port_ids": ["CL1-A"]}, {"hba_wwn": "1000b47af169078e", "iscsi_name": "", "port_ids": ["CL3-A"]}]

hba_wwn

string

HBA WWN address for the path.

Returned: success

Sample: "210003e08b0256f9"

iscsi_name

string

iSCSI name for the path (empty for FC).

Returned: success

Sample: ""

port_ids

list / elements=string

List of port identifiers for this path.

Returned: success

Sample: ["CL1-A"]

protocol

string

Server protocol type.

Returned: success

Sample: "FC"

total_capacity

integer

Total capacity allocated to the server.

Returned: success

Sample: 50

used_capacity

integer

Used capacity by the server.

Returned: success

Sample: 0

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)