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

Note

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

New in hitachivantara.vspone_block 4.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about Server Priority Manager from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/server_priority_manager_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	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. Required for the Get Server Priority Manager information by specifying a volume and the WWN of the HBA task.
iscsi_name string	iSCSI name of the HBA (iSCSI initiator). Required for the Get Server Priority Manager information by specifying a volume and the iSCSI name of the HBA task.
ldev_id string	LDEV number. Can be decimal or hexadecimal. Required for the Get Server Priority Manager information by specifying a volume and the WWN of the HBA /Get Server Priority Manager information by specifying a volume and the iSCSI name of the HBA tasks.

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: `"10908978675678ab"`
io_control_ldev_wwn_iscsi_id string	Object ID of the SPM information. Returned: success Sample: `"156,10908978675678ab"`
iscsi_name string	iSCSI name of the HBA (iSCSI initiator). Returned: success Sample: `""`
ldev_id integer	LDEV number. Returned: success Sample: `156`
ldev_id_hex string	LDEV number in hexadecimal. Returned: success Sample: `"00:00:9C"`
priority string	Prioritized or not prioritized. Returned: success Sample: `"NonPrioritize"`
storage_serial_number string	Serial number of the storage system. Returned: success Sample: `"40015"`
upper_limit_for_iops integer	Upper limit on IOPS. Returned: success Sample: `8888`
upper_limit_for_transfer_rate_in_MBps integer	Upper limit on the transfer rate (MBps). Returned: success Sample: `-1`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_server_priority_manager_facts_module.html