Obtaining a list of license information

Virtual Storage Platform One SDS Block Storage Administrator Guide

Version
1.17.x
Audience
anonymous
Part Number
MK-24VSP1SDS002-04

Obtain a list of information about a license as follows.

  • id: License ID (uuid)

  • programProductName: Program product name

  • status: License status

  • statusSummary: License status summary

  • cause: Reason for "Warning" or "Error" license status summary

  • keyType: License key type

  • permittedCapacityInTiB: Total logical capacity of all storage pools allowed by the license (null if no limitation is applied to the capacity) [TiB]

    (Cloud) When the license status summary is "Normal", but connection with AWS License Manager is unavailable temporarily, 0 is output.

  • totalPoolCapacityInGiB: Total logical capacity of all storage pools (null if no limitation is applied to the capacity) [GiB]

  • remainingDays: Number of remaining days (null if the license is valid infinitely)

  • checkedOutLicenseUsageInTiB:

    (Bare metal) null

    (Cloud) When the Floating base license is used, consumed capacity of the license secured by a storage cluster on AWS License Manager [TiB]. null if the base license is other than Floating.

  • capacityRate: Ratio of the total logical capacity of all the storage pools (totalPoolCapacityInGiB) against the capacity enabled by the license (permittedCapacityInTiB) [%] . If no limitation is applied, null is assumed.

  • Required role: Storage, RemoteCopy, Monitor, or Resource

Obtain a list of information about a license.

REST API: GET /v1/objects/licenses

CLI: license_list