Table of Contents

exclude	Contents
style	square

Sentinel/Gemalto

...

Tools not Applicable to the VE License Server

Any Sentinel/Gemalto-specific license tools provided with the emulator installation are not applicable to the VE license server configuration.

Sentinel/Gemalto-specific tools and configuration options on in Charon -SSPemulator kits:

In Charon -SSPemulator kits, the Sentinel/Gemalto-specific license tools and configuration options are available when installing the management packages for the VE-capable Charon-SSP complete emulator packages. These tools and options are in particular the following:

Starting and Stopping the License Server

Please note: In versions before 1.0.17, the license server can only be started if a valid license is installed.

The license server is a systemd service that is controlled via systemctl:

Starting the license server: # systemctl start licensed
Stopping the license server: # systemctl stop licensed
Restarting the license server: # systemctl restart licensed

The licensed service logs information to its log file in /opt/license-server/log/license.log and to journalctl.

Primary and Backup License Server / Peer Servers

General Information

Charon emulators for VE licenses support a backup license server to ensure service continuity should the primary license server become temporarily unavailable. The primary/backup servers in general VE license mode operate differently from the peer servers of AutoVE mode:

For general VE license mode, backup licenses are typically limited to a certain number of emulator runtime hours. The backup license server is only used for failover if the primary license server fails in order not to deplete the available runtime hours unnecessarily.
For AutoVE mode, the two license servers act as peers between which the client database is synchronized. The total number of instances available on both servers determines the number of Charon host cloud instances that can be licensed from the license server pair. Each instance can connect to either of the two servers. However, if one of the peers fails and there are not enough available instances on the second peer, there is no backup for an instance trying to fail over to the second peer due to failure of its primary server - and the emulators running on this instance will fail.

The example below shows the output of a time-limited license:

Code Block

language	text

# /opt/license-server/license_viewer 
<<License Viewer>> Current license:
License fingerprint: 07792211fc8ce3fdc085 <truncated>
Customer name: Stromasys
License ID: 01.00000001.002.020
Key type: COUNTDOWN
Expiration date: 100 hour(s)
Platform: amazon.aws
Release date: 2021-06-17 13:08:01
Grace period: 120 minutes
License check interval: 60 minutes

Virtual Hardware: Charon-SSP/4M,Charon-SSP/4U
Product code: Charon-SSP/ALL
Expiration date: 2021-12-22 23:55:00
Major Version: 5
Minor Version: 3
Maximum CPU: 64
Maximum virtual memory: 1048576MB
Instances allowed: 3

The above sample is a backup license with 100 hours of emulator runtime. The remaining hours can be checked via the web interface.

Backup License Server Operation

Should the primary license server become unavailable, the emulator tries to connect to the backup license server. If this succeeds, the emulator continues to run without interruption. If no connection to a valid license can be established within 2 hours (default for general VE license mode) or 24 hours (default for AutoVE mode), after the loss of the license has been detected, the emulator will stop. The grace period is defined on the license.

Please note: If you do not have a valid backup license and the primary license server is unavailable for more than the grace period, make sure to shut down the guest operating system cleanly before the end of the grace period. Failure to do so may cause data loss or corruption.

If the primary license server becomes available again after the emulator has switched to the backup server, the emulator will automatically switch back to the primary server to avoid unnecessary depletion of the backup license runtime hours in VE license server mode.

...

class	pagebreak

Log Files

Log files provide important information about the operation of the license server and the Charon emulator software. In case of problems, this is the first place to check.

License Server Log File

Log File Location

License server log file /opt/license-server/log/license.log

At every license server start, a new version of the log file is created and the previous file is rotated to license.log.1. Other existing versions are rotated accordingly.

Log File Samples

Normal startup:

Code Block

language	text

2020-01-16 09:00:43 INFO    MAIN     Build time: Jan 16 2020 10:54:15
2020-01-16 09:00:44 INFO    MAIN     License server is ready to serve.

...

