hitachivantara.vspone_block.sds_block.hv_sds_block_license module – Manage licenses on SDS Block storage system

Note

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

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Create a license by registering a key code on SDS Block storage system.
Delete a license from SDS Block storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_license.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. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary / required	Specification for the license to manage.
id string	The unique identifier of the license to delete. Required when state is ‘absent’.
key_code string	The license key code to register. Required when state is ‘present’.
state string	The desired state of the license. Use ‘present’ to create/register a new license. Use ‘absent’ to delete a license. Choices: `"present"` ← (default) `"absent"`

Attributes

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

Examples

- name: Create a license by registering a key code
  hitachivantara.vspone_block.sds_block.hv_sds_block_license:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      key_code: "1LGB7VTDBH0J7QAQ3EEQM3O1VZLYBO1ER4HU7KXAN0DQ3GT6JW9NZCP1FS5IVAQ4BPF7DOO53TN"

- name: Delete a license by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_license:
    state: absent
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "222c8201-805f-453d-99ac-0b21b8a66bd6"

Return Values

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

Key	Description
changed boolean	Whether the license was created or deleted Returned: always Sample: `true`
license dictionary	The created license details Returned: when state is present and license is created Sample: `{"id": "222c8201-805f-453d-99ac-0b21b8a66bd6", "programProductName": "Data At Rest Encryption", "status": "Active"}`
license_id string	The ID of the created or deleted license Returned: always Sample: `"222c8201-805f-453d-99ac-0b21b8a66bd6"`

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