Skip to main content

GET – License Properties

Use the GET method to retrieve the XCC2_Platinum License or VROC_VMD info.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/LicenseService/Licenses/XCC2_Platinum|VROC_VMD

Request body​

None

Response body​

Field

Type

Description

Id

String

“XCC2_Platinum” or “VROC_VMD”

Name

String

“Lenovo XClarity Controller 2 Platinum Upgrade” or “Intel VROC VMD NVMe RAID Premium”

Description

String

This resource is used to represent a license for a Redfish implementation.

LicenseType

String

“Production”

LicenseOrigin

String

“Installed” or “BuiltIn”

ExpirationDate

String

The expiration date of the license.

If no constraints, show “null”

Removable

Boolean

The value is true, if "LincenseOrigin" equals to "Installed";

The value is false if "LincenseOrigin" equals to "BuiltIn".

Manufacturer

String

“Lenovo”

LicenseString

String

null

EntitlementId

String

Machine type plus Serial No.

AuthorizationScope

String

“Service” for platinum and “Device” for VMD

RemainingUseCount

Integer

always 0

DownloadURI

String

"/LicenseDownload/license_XCC2_Platinum" or “/LicenseDownload/license_VROC_VMD”

Status

Object

Expanded

 

State

String

Mapping with Key status

0 : “Enabled”;

others: “Disabled”

 

Health

String

“OK”

Links

Object

Expanded

 

AuthorizedDevices

Link

empty

Status code​

HTTP Status CodeError Message ID
400BadRequest
500InternalError

Example​

The following example JSON response is returned:

XCC2_Platinum license:

{
    "@odata.context": "/redfish/v1/$metadata#License.License",
    "RemainingUseCount": 0,
    "LicenseString": null,
    "LicenseOrigin": "Installed",
    "EntitlementId": "7D721234567890",
    "Removable": true,
    "ExpirationDate": null,
    "Links": {
        "AuthorizedDevices": []
    },
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "LicenseType": "Production",
    "AuthorizationScope": "Service",
    "@odata.etag": "\"68be1d681b0f2aee23f\"",
    "DownloadURI": "/LicenseDownload/license_XCC2_Platinum",
    "Oem": {
    },
    "Description": "This resource is used to represent a license for a Redfish implementation.",
    "Manufacturer": "Lenovo",
    "Id": "XCC2_Platinum",
    "Name": "Lenovo XClarity Controller 2 Platinum Upgrade",
    "@odata.type": "#License.v1_0_0.License",
    "@odata.id": "/redfish/v1/LicenseService/Licenses/XCC2_Platinum"
},
VROC_VMD license:
{
    "Id": "VROC_VMD",
    "Name": "Intel VROC VMD NVMe RAID Premium",
    "@odata.type": "#License.v1_0_0.License",
    "@odata.id": "/redfish/v1/LicenseService/Licenses/VROC_VMD",
    "Links": {
        "AuthorizedDevices": []
    },
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Description": "This resource is used to represent a license for a Redfish implementation.",
    "DownloadURI": "/LicenseDownload/license_VROC_VMD",
    "RemainingUseCount": 0,
    "LicenseOrigin": "Installed",
    "@odata.context": "/redfish/v1/$metadata#License.License",
    "LicenseString": null,
    "AuthorizationScope": "Device",
    "Manufacturer": "Lenovo",
    "EntitlementId": "7D7512345678",
    "@odata.etag": "\"640ed2d2c16524ec2a8\"",
    "LicenseType": "Production",
    "Oem": {
        "Lenovo": {
            "IdTypes": [
                "MTSN"
            ],
            "@odata.type": "#LenovoLicense.v1_0_0.LenovoLicense",
            "DescTypeCode": 32802
        }
    },
    "ExpirationDate": null,
    "Removable": true
}