Use the License Key Manager page to review the license key status of your Ops Manager installation and to install or release a license key. To learn how Ops Manager calculates license key status, see Ops Manager License Keys Overview.
Prerequisites
Before you begin, ensure that you have the Global Owner role. Users without this role see only the message Only Global Owners can view and manage license keys. on the License Key Manager page.
About the License Key Manager Page
The License Key Manager page shows the license key status of your Ops Manager installation. To open the page, click Admin, License Keys. The page has the following sections:
Overall status shows the status of your installation and the message that matches it. To learn about each status, see Ops Manager License Keys Overview.
Key Manager ID shows the ID that identifies your Ops Manager installation, including every instance in a high-availability setup. The Key Portal uses the Key Manager ID to issue a license key for your installation.
Installed license keys lists your license keys. The Active list shows license keys that cover your installation. The Inactive list shows expired, released, and denied license keys with their status. Use the View control to switch between the lists. The table shows the license key ID, the expiry date, when MongoDB generated the license key, and when you installed it.
Entitlements shows the entitlements of the selected license key. Click a license key ID to select it.
Find the Key Manager ID
Use the following procedure to find the Key Manager ID of your Ops Manager installation.
Install a License Key
Use the following procedure to generate a license key in the Key Portal and install it in Ops Manager.
Generate the license key in the Key Portal
Open the Key Portal at https://support.mongodb.com/keyportal. Use the Key Manager ID to add the Key Manager, and then generate your license key. Download the license key file. The file has the .json extension.
If you can't generate a license key, your MongoDB order might be expiring or pending renewal. Contact the person who manages your MongoDB Enterprise Advanced order or your MongoDB account team.
Upload the license key
Return to Ops Manager, click Upload license key, and select the license key file.
If Ops Manager accepts the license key, the page shows the new status. If Ops Manager rejects the license key, an error window appears. To resolve the error, see Troubleshoot Install Errors.
If you already have a license key file, click Upload license key at the top of the page to skip the instructions window.
If your Ops Manager installation can connect to MongoDB, Ops Manager installs renewed license keys automatically. To learn more, see Renew a License Key.
Release a License Key
Use the following procedure to release a license key from your Ops Manager installation.
Important
After you release a license key, you can't use it again. Without a valid license key, your Ops Manager installation might lose its active status. To restore the status, generate a new license key in the Key Portal and install it. For the steps, see Install a License Key.
Download a Release Receipt
Use the following procedure to download the release receipt of a license key that you released. Ops Manager offers a receipt only for released license keys. Keep the receipt as proof of the release. If your installation can't connect to MongoDB, upload the receipt in the Key Portal.
Troubleshoot Install Errors
When Ops Manager rejects a license key, the interface shows the message License key install failed with the following explanation:
The license key could not be validated. It may be corrupted orissued for a different Key Manager ID. Upload the correct licensekey to continue.The window also shows the error code and message that the API returns. The following table lists each error code with its HTTP status and message. The messages use the word artifact to refer to a license key:
Error Code | HTTP Status | Message |
|---|---|---|
| 400 | This file could not be read. It may be corrupted or was modified after signing. Contact your MongoDB account team to obtain a replacement. |
| 400 | This file cannot be verified - it may have been modified after signing. Contact your MongoDB account team to obtain a replacement. |
| 400 | This file was signed for a different version of Ops Manager or by an untrusted key. Contact your MongoDB account team for a compatible file. |
| 400 | This file's signing certificate is not valid for this Ops Manager. Contact your MongoDB account team to obtain a replacement. |
| 403 | This artifact is bound to specific Ops Manager instances and cannot be installed on this one. Contact your MongoDB account team. |
| 409 | This artifact is not newer than one already installed on this Ops Manager. Install the latest artifact issued by your MongoDB account team. |
Related Pages
For more information about license keys, see the following pages: