hitachivantara.vspone_block.sds_block.hv_sds_block_license_facts module – Get license(s) from SDS Block storage system

Note

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

New in hitachivantara.vspone_block 4.6.0

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 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

Specification for the license(s) to retrieve.

If spec.id is provided, retrieves a single license by ID.

If spec is not provided or spec.id is empty, retrieves all licenses.

id

string

The unique identifier of the license to retrieve.

If not provided, all licenses will be retrieved.

program_product_name

string

The name of the program product.

status

string

Status of the license. Case-insensitive. Valid values is ‘Active’, ‘Warning’, ‘Overwritten’, ‘GracePeriod’, ‘Invalid’.

status_summary

string

License status summary.

Choices:

  • "Normal"

  • "Warning"

  • "Error"

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Retrieve all licenses
  hitachivantara.vspone_block.sds_block.hv_sds_block_license_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve specific license by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_license_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "4a7061b0-8cc0-4379-aec1-23184d26acd7"

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

license

dictionary

Single license object if spec.id is provided. None if not found.

Returned: when spec.id is provided

licenses

dictionary

Dictionary containing all licenses if spec.id is not provided.

Returned: when spec.id is not provided

data

list / elements=dictionary

List of license objects.

Returned: success

capacity_rate

integer

Capacity usage rate. Returns -1 if not set.

Returned: success

Sample: -1

checked_out_license_usage_in_tib

float

Checked out license usage in TiB. Returns -1.0 if not set.

Returned: success

Sample: -1.0

id

string

License ID.

Returned: success

Sample: "4a7061b0-8cc0-4379-aec1-23184d26acd7"

key_type

string

Type of license key.

Returned: success

Sample: "Perpetual"

permitted_capacity_in_tib

float

Permitted capacity in TiB. Returns -1.0 if not set.

Returned: success

Sample: -1.0

program_product_name

string

Name of the licensed program product.

Returned: success

Sample: "Data At Rest Encryption"

remaining_days

integer

Remaining days until license expiration. Returns -1 if not applicable (perpetual license).

Returned: success

Sample: -1

status

string

License status.

Returned: success

Sample: "Active"

status_summary

string

Summary of license status.

Returned: success

Sample: "Normal"

total_pool_capacity_in_gib

float

Total pool capacity in GiB. Returns -1.0 if not set.

Returned: success

Sample: -1.0

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)