License Manager

Learn about License Manager, a free, opt-in service that allows you to bring your own licenses (BYOL) into Oracle Cloud Infrastructure.

Licenses are defined in terms of their requirements and entitlements, according to the metric the license is created for. License Manager helps you better understand your licensing needs, and eases making business decisions based on your licensing needs. After you have created your licenses, your licensing requirements are calculated every hour.

Use License Manager to perform the following tasks:

Automate the license portability rules for Oracle Database products to OCI Database PaaS services. This eliminates overhead for Software Asset Managers (SAMs) and developers in an enterprise. Developers can create BYOL Oracle Database resources, such as Autonomous AI Database, without needing to worry about creating visibility into their infrastructure for their SAM. A resource can be BYOL, which means Oracles charges you for infrastructure, but not licensing fees for software running on it. A resource can also be license included, which means the cost includes infrastructure and the software licensing fee.
Track license usage for Oracle Database products or third-party products by Compute resources. As a result, you have a single observation and license usage tracking location of all Oracle and third-party licenses in OCI.
Obtain reporting of BYOL resources that have licensing needs. Monitor and manage a list of email addresses to be notified about the expiration or over-subscription of licenses.

Supported Products

License Manager supports the following Oracle products and options:

Oracle Database Enterprise Edition
Oracle Database Standard Edition
Oracle Database Standard Edition One
Oracle Database Standard Edition 2
Real Application Clusters
Multitenant
Active Data Guard

Required IAM Policy

To use Oracle Cloud Infrastructure, an administrator must be a member of a group granted security access in a policy by a tenancy administrator. This access is required whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you get a message that you don't have permission or are unauthorized, verify with the tenancy administrator what type of access you have and which compartment your access works in.

If you're new to policies, see Getting Started with Policies and Common Policies.

To use License Manager, the following policy statements are required:

ALLOW GROUP <Group Name> to Manage licensemanager-settings in tenancy
ALLOW GROUP <Group Name> to Manage licensemanager-record in tenancy

Authentication and Authorization

Each service in Oracle Cloud Infrastructure integrates with IAM for authentication and authorization, for all interfaces (the Console, SDK or CLI, and REST API).

An administrator in an organization needs to set up groups , compartments , and policies that control which users can access which services, which resources, and the type of access. For example, the policies control who can create new users, create and manage the cloud network, create instances, create buckets, download objects, and so on. For more information, see Managing Identity Domains. For specific details about writing policies for each of the different services, see Policy Reference.

If you're a regular user (not an administrator) who needs to use the Oracle Cloud Infrastructure resources that the company owns, contact an administrator to set up a user ID for you. The administrator can confirm which compartment or compartments you can use.

Viewing License Summary Activity

The License Manager Overview page provides an overall summary of your license activity. The page allows you to get quick insights into your most utilized licenses, Bring Your Own License (BYOL) resources needing the most licenses by OCPUs and ECPUs, an overall count of BYOL and license included resources, and licenses at or near expiration.

To view the Overview page and its details, open the navigation menu and select Governance & Administration. Under License Management, select Overview. The License Manager Overview page opens.

The top of the page has tiles to indicate the totals for the following:

Product Licenses: The total number of product licenses.
BYOL Resources: The total number of BYOL resources. Corresponds to what is listed in the Top BYOL resources by OCPUs and Top BYOL resources by ECPUs tables.
License Included Resources: The count of license-included Database PaaS resources you have created in the tenancy.
Licenses at or near expiration: The total number of license records within 90 days of expiration.

Following the totals summary, the Top Utilized Product Licenses table displays the following:

Product License: The product license name. Select the linked name to go to its details page.
Status: The license status, which can be the following:
- Ok: The license has active license records for Oracle products, and active license records and an image associated for third-party licenses.
- Incomplete: The Oracle product license was created without any active license records within it. For third-party products, the status is Incomplete if there aren't any active records or images associated with the license.
- Issues Found: Over-subscribed licenses. The license requirement exceeds the entitlement.
- Warning: Shown for license records when all licensing requirements (mandatory options or base product licenses) aren't found in License Manager. Warning is also shown if data hasn't been updated in more than 24 hours.
Requirement: What all the resources attributed to a license need, to be considered fully licensed. The licensing requirement is calculated every hour.
Entitlement: The sum of all license counts in your license records.
Metric: The metric that matches your licensing terms.

The Top BYOL resources by OCPUs table lists the following:

Resource OCID: Select the link to go directly to the BYOL resource.
OCPUs: The total number of OCPUs used by the BYOL resource.
Compartment: The associated compartment.

The Top BYOL resources by ECPUs table lists the following:

Resource OCID: Select the link to go directly to the BYOL resource.
ECPUs: The total number of ECPUs used by the BYOL resource.
Compartment: The associated compartment.

Managing Licenses

