License Management
In this section you will find all the guidelines to license and maintain your agent registration.
Topics
Register an agent - online
If your SAP Database server has internet access, you can connect the agent directly with the License Mananger in the CxLink Portal and the agent will retrieve a license automatically and will take care also of any license modification, renewal or revoke of it.
Follow these steps to connect the agent with the license manager and obtain a valid license:
Start emory-settings tool by launching the CxLink Backup configuration tool as SAP Database Administrator user.
/opt/emory/emorySelect License from Main Menu to initiate the license setup.
? CxLink Backup: [Use arrows to move, enter to select, type to filter] -------------------------------------------------------------------------------- Storage Providers profiles Set storage providers for backup/restore, disaster recovery and system copy Backups Lifecycle settings Monitoring -------------------------------------------------------------------------------- > License -------------------------------------------------------------------------------- Logging file settings Debug traces Show relevant information of this CxLink Backup -------------------------------------------------------------------------------- Catalog & Backups management -------------------------------------------------------------------------------- Generate troubleshooting package to be sent to Syntax Support -------------------------------------------------------------------------------- ExitSelect Register license from online license section:
? CxLink Backup: License ? Select action to perfom: [Use arrows to move, enter to select, type to filter] ------------------------------- ONLINE LICENSE -------------------------------- > Register license Unregister license ------------------------------- OFFLINE LICENSE -------------------------------- Generate request file Insert license Delete license file -------------------------------------------------------------------------------- Reset license (delete license files and recreate client UUID) -------------------------------------------------------------------------------- Check Emory license -------------------------------------------------------------------------------- BackAuthenticate with your CxLink Portal account user (same you use to sign in to the console) and select organization to license the product:
? CxLink Backup: License ? Select action to perfom: Register license License Console User name: cxlink.user@syntax.com License Console Password: ******** ? Organization: [Use arrows to move, enter to select, type to filter, ? for more help] Dummy_org_01 > Dummy_org_02If the registration is successfull, a message will be displayed:
Client correctly licensed System registered successfully
Register an agent - offline
If your server does not have internet access, similar to the SAP licensing process, a request file can be generated to obtain the final license from the console without the need to connect the agent. Inb the event of any license renewal, revocation or deletion process, the license must be updated manually in the agent.
Follow these steps to generate a request file to obtain a valid license from the console:
Start emory-settings tool by launching the CxLink Backup configuration tool as SAP Database Administrator user.
/opt/emory/emorySelect License from Main Menu to initiate the license setup.
? CxLink Backup: [Use arrows to move, enter to select, type to filter] -------------------------------------------------------------------------------- Storage Providers profiles Set storage providers for backup/restore, disaster recovery and system copy Backups Lifecycle settings Monitoring -------------------------------------------------------------------------------- > License -------------------------------------------------------------------------------- Logging file settings Debug traces Show relevant information of this CxLink Backup -------------------------------------------------------------------------------- Catalog & Backups management -------------------------------------------------------------------------------- Generate troubleshooting package to be sent to Syntax Support -------------------------------------------------------------------------------- ExitSelect Generate request file from offline license section:
? CxLink Backup: License ? Select action to perfom: [Use arrows to move, enter to select, type to filter] ------------------------------- ONLINE LICENSE -------------------------------- Register license Unregister license ------------------------------- OFFLINE LICENSE -------------------------------- > Generate request file Insert license Delete license file -------------------------------------------------------------------------------- Reset license (delete license files and recreate client UUID) -------------------------------------------------------------------------------- Check Emory license -------------------------------------------------------------------------------- BackThis will generate a request file <SID>.request with the contents that you should copy on the CxLink Portal
/opt/emory/conf/LNK.request file generatedCopy the contents of the generated file or move the file to your computer.
Sign in to the Cxlink Backup Service Hub
Navigate to Licenses section and search for a license with an empty host slot.
Select the desired license and click on the Register a host button.
Upload the file or Copy the file contents using the Host Registration pop-up, and click on Register host
Click on Download your license to obtain the license file from the successfull registration window.
Open the file and copy its contents to clipboard.
Back to the CxLink Backup configuration tool, choose Insert license from offline license section:
? CxLink Backup: License ? Select action to perfom: [Use arrows to move, enter to select, type to filter] ------------------------------- ONLINE LICENSE -------------------------------- Register license Unregister license ------------------------------- OFFLINE LICENSE -------------------------------- Generate request file > Insert license Delete license file -------------------------------------------------------------------------------- Reset license (delete license files and recreate client UUID) -------------------------------------------------------------------------------- Check Emory license -------------------------------------------------------------------------------- BackFill license file location and name:
? Select action to perfom: Insert license Offline license file: /tmp/license
Unregister an agent - online
If your SAP Database server has internet access, you can connect the agent directly with the License Mananger in the CxLink Portal and the agent will release the license automatically.
Follow these steps to connect the agent with the license manager and delete the license association:
Start emory-settings tool by launching the CxLink Backup configuration tool as SAP Database Administrator user.
/opt/emory/emorySelect License from Main Menu to initiate the license setup.
? CxLink Backup: [Use arrows to move, enter to select, type to filter] -------------------------------------------------------------------------------- Storage Providers profiles Set storage providers for backup/restore, disaster recovery and system copy Backups Lifecycle settings Monitoring -------------------------------------------------------------------------------- > License -------------------------------------------------------------------------------- Logging file settings Debug traces Show relevant information of this CxLink Backup -------------------------------------------------------------------------------- Catalog & Backups management -------------------------------------------------------------------------------- Generate troubleshooting package to be sent to Syntax Support -------------------------------------------------------------------------------- ExitSelect Unregister license from online license section:
? Select action to perfom: [Use arrows to move, enter to select, type to filter] ------------------------------- ONLINE LICENSE -------------------------------- Register license > Unregister license ------------------------------- OFFLINE LICENSE -------------------------------- Generate request file Insert license Delete license file -------------------------------------------------------------------------------- Reset license (delete license files and recreate client UUID) -------------------------------------------------------------------------------- Check Emory license -------------------------------------------------------------------------------- BackAuthenticate with your CxLink Portal account user (same you use to sign in to the console)
? CxLink Backup: License ? Select action to perfom: Register license License Console User name: cxlink.user@syntax.com License Console Password: ********If the de-registration is correct, a succesfull message will be displayed.
System unregistered successfully
Unregister an agent - offline
If your server does not have internet access, you will need to delete the license file from the CxLink Backup configuration tool and release the license manually in the CxLink Portal.
Follow these steps to generate a request file to obtain a valid license from the console:
Start emory-settings tool by launching the CxLink Backup configuration tool as SAP Database Administrator user.
/opt/emory/emorySelect License from Main Menu to initiate the license setup.
? CxLink Backup: [Use arrows to move, enter to select, type to filter] -------------------------------------------------------------------------------- Storage Providers profiles Set storage providers for backup/restore, disaster recovery and system copy Backups Lifecycle settings Monitoring -------------------------------------------------------------------------------- > License -------------------------------------------------------------------------------- Logging file settings Debug traces Show relevant information of this CxLink Backup -------------------------------------------------------------------------------- Catalog & Backups management -------------------------------------------------------------------------------- Generate troubleshooting package to be sent to Syntax Support -------------------------------------------------------------------------------- ExitSelect Delete license file from offline license section:
? Select action to perfom: [Use arrows to move, enter to select, type to filter] ------------------------------- ONLINE LICENSE -------------------------------- Register license Unregister license ------------------------------- OFFLINE LICENSE -------------------------------- Generate request file Insert license > Delete license file -------------------------------------------------------------------------------- Reset license (delete license files and recreate client UUID) -------------------------------------------------------------------------------- Check Emory license -------------------------------------------------------------------------------- BackIf the de-registration is correct, a succesfull message will be displayed.
License information has been deleted from the agent.Sign in to the Cxlink Backup Service Hub
Navigate to Licenses section and search for the license you want to detach from and click on the View license details button.
Filtering options
You can use the available filter options to find the proper license. You can search by SAP SID, hostname, license id, etc. to help you find the correct license.
- From the Hosts section, select the host you want to unregister and click on the Unregister host button.
View License Details
You can find the license information from both command line or CxLink Portal.
From CxLink Portal
You can find detailed information of a license and the agent attached from the CxLink Portal. To find this information, follow these steps:
Sign in to the Cxlink Backup Service Hub
Navigate to Licenses section and search for the license you want to detach from and click on the View license details button.
Filtering options
You can use the available filter options to find the proper license. You can search by SAP SID, hostname, license id, etc. to help you find the correct license.
From command-line
The client and license information are both stored on the same yaml file. If you want to check the license details in the server where the CxLink Backup agent is running, open the contents of the following file:
/opt/emory/conf/<SID>.id
The file contains the following information:
| Key | Description | Example value |
|---|---|---|
| ClientID | CxLink Backup Agent Unique identifier | aca0d5ab-7768-4782-a463-9b76593dd3a0 |
| License | License Identifier associated with the CxLink Backup agent | 580637de-8580-49a8-967c-53fe4925db9d |
| CustomerKey | Unique identifier of the Organization where the license belongs | rOxebnSkCu8CzCZU6ZD4l8Gc2Ygh7ZdG30tth8xJ |
| expireson | Expiration date for the installed license | 2020-12-24T09:05:10Z |
Recovering a license file
In the event that you want to recover your license file, you can do it from CxLink portal License Details page.
- In the Hosts section, select the host you want to recover the license file from.
- At the bottom of the host details row, click the Recover license file button.
- Save the resulting download file to your computer.