Getting a list of license information

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request obtains a list of software license information. You can also obtain the list by specifying the software name or installation status of the software.

For a list of storage systems that support this API, see Overview of the initial settings of a storage system.

Note:

If you execute this API request immediately after updating the license, the request might not be processed correctly if the system does not recognize the updated license. If this happens, wait a while, and then execute the request again.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/licenses

Request message

Object ID
None.
Query parameters

Parameter

Type

Filter condition

programProductName

string

(Optional) Software name

You cannot specify this parameter and the status parameter at the same time.

status

string

(Optional) Installation status of the software

You can specify the following values:

  • Installed
  • Installed (Disabled)
  • Not Installed
  • Not Enough License
  • Grace Period
  • Expired

You cannot specify this parameter and the programProductName parameter at the same time.

Body

None.

Response message

Body
{
  "data": [
    {
      "licenseId": 32775,
      "programProductName": "Dynamic Provisioning",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 24379
    },
    {
      "licenseId": 32835,
      "programProductName": "Dynamic Tiering",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 14682
    },
    {
      "licenseId": 32880,
      "programProductName": "Thin Image",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 940
    },
    {
      "licenseId": 32884,
      "programProductName": "global-active device",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 161
    }
  ]
}

The following is an example of output generated when the query parameters are specified:

{
  "data": [
    {
      "licenseId": 32775,
      "programProductName": "Dynamic Provisioning",
      "status": "Installed",
      "keyType": "Permanent",
      "capacityLimitStatus": "Unlimited",
      "usedCapacityInGB": 24379
    }
  ]
}

The following table lists the license information that you can obtain. For details about license information, see the System Administrator Guide.

Attribute

Type

Description

licenseId

int

License ID

programProductName

string

Software name

status

string

Installation status of the software

  • Installed: Installed
  • Installed (Disabled): Installed (License is disabled)
  • Not Installed: Not installed
  • Not Enough License: Installed (Not enough license capacity)
  • Grace Period: Not enough license capacity because of additional LDEVs or pool volumes, or creation of pairs
  • Expired: Expired

    Output when the keyType attribute is Temporary.

keyType

string

License key type

  • Permanent: For purchase (no limit on effective term)
  • Term: For purchase (effective term specified)
  • Temporary: For trial use before purchase
  • Emergency: For emergency use

capacityLimitStatus

string

Specified if the permitted license capacity has a limit

  • Limited: Limited
  • Unlimited: Unlimited

permittedCapacityInTB

long

Permitted license capacity (TB)

usedCapacityInGB

long

Volume capacity used by the software (GB)

remainingDays

int

Remaining days before expiration

  • If the keyType attribute is Term, Temporary, or Emergency: Remaining days before expiration
  • If a license for which the keyType attribute is Temporary is expired: Remaining days after the expiration date until re-installation of the software becomes available

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/licenses