Charon-SSP:
- HASP Viewer, HASP Updater, and HASP Manager in the Tools > HASP Tools menu of the Charon Manager
- The Regular and Backup License parameter in the emulator license configuration section
- The command-line tools in /opt/charon-agent/ssp-agent/utils/license

The above tools cannot be used for managing Charon-SSP VE licenses. Please ignore them if you have a VE license.

Actions that can Invalidate a VE License

Excerpt

For cloud deployments: if supported by the cloud provider, the VE license server instance can be moved to a different subnet, as long as the original instance can be moved.

It is also possible to backup and restore (to the same instance) the license server data.

However, the following actions will invalidate the license:

All supported environments:
- Copying the license server data to a different instance
- Seriously damaging the root filesystem of the license server system
- Re-installing the license server system
- Copying the virtual machine on which the license server runs
- Changing the number of CPU cores of the license server system.
VMware environments:
- If the license server is bound to the ESXi host: using vMotion on the VM in which the VE license server runs
- Changes to the API interface of the ESXi host or vCenter Server
- The license can become temporarily unavailable if the user credentials or address information recorded by esxi_bind are changed. In this case, esxi_bind must be run again to define the correct user credentials and address information.
AutoVE deployments:
- Charon emulator host instance register with their license server only once at start. This is recorded on the license server in /opt/license-server/instances.db. If this file is lost, the license is not invalidated from the license server's view, but it can no longer be used from the Charon host instances as they will not register a second time. The Charon host instances would have to be recreated (fresh instance launch from a supported marketplace instance). Therefore, it is very important to backup up the instance database file.

...

class	pagebreak

Charon-PAR:
- The command-line tools in /opt/charon/bin (including the update tool hasp_update, and the license viewer and C2V creation tool hasp_srm_view)
- The license_id configuration parameter is not supported. To choose a specific product section, the passphrase of the section is used.

The above tools and commands cannot be used for managing VE licenses. Please ignore them if you have a VE license.

Div

class	pagebreak

Actions that Can Invalidate a VE License

Insert excerpt

	PDC:__Include: Installing a License on the VE License Server
	PDC:__Include: Installing a License on the VE License Server
name	VELicInvalidationCaveat
nopanel	true

Div

class	pagebreak

Starting and Stopping the License Server

Please note: In versions before 1.0.17, the license server can only be started if a valid license is installed.

The license server is a systemd service that is controlled via systemctl:

Starting the license server: # systemctl start licensed
Stopping the license server: # systemctl stop licensed
Restarting the license server: # systemctl restart licensed

The licensed service logs information to its log file in /opt/license-server/log/license.log and to journalctl.

Primary and Backup License Server / Peer Servers

General Information

Charon emulators for VE licenses support a backup license server to ensure service continuity should the primary license server become temporarily unavailable. The primary/backup servers in general VE license mode operate differently from the peer servers of AutoVE mode:

For general VE license mode, backup licenses are typically limited to a certain number of emulator runtime hours. The backup license server is only used for failover if the primary license server fails in order not to deplete the available runtime hours unnecessarily.
For AutoVE mode, the two license servers act as peers between which the client database is synchronized. The total number of instances available on both servers determines the number of Charon host cloud instances that can be licensed from the license server pair. Each instance can connect to either of the two servers. However, if one of the peers fails and there are not enough available instances on the second peer, there is no backup for an instance trying to fail over to the second peer due to failure of its primary server - and the emulators running on this instance will fail. The license on the server designated as backup server can be a countdown license (specified number of runtime hours) or a normal license.

The example below shows the output of a time-limited license:

Code Block

language	text

# /opt/license-server/license_viewer 
<<License Viewer>> Current license:
License fingerprint: 07792211fc8ce3fdc085 <truncated>
Customer name: Stromasys
License ID: 01.00000001.002.020
Key type: COUNTDOWN
Expiration date: 100 hour(s)
Platform: amazon.aws
Release date: 2021-06-17 13:08:01
Grace period: 120 minutes
License check interval: 60 minutes

