Licensing Configuration

Learn how to update the license server used by Nuix RESTful Services..

Updating NMS Connections

After installing Nuix RESTful Service, you may need to eventually update the URL or credentials of the Nuix Management Server (NMS) being used for licensing. If this occurs, use the details within this section to update your NMS connection information.

Use the following procedure to update the NMS connection used by Nuix RESTful Service:

  1. Close the application or stop the service to ensure that Nuix RESTful Service is not running.
  2. Navigate to the settings directory within the Nuix RESTful Service installation directory. Default path: <InstalDir>/Nuix/Nuix RESTful Service/settings
  3. Locate and open the application.properties file within a text editor.
  4. Within the file, locate and update the following property with the URL of the new NMS instance, including port number.
    nuix.registry.servers=<ServerURL>
    
  5. Save and exit the file.
  6. Restart Nuix RESTful Service.
  7. If the credentials to access the NMS instance have changed, continue with the following procedure.

Use the following procedure to update the credentials associated with the specified NMS connection:

  1. With Nuix RESTful Service running, log in and acquire a license.

  2. Using the acquired authentication token, call the licenseServer/credentials endpoint, providing updated credentials for your configured NMS instance.

    PUT/v1/licenseServer/credentials
    {
      "username": "newuser",
      "password": "newsecurepassword"
    }
    

If the call is made successfully, the provided password is automatically encrypted and added to the Nuix RESTful Service application.properties file along with the provided username, replacing any previous values.

Connecting to Nuix Cloud License Server (CLS)

Nuix RESTful Service can be configured to acquire licenses from either an available Nuix Management Server (NMS) or from the Nuix Cloud License Server. By default, a NMS connection can be established during installation, however, CLS can also be configured after the installation completes by following the procedure outlined within this section.

Prerequisites:

To use CLS for licensing, you must have a valid CLS user account and credentials to connect to the Nuix portal (https://my.nuix.com).

Configuration:

Use the following procedure to configure Nuix RESTful Service to retrieve licenses from CLS:

  1. Navigate to the settings directory within the location where Nuix RESTful Service is installed.

    • Windows: C:\Program Files\Nuix\Nuix RESTful Service\settings
    • Debian/Ubuntu: /opt/nuix-restful-service/settings
  2. Locate and open the application.properties file within a text editor.

  3. Update the following properties with values based on the license source method being used.

    nuix.license.source=
    Specify the connection method being used for licensing. Valid values include:
    • cloud-server - Connect directly to CLS
    • local-relay-server-local-users - Connect to an NMS instance that has been configured as a relay server to retrieve licenses from the CLS using NMS user authentication.
    • local-relay-server-cls-users - Connect to an NMS instance that has been configured as a relay server to retrieve licenses from CLS using CLS user authentication.
    • server - (default) Connect to an NMS instance for licensing. Note: For information on configuring NMS as a relay server, see the Cloud License Server Getting Started Guide.
    nuix.registry.servers=
    The URL used to access the License server.
    nuix.license.server.username=
    Username of the CLS or NMS account being used for license acquisition.
    nuix.license.server.password=
    The password associated with the license server username.
  4. Save and exit the file.

  5. Restart Nuix RESTful Service for the changes to take effect.

Last modified June 18, 2020