W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_gateway_subscription_facts module – Retrieves information about resources of a subscriber on Hitachi VSP storage systems.

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.vsp.hv_gateway_subscription_facts.

New in hitachivantara.vspone_block 3.1.0

DEPRECATED
Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts
Status

DEPRECATED

Removed in:: version 4.0.0
Why:: The connection type gateway is deprecated.
Alternative:: Not available.

Synopsis

This module retrieves information about resources of a subscriber.
It provides details about resources of a subscriber such as type, value and other relevant information.
This module is supported only for gateway connection type.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_uai_gateway/subscription_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 UAI gateway.
api_token string	Token value to access UAI gateway.
connection_type string	Type of connection to the storage system. Choices: `"gateway"` ← (default)
password string	Password for authentication. This field is valid for `direct` connection type only, and it is a required field. Not needed for this module.
subscriber_id string	This field is valid for `gateway` connection type only. This is an optional field and only needed to support multi-tenancy environment.
username string	Username for authentication. This field is valid for `direct` connection type only, and it is a required field. Not needed for this module.
storage_system_info dictionary	Information about the Hitachi storage system. This field is required for gateway connection type only.
serial string / required	Serial number of the Hitachi storage system.

Attributes

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

Notes

Note

This module is deprecated and will be removed in a future release.

Examples

- name: Retrieve resource information about a specific subscriber
  hitachivantara.vspone_block.vsp.hv_gateway_subscription_facts:
    connection_info:
      address: gateway.company.com
      api_token: "eyJhbGciOiJS......"
      connection_type: "gateway"
      subscriber_id: "1234"
    storage_system_info:
      serial: "50015"

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
subscriber_data list / elements=dictionary	List of subscribers belonging to partner apiadmin. Returned: success
resource_value string	Value of the resource. Returned: success Sample: `"CL1-A"`
storage_serial string	Serial number of the Hitachi storage system. Returned: success Sample: `"50015"`
subscriber_id string	ID of the subscriber. Returned: success Sample: `"811150"`
total_capacity integer	Total capacity of the resource (if applicable). Returned: success Sample: `1073741824`
type string	Type of the resource. Returned: success Sample: `"Port"`

Status

This module will be removed in version 4.0.0. [deprecated]
For more information see DEPRECATED.

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/vsp.hv_gateway_subscription_facts_module.html