Virtual Hardware: Charon-SSP/4M,Charon-SSP/4U
Product code: Charon-SSP/ALL
Expiration date: 2021-12-22 23:55:00
Major Version: 5
Minor Version: 3
Maximum CPU: 64
Maximum virtual memory: 1048576MB
Instances allowed: 3

The above sample is a backup license with 100 hours of emulator runtime. The remaining hours can be checked via the web interface.

Backup License Server Operation

Should the primary license server become unavailable, the emulator tries to connect to the backup license server. If this succeeds, the emulator continues to run without interruption. If no connection to a valid license can be established within the grace period, after the loss of the license has been detected, the emulator will stop. The grace period is defined on the license. Check the license content for the actual value configured (default for new licenses is 24 hours, but the actual configuration may be different).

Please note: If you do not have a valid backup license and the primary license server is unavailable for more than the grace period, make sure to shut down the guest operating system cleanly before the end of the grace period. Failure to do so may cause data loss or corruption.

If the primary license server becomes available again after the emulator has switched to the backup server, the emulator will automatically switch back to the primary server to avoid unnecessary depletion of the backup license runtime hours in VE license server mode.

Log Files

Log files provide important information about the operation of the license server and the Charon emulator software. In case of problems, this is the first place to check.

License Server Log File

Log File Location

License server log file /opt/license-server/log/license.log

At every license server start, a new version of the log file is created and the previous file is rotated to license.log.1. Other existing versions are rotated accordingly.

Log File Samples

Normal startup:

Code Block

language	text

2020-01-16 09:00:43 INFO    MAIN     Build time: Jan 16 2020 10:54:15
2020-01-16 09:00:44 INFO    MAIN     License server is ready to serve.

No valid license installed:

Code Block

language	text

2020-01-10 12:17:19 INFO    MAIN     Build time: Jan 10 2020 17:22:12
2020-01-10 12:17:19 ERROR   License  license is not available.
2020-01-10 12:17:19 INFO    MAIN     The program is terminated.

Client connection log (new in 1.0.28):

Code Block

language	text

2020-10-02 21:46:29 INFO    MAIN     License server is ready to serve.
2020-10-03 01:31:09 INFO    Server   CHARON-SSP/4U v4.1.32 has logged in from 127.0.0.1:40704.
2020-10-03 01:45:21 INFO    Server   CHARON-SSP/4U v4.1.32 from 127.0.0.1:40704 has been disconnected

Div

class	pagebreak

Charon-SSP Emulator Log Files

Log File Location

The default emulator log file location is /opt/charon-agent/ssp-agent/ssp/<architecture/<vm-name>/.

<architecture> can be sun-4m, sun-4u, or sun-4v.
<vm-name> is the name of the emulated SPARC system.

The log file is called <vm-name>.log. At every emulator start, a new version of the log file is created and the previous file is rotated to <vm-name>.log.1. Other existing versions are rotated accordingly. The number of retained files is determined by the log configuration of the emulated SPARC system.

Please note: The log file path can be changed by the user to a non-default value.

Log File Samples

Working license found during emulator start:

Code Block

language	text

2020-0107-1016 1221:1725:1910 INFO  VE  MAIN     BuildTrying time:to Janlogin 10to 2020license 17:22:12server: 127.0.0.1
2020-0107-1016 1221:17:19 ERROR25:13 INFO  VE       LicenseConnected with license is not available.server: 127.0.0.1
2020-0107-1016 1221:1725:1913 INFO  VE   MAIN    Found Theavailable programlicense is terminated.

Client connection log (new in 1.0.28):

Code Block

language	text

2020-10-02 21:46:29ID: 01.00000001.002.044.
2020-07-16 21:25:13 INFO  VE  MAIN     LicenseCustomer server is ready to servename: Stromasys/Testing.
2020-1007-0316 0121:3125:0913 INFO  VE   Server   CHARON-SSP/4U v4.1.32 has logged in from 127.0.0.1:40704 Virtual hardware model Charon-SSP/4M is licensed.
2020-1007-0316 0121:4525:2113 INFO  VE  Server   CHARON-SSP/4U v4.1.32 from 127.0.0.1:40704 has been disconnected

