Installing a license key

Overview

How to install a license key on a Swivel Secure 3.x (PINsafe) or 4.x (Sentry) system. The procedure has changed from version 3.11 onwards.

See also License Key Update

Prerequisites

• Swivel 3.x Administration console login with admin rights
• Valid license key

Symptoms

• Error Message: Swivel license contains an error

• Status page does not show a license name or required number of users

• Only a limited number of users are imported into Swivel (Swivel has a default 5 user evaluation license of unlimited duration)

• License upgrade required

• Swivel license installation

Solution

1. Access the Swivel Administration Console via a web browser. The default address for this is:

Virtual or hardware appliance Installation: https://IP:8080/pinsafe

Software Installation: http://IP:8080/pinsafe

The default login details for a newly shipped appliances are:

• Username: admin
• PIN: 1234

See How to initially configure PINsafe to set the database or changes may not be saved.

2. To login, you will need to enter the username and extract the PIN from the TURing image that appears and enter it into the One Time Code field;

3. Once you've logged into the Swivel Administration Console, click 'Server', 'License' from the left hand menu;

4. Copy and paste the license key into the 'License key' field and click 'Apply';

5. Check the status page, by clicking 'Status' on the left hand menu. The 'Swivel License Name' should be present along with the number of 'Licensed Users';

6. Check the logs for any errors.

7. Repeat for each Swivel instance as required.

Troubleshooting

• Paste the license key into a text editor and view, to ensure that it is complete and that there are no carriage returns. This has been seen when pasting the license key directly from a PDF document.

• A successfully added license will show a log message of: Swivel license valid, and in the status page the registered name and number of users will appear.

• Verify that the license is a valid Swivel 3.x license that has not expired.

• Ensure that the license is valid for the version of Swivel. A 2.x license will not work on a 3.x version of Swivel. A 3.x license will not work on a 2.x version of Swivel.

Error Messages

Pinsafe license contains an error.

The license is invalid or has not been correctly entered.

ERROR - The number of users in the Pinsafe users group has exceeded the license

exceeded licensed users

The number of licensed users has been exceeded. Note that this message will be displayed even if a new larger license is installed until Tomcat is restarted. Consider purchasing a larger license or freeing up some users such as Inactive users, see Delete a Swivel user.