Testing the licensing server

This task is part of the end-to-end process for setting up the Unity Licensing Server.

After you've downloaded and imported the license archive file, test the licensing server by retrieving either of the following levels of feedback:

• Basic: Status, time since last started, and server version.
• Extended: Basic information, plus machine bindings, license configuration, and database information.

To test the server:

1. From a PowerShell or Terminal window, navigate to the Unity Licensing Server launch directory and run the following command:

   • Linux: ./Unity.Licensing.Server
   • Windows: .\Unity.Licensing.Server.exe

2. Access one of the following two server endpoints:

   • For Basic: http://<SERVER-IP-ADDRESS>:<PORT>/v1/status

   • For Extended: http://SERVER-IP-ADDRESS:PORT/v1/admin/status

     Note

     To access the Extended admin/status endpoint, you must configure administrator access for your licensing server. See the “Configure administrator access” step in the section, Running the setup command.

The server is functioning properly when the serverStatus information appears as Healthy.

Support for multiple product licenses

You can configure the server with licenses for multiple different products. A license file with a specific set of entitlements represents each product. All files are available as an archive, which you can import by using the import command.

If multiple product licenses are available on the server, you can set one license as the default and optionally configure client computers to use specific licenses. You can configure a client to request specific licenses by using the toolset client configuration key. For details, see Copying the configuration file in Client setup.

If the client isn't configured to request a specific product license, the server provides a default license. If the client is configured to request a specific product license, the server provides it, as long as a license is available.

Basic test report

Go to http://<SERVER-IP-ADDRESS>:<PORT>/v1/status to see basic information about the server, including:

Entry:	Description:
serverStatus	Whether the configuration of the server is correct and ready to serve licenses
serverUpTime	The amount of the time since the last server startup and the current date time
serverUpTimeMs	The amount of the time in milliseconds since the last server startup and the current date time
version	The version of the licensing server

For example, the output looks similar to this:

{
"serverStatus": "Unhealthy",
"serverUpTime": "0 days 1 hours 41 minutes 3 seconds",
"serverUpTimeMs": 6063668,
"version": "1.7.0.7cc2de3"
}

Extended test report

Go to http://SERVER-IP-ADDRESS:PORT/v1/admin/status to see the basic report and additional information about the server, including machine bindings, license configuration, and database information.

The output looks similar to this:

{
 "serverContext": {
    "data": {
          "FirstPhysicalAddress":  "48:2a:e3:87:3b:19",
          "Platform": "Win32NT",
          "ProcessorCount": "12",
          "MachineName": "LAPTOP-2Q28U8QR"
    },
    "status": "Healthy",
    "statusMessage": "Found 4 out of 4 context values"
},   
"serverLicenses": {
 "data": [
     {
       "fileName": "C:\\Users\\user.name\\AppData\\Local\\Unity\\licenses\\test-licenseServer_3573567292644_1-20200925_145658.xml",
       "status": "Ok",
       "message": "EntitlementGroup: test-licenseServer_3573567292644_1 (from: test-licenseServer_3573567292644_1-20200925_145658.xml) has valid server entitlements",
       "licenseEntitlementGroupId": "test-licenseServer_3573567292644_1",
       "product": "Unity Enterprise for Product Lifecycle(Floating)",
       "licenseCount": 10,
       "validFrom": "2020-09-25T14:52:32.061Z",
       "validTo": "2022-09-24T00:00:00Z"
     }
 ],
 "status": "Healthy",
 "statusMessage": "Found 1 valid server license(s)"
},
"licenseSigningCertificateStatus": {
 "status": "Healthy",
 "statusMessage": "Successfully loaded license signing key"
},
"serverDelegations": {
 "data": [
     {
        "fileName": "test-licenseServer-delegation-20200925_145658.xml",
        "status": "Ok",
        "message": "Found valid server delegation: C:\\Users\\user.name\\AppData\\Local\\Unity\\licenses\\delegations\\test-licenseServer-delegation-20200925_145658.xml",
        "delegationId": "Delegation_test-licenseServer",
        "organizationId": "3573567206524",
        "serverId": "test-licenseServer",
        "delegationStart": "2020-09-25T14:52:32.061Z",
        "delegationEnd": "2022-09-24T00:00:00Z"
      }
  ],
  "status": "Healthy",
  "statusMessage": "Found 1 valid server delegations"
},
"databaseStatus": {
 "data": {
    "connectionStatus": 1,
    "connectionType": "Microsoft.Data.Sqlite.SqliteConnection"
  },
  "status": "Healthy",
  "statusMessage": "Connection state for Microsoft.Data.Sqlite.SqliteConnection is Open"
},
"plugins": {
 "data": [],
 "status": "Healthy",
 "statusMessage": "Plugins"
},
"serverStatus": "Healthy",
"serverUpTime": "0 days 0 hours 41 minutes 36 seconds",
"serverUpTimeMs": 2496435,
"version": "1.7.0.7cc2de3"
}

Next steps

Proceed to setting up a service to continue setting up your licensing server.