Div

class	pagebreak

Charon-SSP Emulator Log Files

Log File Location

The default emulator log file location is /opt/charon-agent/ssp-agent/ssp/<architecture/<vm-name>/.

<architecture> can be sun-4m, sun-4u, or sun-4v.
<vm-name> is the name of the emulated SPARC system.

The log file is called <vm-name>.log. At every emulator start, a new version of the log file is created and the previous file is rotated to <vm-name>.log.1. Other existing versions are rotated accordingly. The number of retained files is determined by the log configuration of the emulated SPARC system.

Please note: The log file path can be changed by the user to a non-default value.

Log File Samples

Working license found during emulator start:

Code Block

language	text

Maximum concurrent instances are limited to 4.
2020-07-16 21:25:13 INFO  VE       Maximum allowed virtual CPU(s) are 4.
2020-07-16 21:25:13 INFO  VE       Maximum allowed virtualized memory is 512 MB.
2020-07-16 21:25:13 INFO  VE       Major allowed version number is 4.
2020-07-16 21:25:1013 INFO  VE       TryingMinor toallowed loginversion to license server: 127.0.0.1number is 2.
2020-07-16 21:25:13 INFO  VE       Expiration UTC Connected with license server: 127.0.0.1time: 2020-12-31 15:55:00.

Connection to license server lost temporarily and then restored:

Code Block

language	text

(License loss detected)

2020-07-16 2122:25:1356 ERROR VE INFO  VE    Failed to connect Foundwith availablethe license ID: 01.00000001.002.044.server!
2020-07-16 2122:25:1356 INFOWARN  VE       Customer name: Stromasys/Testing.Charon will be terminated within 2 hours!

(License server connection restored)

2020-07-16 2123:2526:1301 INFO  VE       VirtualConnected hardwarewith model Charon-SSP/4M is licensed.license server: 127.0.0.1
2020-07-16 2123:2526:1301 INFO  VE       MaximumFound concurrentavailable instanceslicense are limited to 4ID: 01.00000001.002.044.
2020-07-16 2123:2526:1301 INFO  VE       Maximum allowed virtual CPU(s) are 4Customer name: Stromasys/Testing.
2020-07-16 2123:2526:1301 INFO  VE       MaximumVirtual allowedhardware virtualized memorymodel Charon-SSP/4M is 512 MBlicensed.
2020-07-16 2123:2526:1301 INFO  VE       Maximum Majorconcurrent allowedinstances versionare numberlimited isto 4.
2020-07-16 2123:2526:1301 INFO  VE       MinorMaximum allowed version number is 2virtual CPU(s) are 4.
2020-07-16 2123:2526:1301 INFO  VE       ExpirationMaximum UTCallowed time: 2020-12-31 15:55:00.

Connection to license server lost temporarily and then restored:

Code Block

language	text

(License loss detected)
virtualized memory is 512 MB.
2020-07-16 2223:2526:5601 INFO ERROR VE       FailedMajor toallowed connectversion withnumber the license server!is 4.
2020-07-16 2223:2526:5601 WARNINFO  VE       Minor allowed version number is  Charon will be terminated within 2 hours!

(License server connection restored)
2.
2020-07-16 23:26:01 INFO  VE       Expiration UTC time: 2020-12-31 15:55:00.
2020-07-16 23:26:01 INFO  VE       Local ConnectedUTC with license server: 127.0.0.1time: 2020-07-16 15:26:01.
2020-07-16 23:26:01 INFO01 INFO  VE       VEThe license is verified, back to  Found available license ID: 01.00000001.002.044.
2020-07-16 23:26:01 INFO  VE       Customer name: Stromasys/Testing.
2020-07-16 23:26:01 INFO normal operation.