Open the navigation menu and select Governance & Administration. Under License Manager, select Product Licenses.

The Product Licenses page opens. Here you can view and manage license entitlements and requirements, in the metric a license was created for.

Listing the Licenses

The Product Licenses page lists all product licenses in a table containing the following information:

Product License: Displays the name of the license. This is a link you can select to display details of the license. For more information, see Viewing the Details of a License.
Status: Displays the status of the license:
- Ok
- Incomplete
- Issues Found: For licenses that don't meet your licensing requirements.
- Warning
See Viewing License Summary Activity for Status field descriptions.
Requirement
Entitlement
Metric
License Records

You can view license entitlements and requirements, in the metric a license was created for, from the Product Licenses page. Licenses that don't meet your licensing requirements have a status of Issues Found.

Adding a License

You can create either Oracle or third-party licenses. Adding third-party licenses is similar to the process of adding Oracle products, however, you're restricted to OCPUs as the only metric. Work with your third-party vendor to better understand how a licensing term translates.

From the Product Licenses page, select Add Product License.
The Add Product License panel opens.
Select one of the following options:
- Oracle: The license vendor for all Oracle products.
- Third Party: The license vendor for all non-Oracle product licenses.
Perform the following tasks depending on the vendor type you selected:
- Oracle: Select a Product from the list:
  - Oracle Database Enterprise Edition
  - Oracle Database Standard Edition
  - Oracle Database Standard Edition One
  - Oracle Database Standard Edition 2
  You can also create a license by selecting Options and choosing the following from the Product list:
  - Real Application Clusters
  - Multitenant
  - Active Data Guard
  Select a Metric that matches your licensing terms, whether Processors or Named User Plus.
- Third Party: In Vendor and Product, enter the vendor and product names.
Enter the Metric depending on the vendor type you selected:
- Oracle: Select the option that matches your licensing terms:
  - Processors
  - Named User Plus
- Third Party: The metric value is fixed as OCPU.
Enter the following information for License record:
- Record Name: Specify a license record name. Avoid entering confidential information.
- Customer Support Identifier (CSI): (Oracle only) See your support contract and enter the CSI corresponding to the license.
- Unique identifier: (Third Party only) Enter a unique identifier based on your contract with your licensor.
- License Term: You can specify if your license is unlimited (Unlimited License Agreement licenses), or has a specific count associated with it (Full Use licenses). Select either Perpetual or Term-Limited.
  If selecting Perpetual, specify the Support Contract End Date.
  If selecting Term-Limited, specify both the License End Date and the Support Contract End Date.
- License Quantity: Specify the license quantity available for use based on your contractual terms, and accounting for licenses used on-premises or on other cloud platforms. Select either Count or Unlimited.
  If selecting Count, specify a license quantity value in the field (default is 1).
Note

You can add more license records after you create the product license.
(Optional) To track license utilization on Compute resources, you can associate a compute image with your license. An image is a template of a virtual hard drive that determines the operating system and other software for an instance.

Under Image, select Choose Image. The Browse All Images panel opens. The Image Source field changes based on whether the license you are creating is an Oracle or Third Party license.

When creating an Oracle license, Oracle Images is selected and the list of available images is displayed. Choose from the list of BYOL Oracle enterprise images and solutions enabled for Oracle Cloud Infrastructure. For any image under Image Name, you can select the down arrow () to expand the Image Build details, and select the version number for the particular image. Only one image can be selected when creating the product license, but you can add more images after creation.

When creating a third-party license, Partner Images is selected and the list of available third-party partner images is displayed, in terms of the Image Name and the Publisher. Select the down arrow () to expand the Image Build details, and select the version number for the particular partner image. As with Oracle images, one image can be selected when creating the product license, but you can add more images after creation.

After choosing the image, select the option to indicate that you agree to the legal terms for the chosen image. Select Select Image.
If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.
Select Add.

A notification is displayed that the new license was saved successfully, and a new license details page (for the license you created) opens. The new license is also added to the Product Licenses page.

Importing Oracle Product Licenses

You can perform bulk import of Oracle product licenses, using a predefined Excel template. From the Product Licenses page, you can download the provided template file, edit it, and then import it to add licenses.

You can import the following types of licenses:

Full Use: Licenses that have a specific count associated with them.
ULA: Unlimited License Agreement. A count doesn't need to be entered for ULA licenses.

See your support contract for any licensing details, and account for any usage outside of Oracle Cloud Infrastructure when entering quantities for Full Use licenses. You can import several files but they can only be imported one at a time.

To import Oracle product licenses:

From the Product Licenses page, select Import Oracle Product Licenses.
The Import Oracle Product Licenses panel opens.
Select Download Template.
The bulkUploadTemplate.xlsx template is downloaded to your computer. The template file has the following fields:
- Product Name
- Metric
- License Term
- License End Date: A license end date isn't needed for a perpetual license.
- License Level
- License Count
- CSI
- Support Contract End Date
Update the Excel file with your license information and save it where it can be uploaded to the License Manager.
On the Import Oracle Product Licenses panel select Drop a file or select one and browse to the Excel file containing the product licenses to upload it. You can also drag the Excel file into in the panel to upload it.
Select Import.
The Excel file is uploaded. A confirmation message appears in the Product Licenses page to indicate how many license records were imported, and if any duplicates were found.

Your newly imported licenses are accessible on the Product Licenses page, where you can then view more details about the licenses.

Viewing the Details of a License

From the Product Licenses page you can select the linked product license name, or select View from the license's the Actions menu, to open the details page of the license.

The license's details page contains the following information:

OCID
Type
Metric
Vendor
Entitlement
Requirement: Indicates the license requirement status and value. A green status indicates that the product is fully licensed. A red status indicates an overage, for cases where the license requirement exceeds the entitlement.
Compartment

On a product license details page you can perform the following tasks:

View the overall status.
View or download resource consumption details.
View, edit, delete, and download license records.
View, add, or remove images associated with a product license.

Viewing Consumption

The Consumption table shows BYOL resource license requirements in the tenancy, allowing you to view the resources that are attributed to a license and their individual licensing requirements. Data is delayed by one hour. The table is organized in terms of the following:

Resource OCID: Select the link to go directly to the particular BYOL resource.
Product Name: The license product (ECPU-supported products are indicated in this field).
Compartment: The associated compartment.
Requirement (<type>): The license, where <type> refers to the metric type.

The warning icon indicates that you might not have licenses created for mandatory options to meet the licensing needs of a specific resource, per the license portability rules. You can navigate directly to the resources shown in the list by selecting the direct link for each resource OCID shown in the Consumption table. As a result, you can make right-sizing changes as needed.

Select Download CSV to get a CSV version of the consumption information. The CSV file also has the same field listing as the Consumption table, including a Missing Licensing Requirements field. The OCI Metric of Resource field in the CSV file also indicates whether the resource refers to OCPU or ECPU.

Managing License Records

The License Records table shows all the license records in a product license. From License Records you can view all license record details, add more license records, and edit or delete license records. The table has the following fields:

Record Name: Select the linked record name to open the license record details page, or select View from the Actions menu. From the license record details page, you can delete the record or add tags. The following information is displayed:
- OCID
- Entitlement
- Metric
- Support End Date
- Product
- License Term
- Customer Support Identifier (CSI)
Customer Support Identifier (CSI)
Quantity
License Expiration
Support Expiration Date: If a license is at or near (within 90 days) its expiration date, the status is indicated in this field.

Add a License Record

From the record's the Actions menu, select Add. The Add License Record panel opens.

You can add license records in the same manner as when you're adding a new product license. Optionally, add any tagging options, or select Add to add the record. A message is displayed that the new record was saved successfully, and the License Records table reloads to display the new record.

Editing a License Record

From the record's the Actions menu, select Edit. The Edit License Record panel opens.

You can modify the same fields as when you're adding a new product license. Optionally, add any tagging options, or select Save when finished editing. A message is displayed to indicate that you saved successfully and the License Records table reloads to display the updated record.

Deleting a License Record

From the record's the Actions menu, select Delete.

Confirm the record deletion and select Delete. The License Records table reloads with the deleted record removed.

Managing Images

The Images table shows the list of images associated with the product license. The table has the following fields:

Image Name
Version
Publisher

Adding an Image

From the record's the Actions menu, select Add Image. The Browse All Images panel opens.

You can add images in the same manner as when you're adding a new product license. Agree to the legal terms and select Select Image when you're ready to add the new image.

A message is displayed that the new image was saved successfully, and the image appears in the Images table.

Removing an Image

From the image's the Actions menu, select Remove from an image's the Actions menu.

Confirm the image removal and select Remove. The Images table updates with the image removed.

Notifications

The License Manager Notifications page allows you to manage the list of email addresses that can be notified about expirations or subscription overages. Emails are sent on a weekly basis.

If there are items that require action, you receive an email that provides a License Manager summary. The email highlights the product licenses that are over-subscribed, and license records near or past their license or support contract expiration dates.

To manage notifications, open the navigation menu and select Governance & Administration . Under License Management , select Notifications. The License Manager Notifications page opens.

In the Email Recipients field, enter one or more email addresses to receive alert notifications. You can include several addresses by separating them using commas, spaces, tabs, or newlines.

Select Save. A message is displayed to indicate that the email addresses were saved successfully.

Using the CLI

To manage bulk uploads:

oci license-manager bulk-upload-template get

To manage compartment configuration:

To manage license metrics:

oci license-manager license-metric get

To manage product licenses:

To manage license records:

To manage top utilized product licenses and resources:

Using the API

For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.

Use the following in the License Manager API for license management.