hitachivantara.vspone_block.vsp.hv_server_priority_manager module – Manage Server Priority Manager information on 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.

New in hitachivantara.vspone_block 4.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

Set, change, or delete Server Priority Manager information on 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.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.
host_wwn string	WWN of the HBA. Specify a hexadecimal number consisting of 16 characters. Required for the Set Server Priority Manager information by specifying a volume and the WWN of the HBA /Change the upper limit on IOPS for hosts for which the LDEV number of a volume and the WWN of the HBA are already specified in Server Priority Manager /Delete Server Priority Manager information by specifying a volume and the WWN of the HBA tasks.
iscsi_name string	iSCSI name of the HBA (iSCSI initiator). Specify the name in iqn format or eui format. Required for the Set Server Priority Manager information by specifying a volume and the iSCSI name of the HBA /Change the upper limit on the transfer rate for hosts for which the LDEV number of a volume and iSCSI name of the HBA are already specified in Server Priority Manager /Delete Server Priority Manager information by specifying a volume and the iSCSI name of the HBA tasks.
ldev_id string / required	Specify the LDEV number. Can be decimal or hexadecimal. Required for the Set Server Priority Manager information by specifying a volume and the WWN of the HBA /Set Server Priority Manager information by specifying a volume and the iSCSI name of the HBA /Change the upper limit on IOPS for hosts for which the LDEV number of a volume and the WWN of the HBA are already specified in Server Priority Manager /Change the upper limit on the transfer rate for hosts for which the LDEV number of a volume and iSCSI name of the HBA are already specified in Server Priority Manager /Delete Server Priority Manager information by specifying a volume and the WWN of the HBA /Delete Server Priority Manager information by specifying a volume and the iSCSI name of the HBA tasks.
upper_limit_for_iops integer	Upper limit on IOPS. Specify a value in the range from 1 to 65535. Required for the Set Server Priority Manager information by specifying a volume and the WWN of the HBA /Change the upper limit on IOPS for hosts for which the LDEV number of a volume and the WWN of the HBA are already specified in Server Priority Manager tasks.
upper_limit_for_transfer_rate_in_MBps integer	Upper limit on the transfer rate (MBps). Specify a value in the range from 1 to 31. Required for the Set Server Priority Manager information by specifying a volume and the iSCSI name of the HBA /Change the upper limit on the transfer rate for hosts for which the LDEV number of a volume and iSCSI name of the HBA are already specified in Server Priority Manager tasks.
state string	The level of the storage pool task. Choices are `present`, `absent` . Choices: `"present"` ← (default) `"absent"`

Attributes

Attribute	Support	Description
check_mode	Support: none	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: Set Server Priority Manager information by specifying a volume and the WWN of the HBA
  hitachivantara.vspone_block.vsp.hv_server_priority_manager:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "present"
    spec:
      ldev_id: 0
      host_wwn: "210003e08b0256f9"
      upper_limit_for_iops: 999

- name: Set Server Priority Manager information by specifying a volume and the iSCSI name of the HBA
  hitachivantara.vspone_block.vsp.hv_server_priority_manager:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "present"
    spec:
      ldev_id: 80
      iscsi_name: "eui.0900ABDC32598D269"
      upper_limit_for_transfer_rate_in_MBps: 30

- name: Change the upper limit on IOPS for an SPM by specifying LDEV number and the WWN of the HBA
  hitachivantara.vspone_block.vsp.hv_server_priority_manager:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "present"
    spec:
      ldev_id: 0
      host_wwn: "210003e08b0256f9"
      upper_limit_for_iops: 8888

- name: Change the upper limit on the transfer rate for an SPM by specifying a volume and the iSCSI name  of the HBA
  hitachivantara.vspone_block.vsp.hv_server_priority_manager:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "present"
    spec:
      ldev_id: 80
      iscsi_name: "eui.0900ABDC32598D269"
      upper_limit_for_transfer_rate_in_MBps: 30

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

- name: Delete Server Priority Manager information by specifying a volume and the iSCSI name of the HBA
  hitachivantara.vspone_block.vsp.hv_server_priority_manager:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "absent"
    spec:
      ldev_id: 80
      iscsi_name: "eui.0900ABDC32598D269"
      upper_limit_for_transfer_rate_in_MBps: 25

Return Values

Common return values are documented here, the following are the fields unique to this module:

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 format. Returned: success Sample: `"00:00:9C"`
priority string	Prioritized or not prioritized. Returned: success Sample: `"NonPrioritize"`
storage_serial_number string	Storage serial number. Returned: success Sample: `"40015"`
upper_limit_for_iops integer	Upper limit on IOPS. Returned: success Sample: `999`
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_module.html