Please note: The output shows a 2 hour grace period. The grace period implementation and defaults changed several times. Since VE version 1.1.12, the grace period is determined by the corresponding license parameter (please check the license content for the value configured on your license). If a valid license has not become available before the end of the grace period, the emulator will be stopped.

Div

class	pagebreak

Switch to backup license server:

Code Block

language	text

2020-06-29 18:08:25 ERROR VE     Failed to Virtualconnect hardwarewith model Charon-SSP/4M is licensed.
2020-07-16 23:26:01the license server!
2020-06-29 18:08:25 INFO  VE     Trying to Maximumlogin concurrentto instanceslicense are limited to 4.server: 127.0.0.1
2020-0706-1629 2318:2608:0134 INFO ERROR VE     Failed to Maximumconnect allowedwith virtual CPU(s) are 4.the license server!
2020-0706-1629 2318:2608:0143 INFOWARN  VE     Charon will Maximumbe allowedterminated virtualizedwithin memory is 512 MB.2 hours!
2020-0706-1629 2319:2608:0157 INFO  VE     Connected with Majorlicense allowed version number is 4.server: 172.31.40.62
2020-0706-1629 2319:2608:0157 INFO  VE     Found available license Minor allowed version number is 2.
2020-07-16 23:26:01 INFOID: 01.00000001.002.045.

License Server version mismatch:

The software checks for compatible protocol versions between license server and emulator software. It logs an error if the versions are not compatible.

The following messages may logged in older versions:

Code Block

language	text

2020-01-16 11:24:38 WARN  VE  Failed to get data from Expiration UTC time: 2020-12-31 15:55:00.
2020-07-16 23:26:01 INFO  VElicense server!

Code Block

language	text

2021-08-10 17:03:42 FATAL VE       License Localserver UTC time: 2020-07-16 15:26:01.
2020-07-16 23:26:01 INFO  VEis unavailable!

Newer versions have a more descriptive error message:

Code Block

language	text

2021-08-10 17:16:41 ERROR VE       License Theprotocol licenseversion is verified, back to normal operation.

Please note: The output shows a 2 hour grace period. The grace period implementation changed several times. In VE versions before version 4.1.21, the grace period was 24 hours. It was shortened to two hours after the introduction of the backup license server feature in 4.1.19. Since version 1.1.12, the grace period is determined by the corresponding license parameter. If a valid license has not become available before the end of the grace period, the emulator will be stopped.

...

class	pagebreak

...

invalid.

Charon-PAR Emulator Log Files

The default location for the Charon-PAR emulator log files is the directory in which the emulator was started. The name and location can be influenced via the configuration file and using a start-up parameter.

By default log file name is charon-par.<YYMMDD>-<timestamp>-<incremental number>.log.

The link charon-par.log points to the current log file.

Log File Samples

Working license found during emulator start:

Code Block

language	text

2020-06-29 18:08:25 ERROR VE     Failed to connect with the license server!
2020-06-29 18:08:25 INFO  VE     Trying to login to20211213:120216.970965:Trying to login to license server: 127.0.0.1
20211213:120219.975731:License allowed CPUs: 8.
20211213:120219.975746:License allowed memory size: 32768.
20211213:120219.979873:Connected with license server: 127.0.0.1
2020-06-29 18:08:34 ERROR VE     Failed to connect with the license server!
2020-06-29 18:08:43 WARN  VE     Charon will be terminated within 2 hours!
2020-06-29 19:08:57 INFO  VE     Connected with license server: 172.31.40.62
2020-06-29 19:08:57 INFO  VE     Found available license ID: 01.00000001.002.045.

License Server version mismatch:

The software checks for compatible protocol versions between license server and emulator software. It logs an error if the versions are not compatible.

The following messages may logged in older versions:

Code Block

language	text

2020-01-16 11:24:38 WARN  VE  Failed to get data from license server!

Code Block

language	text

2021-08-10 17:03:42 FATAL VE       License server is unavailable!

Newer versions have a more descriptive error message:

Code Block

language	text

