hitachivantara.vspone_block.vsp.hv_server_priority_manager_facts module – Retrieves Server Priority Manager information from Hitachi VSP storage systems.

Note

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

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

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

Specification for the Server Priority Manager facts to be gathered.

host_wwn

string

WWN of the HBA.

iscsi_name

string

iSCSI name of the HBA (iSCSI initiator).

ldev_id

integer

LDEV number.

Attributes

Attribute

Support

Description

check_mode

Support: full

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: Get all Server Priority Manager information
  hitachivantara.vspone_block.vsp.hv_server_priority_manager_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Get Server Priority Manager information by specifying a volume and the WWN of an HBA
  hitachivantara.vspone_block.vsp.hv_server_priority_manager_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      ldev_id: 0
      host_wwn: "210003e08b0256f9"

- name: Get Server Priority Manager information by specifying a volume and the iSCSI name of an HBA
  hitachivantara.vspone_block.vsp.hv_server_priority_manager_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      ldev_id: 80
      iscsi_name: "eui.0900ABDC32598D269"

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

server_priority_manager

list / elements=dictionary

The Server Priority Manager information.

Returned: success

host_wwn

string

WWN of the HBA.

Returned: success

Sample: "210003e08b0256f9"

io_control_ldev_wwn_iscsi_id

string

Object ID of the SPM information.

Returned: success

Sample: "0,210003e08b0256f9"

iscsi_name

string

iSCSI name of the HBA (iSCSI initiator).

Returned: success

Sample: "iqn.myrestapiiscsi20150907"

ldev_id

integer

LDEV number.

Returned: success

Sample: 80

priority

string

Prioritized or not prioritized.

Returned: success

Sample: "Prioritize"

upper_limit_for_iops

integer

Upper limit on IOPS.

Returned: success

Sample: 9999

upper_limit_for_transfer_rate

integer

Upper limit on the transfer rate (MBps).

Returned: success

Sample: 30

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)