Skip to main content

Enable Intel® On Demand

A processor is equipped with various computing capabilities. Basic capabilities are available at the initial processor installation, while others remain inactivated. As development environment and tasks evolve, computing demands may accelerate and require leverage of the previously inactivated processor capabilities. In such cases, user can select desired processor capabilities and activate them though Intel On Demand feature—a feature that allows user to customize processor capabilities according to environment and tasks at hand. The following section specifies system hardware and software requirement, Intel On Demand enabling and transferring procedures, and list of processor capabilities.

This documentation includes the following sections:

Supported processor​

Intel On Demand is only supported by Intel On Demand capable processors. For more information on Intel On Demand capable processors supported by product_short_name, see .

Installation tool​

Intel On Demand can be installed via Lenovo XClarity Controller (XCC) and Lenovo XClarity Essentials OneCLI (LXCE OneCLI). Make sure the XCC and LXCE OneCLI installed in your system supports Intel On Demand.

  1. Checking Intel On Demand support on Lenovo XClarity Controller (XCC)

    • In XCC WebGUI, go to BMC Configuration > License. The License tab will include the On Demand Capabilities for Intel CPU section.

      If On Demand Capabilities for Intel CPU is not shown, update XCC firmware,

    • With XCC REST API (TBD)

  2. Checking Intel On Demand support on LXCE OneCLI

    • LXCE OneCLI version must be at 4.2.0 or above.

Enabling Intel On Demand Suites​

  1. The processor capabilities are categorized as Suites. Select the Suite that meets your workload needs, see Intel On Demand Suites and Features.

  2. After ordering the Suite, you will receive Authorization Code via e-mail.

  3. PPIN is a mandatory information for enabling Intel On Demand. Read the PPIN of the processor that is to be installed with the Suite. See Reading PPIN.

  4. Go to Lenovo Features on Demand website and input the Authorization Code to acquire the Activation Key for the Suite.

  5. In the website, input Machine Type, Machine serial number, and PPIN.

  6. The website will generate the Activation Key. Download the Activation Key.

  7. Install the Suite to the processor with the Activation Key via XCC or LXCE OneCLI. See Installing Intel On Demand to processor.

  8. AC cycle the server.

  9. (Optional) Upload Intel On Demand State Report to notify Intel that the Suite is successfully installed to the processor. See Acquiring and uploading Intel On Demand State Report.

For reference, see Using Lenovo Features on Demand.

Transferring Intel On Demand Suites​

After replacing a processor, you may need to transfer the Suites from the defective processor to the new processor. Complete the following steps to transfer Suites to new processor.

  1. Before removing the defective processor from the system, read the PPIN of the defective processor. See Reading PPIN.

  2. After installing the new processor, read the PPIN of the new processor. See Reading PPIN.

  3. Go to Lenovo Features on Demand website and input the PPIN of the defective processor. (Input PPIN in the UID section.)

  4. Select the Suite to be transferred.

  5. Input the PPIN of the new processor.

  6. The website will generate the new Activation Key. Download the new Activation Key. See Installing Intel On Demand to processor.

  7. Install the Suite to the new processor with the new Activation Key via XCC or LXCE OneCLI.

  8. AC cycle the server.

  9. (Optional) Upload Intel On Demand State Report to notify Intel that the Suite is successfully installed to the processor. See Acquiring and uploading Intel On Demand State Report.

For reference, see Using Lenovo Features on Demand.

Reading PPIN​

Protected Processor Inventory Number, or PPIN, is a mandatory information for enabling Intel On Demand. PPIN can be read via XCC Web GUI, XCC REST API, and LXCE OneCLI. See the following for more information.

XCC Web GUI

Open XCC Web GUI, go to Inventory page > CPU tab > Expand > PPIN