2021-08-10 17:16:41 ERROR VE       License protocol version is invalid20211213:120219.979900:Found available license ID: 03.00000003.002.006.
20211213:120219.979908:Customer name: Stromasys
20211213:120219.979915:Grace period is 120 minutes.
20211213:120219.979928:Virtual hardware model Charon-PA9-64-L4 is licensed.
20211213:120219.979937:Maximum concurrent instances are limited to 10.
20211213:120219.979950:Maximum allowed virtual CPU(s) are 8.
20211213:120219.979959:Maximum allowed virtualized memory is 32768 MB.
20211213:120219.979967:Major allowed version number is 3.
20211213:120219.979976:Minor allowed version number is 0.
20211213:120219.979988:Expiration UTC time: 2022-06-08 23:55:00.
20211213:120219.980216:Product Name = Charon-PA9-64-L4 License key ID = 03.00000003.002.006.

Div

class	pagebreak

License server not found at start:

Code Block

language	text

20211214:193342.307175:VE primary license 192.168.2.2
20211214:193342.307701:There is no VE backup server.
20211214:193342.334171:Trying to login to license server: 192.168.2.2
20211214:193351.337196:warn:Unable to login to server because the license server failed to respond
20211214:193351.337392:err:Failed to connect with the license server.
20211214:193351.337457:err:Failed to connect with the license server.
20211214:193351.337509:err:Exit
20211214:193351.339823:err:Invalid license product name

Charon-AXP/VAX Emulator Log Files

The default location for the Charon-AXP/VAX emulator log files on Linux (Linux is required for VE licensing): if the setting of the template configuration is used, the default is the directory from which the emulator instance was started.

The name and location can be influenced via the configuration file.

By default log file name is <model-name>.log.

Management GUI Web Server Log File

...

Log file location: /opt/license-server/errorlog/webserver.log

Sample content:

Code Block

language	text

$ cat /opt/license-server/errorlog/webserver.log

<attempt to start the license server a second time>
[1636549131] [error] [client ] cannot bind to 80: 98 (Address already in use)
[1636549131] [error] [client ] cannot bind to 8084s: 98 (Address already in use)
[1636549131] [error] [client ] Failed to setup server ports

<restart of the license server>
[1636551531] [error] [client 192.168.2.80] SSL syscall error 104
[1636551532] [error] [client 192.168.2.80] SSL syscall error 104

...

Versions Compared

Old Version 60

New Version Current

Key

Sentinel/Gemalto

Tools not Applicable to the VE License Server

Starting and Stopping the License Server

Primary and Backup License Server / Peer Servers

General Information

Backup License Server Operation

Log Files

License Server Log File

Log File Location

Log File Samples

Actions that can Invalidate a VE License

Actions that Can Invalidate a VE License

Starting and Stopping the License Server

Primary and Backup License Server / Peer Servers

General Information

Backup License Server Operation

Log Files

License Server Log File

Log File Location

Log File Samples

Charon-SSP Emulator Log Files

Log File Location

Log File Samples

Charon-SSP Emulator Log Files

Log File Location

Log File Samples

Charon-PAR Emulator Log Files

Log File Samples

Charon-AXP/VAX Emulator Log Files

Management GUI Web Server Log File

Page Comparison

Versions Compared

Old Version 60

New Version Current

Key

Sentinel/Gemalto

Tools not Applicable to the VE License Server

Starting and Stopping the License Server

Primary and Backup License Server / Peer Servers

General Information

Backup License Server Operation

Log Files

License Server Log File

Log File Location

Log File Samples

Actions that can Invalidate a VE License

Actions that Can Invalidate a VE License

Starting and Stopping the License Server

Primary and Backup License Server / Peer Servers

General Information

Backup License Server Operation

Log Files

License Server Log File

Log File Location

Log File Samples

Charon-SSP Emulator Log Files

Log File Location

Log File Samples

Charon-SSP Emulator Log Files

Log File Location

Log File Samples

Charon-PAR Emulator Log Files

Log File Samples

Charon-AXP/VAX Emulator Log Files

Management GUI Web Server Log File