hitachivantara.vspone_block.vsp.hv_gateway_unsubscribe_resource module – Manages un-subscription of resources for 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_unsubscribe_resource.

New in hitachivantara.vspone_block 3.1.0

DEPRECATED

Removed in:

version 4.0.0

Why:

The connection type gateway is deprecated.

Alternative:

Not available.

Synopsis

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)

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.

spec

dictionary / required

Specification for the un-subscription task.

resources

list / elements=dictionary / required

Resources information that to be unsubscribed.

type

string / required

Type of the resource.

values

list / elements=string / required

List of values for the resource.

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: 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: Try to unsubscribe listed resources
  hitachivantara.vspone_block.vsp.hv_gateway_unsubscribe_resource:
    connection_info:
      address: gateway.company.com
      api_token: "eyJhbGciOiJS......"
      connection_type: "gateway"
      subscriber_id: "1234"
    spec:
      resources:
        - type: "hostgroup"
          values: ["test-001", "test-005"]
        - type: "volume"
          values: ["5015", "5016"]
        - type: "port"
          values: ["CL5-A", "CL1-A"]

Return Values

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

Key

Description

data

list / elements=dictionary

List of failure and success tasks for the un-subscription try.

Returned: success

error

list / elements=string

List of error messages encountered during the un-subscription process.

Returned: success

Sample: ["Did not find Host Group test-001.", "Unable to untag Host Group test-005 from subscriber 811150 since it is already attached to volumes.", "Failed to untag storage volume 5015 from subscriber 811150 as it is tagged to a host group or iSCSI target", "Failed to untag storage volume 5016 from subscriber 811150 as it is tagged to a host group or iSCSI target", "Host group is present in Port CL5-A that tagged to the subscriber 811150", "Did not find Port with ID CL1-A.", "Storage is not registered", "Resource not found", "Unable to find the resource. localpair-6764f2c78f8f53a1766ad716a65206f8."]

info

list / elements=string

List of informational messages encountered during the un-subscription process.

Returned: success

Sample: ["Found 1 Host Group(s) called test-005.", "Found Volume with LDEV ID 5015.", "Found Volume with LDEV ID 5016.", "Found Port with ID CL5-A.", "Found shadowimage with ID localpair-6764f2c78f8f53a1766ad716a65206f7."]

Status

  • This module will be removed in version 4.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)