XCC REST API
  1. Use the GET method with the following Request URL:
    GET https://bmc_ip/redfish/v1/Systems/1/Processors
    For example:
    GET https://bmc_ip/redfish/v1/Systems/1/Processors

  2. In the response JSON object, the Members field shows reference link to an element of processor resource.

    For example:
    "Members":[
    {
    @odata.id: "/redfish/v1/Systems/1/Processors/1"
    },
    {
    @odata.id: "/redfish/v1/Systems/1/Processors/2"
    }
    ],
  3. Select the processor you need to read the PPIN from. Use the GET method with the following Request URL, where x is the CPU numbering:
    GET https://bmc_ip/redfish/v1/Systems/1/Processors/x
    For example, to read Processor 1 PPIN, see the following:
    GET https://bmc_ip/redfish/v1/Systems/1/Processors/1

  4. In the response JSON object, the ProcessorId field shows the ProtectedIdentificationNumber field, which is the PPIN info of the requested CPU.

    For example:

    "ProcessorId":{
      "ProtectedIdentificationNumber":"55AAC61BB1CDC49F"
    },

LXCE OneCLI command
Input the following command:
OneCli.exe fod showppin -b XCC_USER:XCC_PASSW0RD@XCC_HOST
The output show PPIN information. For example:
Machine Type: 7D75
Serail Number: 7D75012345
FoD PPIN result:
======================================
|   Socket ID   |        PPIN        |
|  Processor 1  |  49F2B81FGEF89BD3  |
|  Processor 2  |  558DCC1FF51421F3  |
======================================

Installing Intel On Demand to processor​

Install the Suite to the processor with the Activation Key downloaded from the Lenovo Features on Demand website via XCC or LXCE OneCLI.

XCC Web GUI

  1. Open XCC Web GUI, go to BMC Configuration > License > Upgrade License > Browse > Import to upload the Activation Key

XCC REST API

TBD

LXCE OneCLI
Input the following command, where <key_file> specifies the Activation Key.:
OneCli.exe fod install --keyfile <key_file>
If successfully installed, the response will show:
successfully install key

Acquiring and uploading Intel On Demand State Report​

After completing enabling or transferring Intel On Demand, acquire and upload the State Report via XCC Web GUI, XCC REST API, and LXCE OneCLI. See the following for more information.

XCC Web GUI

  1. Open XCC Web GUI, go to BMC Configuration > License > Export State Report

  2. Upload State Report via On Demand Feedback section in Lenovo Features on Demand website.

