Skip to main content

How To: Backup and restore a CODESYS license

Important

These instructions do not apply to products from the CODESYS Virtual Control SL product family.

Backup and restore of CODESYS licenses vary depending on the product. Select the appropriate instructions according to the following classification:

CodeMeter Embedded

CodeMeter Runtime

  • CODESYS Control for BeagleBone

  • CODESYS Control for emPC-A/iMX6

  • CODESYS Control for IOT2000

  • CODESYS Control for PFC100

  • CODESYS Control for PFC200

  • CODESYS Control for PLCnext

  • CODESYS Control for Raspberry Pi

  • CODESYS Control for WAGO Touch Panel 600

  • CODESYS Control​ for Linux

  • CODESYS Control for Linux ARM

  • CODESYS Control for Linux ARM64

  • CODESYS Control Win SL

  • CODESYS Control RTE SL

Codemeter Embedded

Backing up the license

  1. Establish a connection from CODESYS to your controller.

  2. In the device tree, select your controller and open the Files tab.

  3. In the window on the right side, click the refresh symbol (_cds_img_button_update.png).

    _license_img_howto_restore_1.png

    The files available on your controller will be displayed.

  4. In the window on the left side, select the directory where you want to store the backup.

  5. In the window on the right side, select the cmact_licenses directory and click the _cds_button_double_arrow_left.png button.

    _license_img_howto_restore_2.png

    A backup copy of your licensing directory will be created on your computer.

  6. Check that the backup copy has been created successfully.

Restoring the license

Important

Note that data loss is possible when performing the following instructions in Step 6. Therefore, read these instructions carefully.

  1. Establish a connection from CODESYS to your controller.

  2. In the device tree, select your controller and open the Files tab.

  3. In the window on the right side, click the refresh symbol (_cds_img_button_update.png).

    The files available on your controller are displayed.

  4. In the window on the right side, select the target directory. This has to be the top-level directory (storage location: /)

  5. In the window on the left side, select the previously created backup copy on your computer and click the _cds_button_double_arrow_right.png button.

    _license_img_howto_restore_3.png

    The backup copy will be copied to your controller.

  6. If a directory with the same name already exists, then you will be prompted to overwrite any files it contains.

    Warning

    Caution: When you select Yes, all files with the same name as in the backup directory will be removed from the existing directory. The same name does not necessarily mean that the contents are identical. Therefore, make sure that you do not accidentally overwrite files that you need.

  7. Restart your controller after the backup copy has been successfully transferred.

Codemeter Runtime

Difference between container types

The container name identifies whether it is a UFC or an EWF container:

Name

Container Type

CODESYS GmbH UFC CmRuntine

UFC container

CODESYS-Control SL-V1

EWF container

Tip

When using UFC containers with CodeMeter Runtime, it is not necessary to create a backup.

Copy the folder specified in /etc/wibu/CodeMeter/Server.ini > CmActPath to a backup medium.

Procedure. Creating a license request file
  1. In CODESYS, open the License Manager.

  2. In the Select Target dialog, select Device as the target and click Next.

  3. In the Select Container dialog, select SoftContainer and click Next.

  4. Establish a connection from CODESYS to the controller where you want to restore the license.

  5. Click Install Licenses, select Request License, and click Next.

  6. If the Software vendor field is empty, then you can use the firm code. How to retrieve the firm code is described in the section Retrieving the firm code.

  7. Select the container where the license should be installed and select the location where the license request file should be saved on your computer. Click Finish.

Procedure. Downloading the license update file
  1. Open the License Central WebDepot and specify the ticket ID which you want to restore. Click Next.

  2. Click Restore Licenses.

  3. On the bottom right side, click File-based license transfer. If Direct license transfer is on the page, then you are already on the correct page.

    _license_img_howto_restore_4.png
  4. Upload the previously created license request file and click Upload request and continue now.

  5. Click Download license update file now and save the file to your computer.

Procedure. Installing the license update
  1. In CODESYS, open the License Manager.

  2. In the Select Target dialog, select Device as the target and click Next.

  3. In the Select Container dialog, select SoftContainer and click Next.

  4. Establish a connection from CODESYS to the controller where you want to restore the license.

  5. Click Install Licenses, select Install License, and click Next.

  6. Select the container where you want to install the license and select the previously downloaded update file (extension: .WibuCmRaU).

  7. Click Finish.

  8. After a few seconds, the license will appear in the License Manager.

Procedure. Retrieving the firm code
  1. Open the License Central WebDepot and specify the ticket ID which you want to restore. Click Next.

  2. Click Restore Licenses.

  3. On the bottom right side, click File-based license transfer.

    _license_img_howto_restore_4.png
  4. Copy the firm code as provided in Step 1.

    _license_img_howto_restore_5.png

Requirement: You have already changed to EWF containers as described in Switching between container types.

  1. Stop the licensing service: systemctl stop codemeter.

  2. Copy the previously backed-up folder to the path specified in /etc/wibu/CodeMeter/Server.ini > CmActPath.

  3. Set the ownership of the folder specified in CmActPath to daemon:daemon.

  4. Start the licensing service: systemctl start codemeter.