W3cubDocs

/Ansible

hitachivantara.vspone_block.sds_block.hv_sds_block_vps_facts module – Retrieves information about Virtual Private Storages (VPS) of Hitachi SDS block storage system.

Note

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

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves information about Virtual Private Storages.
It provides details about a Virtual Private Storages such as number of servers created, number of volumes created etc.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/vps_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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication.
username string / required	Username for authentication.
spec dictionary	Specification for retrieving VPS information.
id string	ID of the VPS to retrieve information for.
name string	VPS name to retrieve information for.

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

- name: Retrieve information about all VPS
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about a specific VPS by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      id: "464e1fd1-9892-4134-866c-6964ce786676"

- name: Retrieve information about a specific VPS user by name
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      name: "VPS_01"

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
vsp_info list / elements=dictionary	List of VPS with their attributes. Returned: success
id string	ID of the VPS. Returned: success Sample: `"d2c1fa60-5c41-486a-9551-ec41c74d9f01"`
name string	Name of the VPS. Returned: success Sample: `"VPS_01"`
number_of_hbas_created integer	Number of HBAs created. Returned: success Sample: `0`
number_of_servers_created integer	Number of servers created. Returned: success Sample: `0`
number_of_sessions_created integer	Number of sessions created. Returned: success Sample: `0`
number_of_user_groups_created integer	Number of user groups created. Returned: success Sample: `0`
number_of_users_created integer	Number of users created. Returned: success Sample: `0`
number_of_volume_server_connections_created integer	Number of volume server connections created. Returned: success Sample: `0`
upper_limit_for_number_of_hbas integer	Upper limit for number of HBAs. Returned: success Sample: `400`
upper_limit_for_number_of_servers integer	Upper limit for number of servers. Returned: success Sample: `100`
upper_limit_for_number_of_sessions integer	Upper limit for number of sessions. Returned: success Sample: `436`
upper_limit_for_number_of_user_groups integer	Upper limit for number of user groups. Returned: success Sample: `256`
upper_limit_for_number_of_users integer	Upper limit for number of users. Returned: success Sample: `256`
upper_limit_for_number_of_volume_server_connections integer	Upper limit for number of volume server connections. Returned: success Sample: `100`
volume_settings dictionary	Volume settings for the VPS. Returned: success
capacity_of_volumes_created integer	Capacity of volumes created. Returned: success Sample: `0`
capacity_saving_of_volume string	Capacity saving mode of the volume. Returned: success Sample: `"Compression"`
number_of_volumes_created integer	Number of volumes created. Returned: success Sample: `0`
pool_id string	Pool ID associated with the volume. Returned: success Sample: `"f5ef8935-ed38-4894-a90b-f821ab6d3d89"`
qos_param dictionary	QoS parameters for the volume. Returned: success
upper_alert_allowable_time_of_volume integer	Upper alert allowable time of the volume. Returned: success Sample: `-1`
upper_limit_for_iops_of_volume integer	Upper limit for IOPS of the volume. Returned: success Sample: `-1`
upper_limit_for_transfer_rate_of_volume integer	Upper limit for transfer rate of the volume. Returned: success Sample: `-1`
saving_mode_of_volume string	Saving mode of the volume. Returned: success Sample: `"Inline"`
upper_limit_for_capacity_of_single_volume integer	Upper limit for capacity of a single volume. Returned: success Sample: `-1`
upper_limit_for_capacity_of_volumes integer	Upper limit for capacity of volumes. Returned: success Sample: `100`
upper_limit_for_number_of_volumes integer	Upper limit for number of volumes. Returned: success Sample: `50`
vsp_summary_info dictionary	Summary information of the VPS. Returned: success
total_count integer	Total count of VPS. Returned: success Sample: `1`
total_upper_limit_for_capacity_of_volumes integer	Total upper limit for capacity of volumes. Returned: success Sample: `100`
total_upper_limit_for_number_of_hbas integer	Total upper limit for number of HBAs. Returned: success Sample: `400`
total_upper_limit_for_number_of_servers integer	Total upper limit for number of servers. Returned: success Sample: `100`
total_upper_limit_for_number_of_sessions integer	Total upper limit for number of sessions. Returned: success Sample: `436`
total_upper_limit_for_number_of_user_groups integer	Total upper limit for number of user groups. Returned: success Sample: `256`
total_upper_limit_for_number_of_users integer	Total upper limit for number of users. Returned: success Sample: `256`
total_upper_limit_for_number_of_volume_server_connections integer	Total upper limit for number of volume server connections. Returned: success Sample: `100`
total_upper_limit_for_number_of_volumes integer	Total upper limit for number of volumes. Returned: success Sample: `50`

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/ansible/latest/collections/hitachivantara/vspone_block/sds_block.hv_sds_block_vps_facts_module.html