XCC REST API
  1. Use the GET method with the following Request URL to retrieve CPU State Report API, where X is the CPU numbering:
    GET https://bmc_ip/redfish/v1/LicenseService/Licenses/CPUX_OnDemandCapability
    For example, to retrieve CPU 1 State Report API, see the following:
    GET https://bmc_ip/redfish/v1/LicenseService/Licenses/CPU1_OnDemandCapability
  2. In the response JSON object, the response of the target field of the LenovoLicense.ExportStateReport field is the CPU State Report API, where X is the CPU numbering:
    "Actions"{
        "Oem"{
            "LenovoLicense.ExportStateReport":{
               "title": "ExportstateReport",
               "target": "/redfish/v1/LicenseService/Licenses/CPUX_OnDemandCapability/Actions/Oem/LenovoLicense.ExportStateReport"
    In the following example, the response of the target field is the CPU 1 State Report API. Copy the CPU 1 State Report API.
    "Actions"{
        "Oem"{
            "LenovoLicense.ExportStateReport":{
               "title":"ExportstateReport",
               "target": "/redfish/v1/LicenseService/Licenses/CPU1_OnDemandCapability/Actions/Oem/LenovoLicense.ExportStateReport"

  3. Retrieve the State Report.

    1. Use the POST method with the following Request URL with CPU State Report API to retrieve the State Report, where X is the CPU numbering:
      POST https://bmc_ip/redfish/v1/LicenseService/Licenses/CPUX_OnDemandCapability/Actions/Oem/LenovoLicense.ExportStateReport
      For example, to retrieve CPU 1 State Report, see the following:
      POST https://bmc_ip/redfish/v1/LicenseService/Licenses/CPU1_OnDemandCapability/Actions/Oem/LenovoLicense.ExportStateReport
    2. Use an empty JSON object as POST data:

      • When using API tool such as Postman, fill an empty JSON object in Body > Raw > JSON

      • When using the curl tool, add parameters -d '{}'

  4. In the response, retrieve the State Report in the StateReports field.

  5. Upload State Report via On Demand Feedback section in Lenovo Features on Demand website.

LXCE OneCLI
  1. Acquire State Report with the following command:
    OneCli.exe fod exportreport -b XCC_USER:XCC_PASSWORD@XCC_HOST

  2. Upload State Report with the following command:

    OneCli.exe fod uploadreport --file CPU1_xxxxxx_StateReport.json --kmsid KMS_USER:KMS_PASSWORD
    Where:

    CPU1_xxxxxx_StateReport.json is the file name downloaded from the fod exportreport command in Step 1.

    KMS_USER and KMS_PASSWORD are your ID and password on the Lenovo Features on Demand website.

Intel On Demand Suites and Features​

Note
Supported Suites vary by product. For more information, see .
Table 1. Intel On Demand Suites

  • Communications & Storage Suite 4

    • Intel Quick Assist Technology (Intel QAT)

    • Intel Dynamic Load Balancer (Intel DLB)

    • Inte Data Streaming Accelerator (Intel DSA)

  • Analytics Suite 4

    • Intel In Memory Accelerator (Intel IAA)

    • Intel Data Streaming Accelerator (Intel DSA)

  • Communications & Storage Suite 2

    • Intel Quick Assist Technology (Intel QAT)

    • Intel Dynamic Load Balancer (Intel DLB)

  • Analytics Suite 1

    • Intel In Memory Accelerator (Intel IAA)

  • SGX 512

    • Intel Software Guard Extensions (Intel SGX) 512 GB

Features

  • Intel Quick Assist Technology (Intel QAT)1

    Intel® QAT which helps free up processor cores by offloading encryption, decryption, and compression so systems can serve a larger number of clients or use less power. With Intel QAT, 4th gen Intel Xeon Scalable processors are the highest performance CPUs that can compress and encrypt in a single data flow.

  • Intel Dynamic Load Balancer (Intel DLB)2

    Intel DLB is a hardware managed system of queues and arbiters connecting producers and consumers. It is a PCI device envisaged to live in the server CPU uncore and can interact with software running on cores, and potentially with other devices.

  • Inte Data Streaming Accelerator (Intel DSA)1

    Intel DSA drives high performance for storage, networking, and data-intensive workloads by improving streaming data movement and transformation operations. Designed to offload the most common data movement tasks that cause overhead in data center-scale deployments, Intel DSA helps speed up data movement across the CPU, memory, caches, all attached memory, storage, and network devices.

  • Intel In Memory Accelerator (Intel IAA)1

    Intel IAA helps run database and analytics workloads faster, with potentially greater power efficiency. This built-in accelerator increases query throughput and decreases the memory footprint for in-memory database and big data analytics workloads. Intel IAA is ideal for in-memory databases, and source databases.

  • Intel Software Guard Extensions (Intel SGX) 512 GB3

    Intel® SGX offers hardware-based memory encryption that isolates specific application code and data in memory. Intel SGX allows user-level code to allocate private regions of memory, called enclaves, which are designed to be protected from processes running at higher privilege levels.

References

  • 1Achieve Performance Advantage with Intel oneAPI, AI Tools, and 4th Gen Intel® Xeon® Scalable Processors Featuring Built-in Accelerator Engines, (n.d.). Intel. https://www.intel.com/content/www/us/en/developer/articles/technical/performance-advantage-with-xeon-and-oneapi-tools.html

  • 2Intel® Dynamic Load Balancer, (2023, May 23) Intel. https://www.intel.com/content/www/us/en/download/686372/intel-dynamic-load-balancer.html

  • 3Intel® Software Guard Extensions (Intel® SGX), (n.d.) Intel. https://www.intel.com/content/www/us/en/architecture-and-technology/software-guard-extensions.html