W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_gateway_subscriber_facts module – Retrieves information about 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_subscriber_facts.

New in hitachivantara.vspone_block 3.0.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 subscriber.
It provides details about a subscriber such as name, ID 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/subscriber_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 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. Not needed for this module.
username string	Username for authentication. Not needed for this module.
spec dictionary	Specification for retrieving subscriber information.
subscriber_id string	ID of the specific subscriber to retrieve information for. Works for `gateway` connection type only.

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 information about all subscribers
  hitachivantara.vspone_block.vsp.hv_gateway_subscriber_facts:
    connection_info:
      address: gateway.company.com
      api_token: "eyJhbGciOiJS......"
      connection_type: "gateway"
    spec:
      subscriber_id: "811150"

- name: Retrieve information about a specific subscriber
  hitachivantara.vspone_block.vsp.hv_gateway_subscriber_facts:
    connection_info:
      address: gateway.company.com
      api_token: "eyJhbGciOiJS......"
      connection_type: "gateway"
    spec:
      subscriber_id: "1234"

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 with their attributes. Returned: success
hard_limit_in_percent string	Hard limit percentage for the subscriber. Returned: success Sample: `"90"`
message string	Message related to the subscriber. Returned: success Sample: `""`
name string	Name of the subscriber. Returned: success Sample: `"TestSubscriber"`
partner_id string	Partner ID associated with the subscriber. Returned: success Sample: `"apiadmin"`
quota_limit_in_gb string	Quota limit in GB for the subscriber. Returned: success Sample: `"90"`
soft_limit_in_percent string	Soft limit percentage for the subscriber. Returned: success Sample: `"80"`
state string	State of the subscriber. Returned: success Sample: `"NORMAL"`
subscriber_id string	Unique identifier for the subscriber. Returned: success Sample: `"811150"`
time integer	Timestamp of the subscriber data. Returned: success Sample: `1716260209`
type string	Type of the subscriber. Returned: success Sample: `"subscriber"`
used_quota_in_gb string	Used quota in GB for the subscriber. Returned: success Sample: `"0.1953125"`
used_quota_in_percent float	Used quota percentage for the subscriber. Returned: success Sample: `0.2170139`

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_subscriber_facts_module.html