W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_gateway_subscriber module – Manages subscribers of a partner 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.

New in hitachivantara.vspone_block 3.0.0

DEPRECATED
Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values
Status

DEPRECATED

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

Synopsis

This module allows for the creation, updating and deletion of subscribers.
It supports various subscriber operations based on the specified task level.
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.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 required for this module.
username string	Username for authentication.This field is valid for `direct` connection type only, and it is a required field. Not required for this module.
spec dictionary / required	Specification for the subscriber task.
description string	Description of the subscriber.
hard_limit string	Hard limit in percent for the subscriber. Default is 90.
name string	Name of the subscriber.
quota_limit string	Quota limit for the subscriber.
soft_limit string	Soft limit in percent for the subscriber. Default is 80.
subscriber_id string / required	The subscriber ID can be 1 to 15 characters long and must include numbers from 0 to 9.
state string	The level of the subscriber 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

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

Examples

- name: Create a subscriber
  hitachivantara.vspone_block.vsp.hv_gateway_subscriber:
    state: present
    connection_info:
      address: gateway.company.com
      api_token: "eyJhbGciOiJS......"
      connection_type: "gateway"
    spec:
      subscriber_id: "811150"
      name: "Testsub123"
      soft_limit: "70"
      hard_limit: "80"
      quota_limit: "20"

- name: Delete a subscriber
  hitachivantara.vspone_block.vsp.hv_gateway_subscriber:
    state: absent
    connection_info:
      address: gateway.company.com
      api_token: "eyJhbGciOiJS......"
      connection_type: "gateway"
    spec:
      subscriber_id: "811150"

- name: Update a subscriber
  hitachivantara.vspone_block.vsp.hv_gateway_subscriber:
    state: present
    connection_info:
      address: gateway.company.com
      api_token: "eyJhbGciOiJS......"
      connection_type: "gateway"
    spec:
      subscriber_id: "811150"
      quota_limit: "30"

Return Values

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

Key	Description
data dictionary	Newly created subscriber object. Returned: success
hard_limit_in_percent string	Hard limit in percent for the subscriber. Returned: success Sample: `"80"`
message string	Message related to the subscriber operation. Returned: success Sample: `""`
name string	Name of the subscriber. Returned: success Sample: `"Test1234"`
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: `"20"`
soft_limit_in_percent string	Soft limit in percent for the subscriber. Returned: success Sample: `"70"`
state string	State of the subscriber. Returned: success Sample: `""`
subscriber_id string	Unique identifier for the subscriber. Returned: success Sample: `"1234"`
time integer	Timestamp of the subscriber operation. Returned: success Sample: `1716272732`
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: `""`
used_quota_in_percent integer	Used quota in percent for the subscriber. Returned: success Sample: `-1`

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