Skip to main content

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:

  1. Start emory-settings tool by launching the CxLink Backup configuration tool as SAP Database Administrator user.


    _10
    /opt/emory/emory

  2. Select License from Main Menu to initiate the license setup.


    _18
    ? CxLink Backup: [Use arrows to move, enter to select, type to filter]
    _18
    --------------------------------------------------------------------------------
    _18
    Storage Providers profiles
    _18
    Set storage providers for backup/restore, disaster recovery and system copy
    _18
    Backups Lifecycle settings
    _18
    Monitoring
    _18
    --------------------------------------------------------------------------------
    _18
    > License
    _18
    --------------------------------------------------------------------------------
    _18
    Logging file settings
    _18
    Debug traces
    _18
    Show relevant information of this CxLink Backup
    _18
    --------------------------------------------------------------------------------
    _18
    Catalog & Backups management
    _18
    --------------------------------------------------------------------------------
    _18
    Generate troubleshooting package to be sent to Syntax Support
    _18
    --------------------------------------------------------------------------------
    _18
    Exit

  3. Select Register license from online license section:


    _15
    ? CxLink Backup: License
    _15
    ? Select action to perfom: [Use arrows to move, enter to select, type to filter]
    _15
    ------------------------------- ONLINE LICENSE --------------------------------
    _15
    > Register license
    _15
    Unregister license
    _15
    ------------------------------- OFFLINE LICENSE --------------------------------
    _15
    Generate request file
    _15
    Insert license
    _15
    Delete license file
    _15
    --------------------------------------------------------------------------------
    _15
    Reset license (delete license files and recreate client UUID)
    _15
    --------------------------------------------------------------------------------
    _15
    Check Emory license
    _15
    --------------------------------------------------------------------------------
    _15
    Back

  4. Authenticate with your CxLink Portal account user (same you use to sign in to the console) and select organization to license the product:


    _10
    ? CxLink Backup: License
    _10
    ? Select action to perfom: Register license
    _10
    License Console User name: cxlink.user@syntax.com
    _10
    License Console Password: ********
    _10
    ? Organization: [Use arrows to move, enter to select, type to filter, ? for more help]
    _10
    Dummy_org_01
    _10
    > Dummy_org_02

  5. If the registration is successfull, a message will be displayed:


    _10
    Client correctly licensed
    _10
    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:

  1. Start emory-settings tool by launching the CxLink Backup configuration tool as SAP Database Administrator user.


    _10
    /opt/emory/emory

  2. Select License from Main Menu to initiate the license setup.


    _18
    ? CxLink Backup: [Use arrows to move, enter to select, type to filter]
    _18
    --------------------------------------------------------------------------------
    _18
    Storage Providers profiles
    _18
    Set storage providers for backup/restore, disaster recovery and system copy
    _18
    Backups Lifecycle settings
    _18
    Monitoring
    _18
    --------------------------------------------------------------------------------
    _18
    > License
    _18
    --------------------------------------------------------------------------------
    _18
    Logging file settings
    _18
    Debug traces
    _18
    Show relevant information of this CxLink Backup
    _18
    --------------------------------------------------------------------------------
    _18
    Catalog & Backups management
    _18
    --------------------------------------------------------------------------------
    _18
    Generate troubleshooting package to be sent to Syntax Support
    _18
    --------------------------------------------------------------------------------
    _18
    Exit

  3. Select Generate request file from offline license section:


    _15
    ? CxLink Backup: License
    _15
    ? Select action to perfom: [Use arrows to move, enter to select, type to filter]
    _15
    ------------------------------- ONLINE LICENSE --------------------------------
    _15
    Register license
    _15
    Unregister license
    _15
    ------------------------------- OFFLINE LICENSE --------------------------------
    _15
    > Generate request file
    _15
    Insert license
    _15
    Delete license file
    _15
    --------------------------------------------------------------------------------
    _15
    Reset license (delete license files and recreate client UUID)
    _15
    --------------------------------------------------------------------------------
    _15
    Check Emory license
    _15
    --------------------------------------------------------------------------------
    _15
    Back

    This will generate a request file <SID>.request with the contents that you should copy on the CxLink Portal


    _10
    /opt/emory/conf/LNK.request file generated

  4. Copy the contents of the generated file or move the file to your computer.

  5. Sign in to the Cxlink Backup Service Hub

  6. Navigate to Licenses section and search for a license with an empty host slot.

  7. Select the desired license and click on the Register a host button.

  8. Upload the file or Copy the file contents using the Host Registration pop-up, and click on Register host

  9. Click on Download your license to obtain the license file from the successfull registration window.

  10. Open the file and copy its contents to clipboard.

  11. Back to the CxLink Backup configuration tool, choose Insert license from offline license section:


    _15
    ? CxLink Backup: License
    _15
    ? Select action to perfom: [Use arrows to move, enter to select, type to filter]
    _15
    ------------------------------- ONLINE LICENSE --------------------------------
    _15
    Register license
    _15
    Unregister license
    _15
    ------------------------------- OFFLINE LICENSE --------------------------------
    _15
    Generate request file
    _15
    > Insert license
    _15
    Delete license file
    _15
    --------------------------------------------------------------------------------
    _15
    Reset license (delete license files and recreate client UUID)
    _15
    --------------------------------------------------------------------------------
    _15
    Check Emory license
    _15
    --------------------------------------------------------------------------------
    _15
    Back

  12. Fill license file location and name:


    _10
    ? Select action to perfom: Insert license
    _10
    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:

  1. Start emory-settings tool by launching the CxLink Backup configuration tool as SAP Database Administrator user.


    _10
    /opt/emory/emory

  2. Select License from Main Menu to initiate the license setup.


    _18
    ? CxLink Backup: [Use arrows to move, enter to select, type to filter]
    _18
    --------------------------------------------------------------------------------
    _18
    Storage Providers profiles
    _18
    Set storage providers for backup/restore, disaster recovery and system copy
    _18
    Backups Lifecycle settings
    _18
    Monitoring
    _18
    --------------------------------------------------------------------------------
    _18
    > License
    _18
    --------------------------------------------------------------------------------
    _18
    Logging file settings
    _18
    Debug traces
    _18
    Show relevant information of this CxLink Backup
    _18
    --------------------------------------------------------------------------------
    _18
    Catalog & Backups management
    _18
    --------------------------------------------------------------------------------
    _18
    Generate troubleshooting package to be sent to Syntax Support
    _18
    --------------------------------------------------------------------------------
    _18
    Exit

  3. Select Unregister license from online license section:


    _14
    ? Select action to perfom: [Use arrows to move, enter to select, type to filter]
    _14
    ------------------------------- ONLINE LICENSE --------------------------------
    _14
    Register license
    _14
    > Unregister license
    _14
    ------------------------------- OFFLINE LICENSE --------------------------------
    _14
    Generate request file
    _14
    Insert license
    _14
    Delete license file
    _14
    --------------------------------------------------------------------------------
    _14
    Reset license (delete license files and recreate client UUID)
    _14
    --------------------------------------------------------------------------------
    _14
    Check Emory license
    _14
    --------------------------------------------------------------------------------
    _14
    Back

  4. Authenticate with your CxLink Portal account user (same you use to sign in to the console)


    _10
    ? CxLink Backup: License
    _10
    ? Select action to perfom: Register license
    _10
    License Console User name: cxlink.user@syntax.com
    _10
    License Console Password: ********

  5. If the de-registration is correct, a succesfull message will be displayed.


    _10
    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:

  1. Start emory-settings tool by launching the CxLink Backup configuration tool as SAP Database Administrator user.


    _10
    /opt/emory/emory

  2. Select License from Main Menu to initiate the license setup.


    _18
    ? CxLink Backup: [Use arrows to move, enter to select, type to filter]
    _18
    --------------------------------------------------------------------------------
    _18
    Storage Providers profiles
    _18
    Set storage providers for backup/restore, disaster recovery and system copy
    _18
    Backups Lifecycle settings
    _18
    Monitoring
    _18
    --------------------------------------------------------------------------------
    _18
    > License
    _18
    --------------------------------------------------------------------------------
    _18
    Logging file settings
    _18
    Debug traces
    _18
    Show relevant information of this CxLink Backup
    _18
    --------------------------------------------------------------------------------
    _18
    Catalog & Backups management
    _18
    --------------------------------------------------------------------------------
    _18
    Generate troubleshooting package to be sent to Syntax Support
    _18
    --------------------------------------------------------------------------------
    _18
    Exit

  3. Select Delete license file from offline license section:


    _14
    ? Select action to perfom: [Use arrows to move, enter to select, type to filter]
    _14
    ------------------------------- ONLINE LICENSE --------------------------------
    _14
    Register license
    _14
    Unregister license
    _14
    ------------------------------- OFFLINE LICENSE --------------------------------
    _14
    Generate request file
    _14
    Insert license
    _14
    > Delete license file
    _14
    --------------------------------------------------------------------------------
    _14
    Reset license (delete license files and recreate client UUID)
    _14
    --------------------------------------------------------------------------------
    _14
    Check Emory license
    _14
    --------------------------------------------------------------------------------
    _14
    Back

  4. If the de-registration is correct, a succesfull message will be displayed.


    _10
    License information has been deleted from the agent.

  5. Sign in to the Cxlink Backup Service Hub

  6. 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.

  1. From the Hosts section, select the host you want to unregister and click on the Unregister host button. Host Unregistration

View License Details

You can find the license information from both command line or 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:

  1. Sign in to the Cxlink Backup Service Hub

  2. 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.

    License Details

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:


_10
/opt/emory/conf/<SID>.id

The file contains the following information:

KeyDescriptionExample value
ClientIDCxLink Backup Agent Unique identifieraca0d5ab-7768-4782-a463-9b76593dd3a0
LicenseLicense Identifier associated with the CxLink Backup agent580637de-8580-49a8-967c-53fe4925db9d
CustomerKeyUnique identifier of the Organization where the license belongsrOxebnSkCu8CzCZU6ZD4l8Gc2Ygh7ZdG30tth8xJ
expiresonExpiration date for the installed license2020-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. Host License Recovery
  • Save the resulting download file to your computer.