Installing a production license

To install the RLM server on Windows

1. Download the RLM License Administration Bundle from the Reprise Software website.

   Note

   Starting with NICE DCV version 2022.1 the RLM server >= 14 is required. Previous versions require RLM >= 12.

   The installation of the latest stable version of the RLM license Administration Bundle is recommended.

2. Install the RLM License Administration Bundle to C:\RLM.

To install the RLM server on Linux

1. Download the RLM License Administration Bundle from the Reprise Software website.

   Note

   Starting with NICE DCV version 2022.1 the RLM server >= 14 is required. Previous versions require RLM >= 12.

   The installation of the latest stable version of the RLM license Administration Bundle is recommended.

2. Create a user group and an rlm user. This can be any valid user or service account. We strongly recommend that you don't use the root account for this value.

   $ groupadd -r rlm

   $ useradd -r -g rlm -d "/opt/nice/rlm" -s /sbin/nologin -c "RLM License Server" rlm

3. Create the /opt/nice/rlm and /opt/nice/rlm/license directories required for the RLM server.

   $ mkdir -p /opt/nice/rlm/license

4. Extract the contents of the RLM License Administration Bundle to /opt/nice/rlm/, and ensure that the files are owned by the rlm user.

   $ tar xvf x64_l1.admin.tar.gz -C /opt/nice/rlm/ --strip-components 1

   $ chown -R rlm:rlm /opt/nice/rlm

1. Navigate to /opt/nice/rlm/.

2. Run the following command:

   $ ./rlmutil rlmhostid ether

   The command returns the RLM server's host ID for each network interface as follows.

3. Record the host ID. You need it for the next step.

1. Navigate to /opt/nice/rlm/.

2. Run the following command:

   $ ./rlmutil rlmhostid ether

   Multiple IDs will be returned in a list of IDs.

3. Run the following command.

   iface=$(route -n | grep " UG " | tr -s " " | cut -d" " -f8)
   ip link show $iface | grep link/ether | tr -s " " | cut -d" " -f3 | tr -d ":"

   The command should return the RLM server's host ID for the Gateway network interface.

4. Record the host ID. You need it for the next step.

To edit the license.lic file

1. Open the file with your preferred text editor.

2. Add your RLM server's hostname and the TCP port number to the first line in the file, which starts with HOST.

   Warning

   The RLM_server_host_id is the host ID that you provided when you purchased the license. You cannot edit the RLM_server_host_id.

3. (Optional) Add the ISV port number in the line in file which starts with ISV, by adding port=port_number. This port is required to enable communication with the DCV server.

   If you don't want to specify an ISV port, omit port=port_number. If you don't specify an ISV port, a random port is used by RLM at each startup.

   Warning

   If you have a firewall setup preventing the use of a randomly selected port, you need to specify this port and configure the firewall to enable it, in addition to the RLM port specified in the HOST line.

4. Save and close the file.

To configure the RLM server on Windows

1. Connect to your RLM server.

2. Copy the edited license.lic file to C:\RLM\license\.

3. Copy the C:\Program Files\NICE\DCV\Server\license\nice.set file from your NICE DCV server and place it in the C:\RLM\ folder on your RLM server.

4. Install the RLM server as a Windows service.

   C:\> rlm.exe -nows -dlog C:\RLM\rlm.log -c C:\RLM\license -install_service -service_name dcv-rlm

   For more information about the RLM startup options, see the Reprise Software License Manager (RLM) product page.

5. Start the RLM server.

   C:\> net start dcv-rlm

6. Confirm that the RLM server is running.

   1. Open C:\RLM\nice.dlog with your preferred text editor and confirm that the following line appears.

      date_time (nice) Server started on license1 (hostid: host_id) for: dcv dcv-gl

      Note

      The contents of the rlm.log file might vary slightly depending on the RLM server version.

   2. Run the following command.

      C:\RLM\rlmutil rlmstat -a -c rlm_server_hostname@5053

      The command returns information about the RLM server.

To configure the RLM server on Linux

1. Copy the edited license.lic file to /opt/nice/rlm/license/.

2. Copy the /usr/share/dcv/license/nice.set file from your NICE DCV server and place it in /opt/nice/rlm on your RLM server.

3. Create an RLM server service and make sure that it starts automatically at startup.

   1. Create a file named dcv-rlm in the /opt/nice/rlm/ folder:

      $ touch /opt/nice/rlm/dcv-rlm

   2. Open the file using your preferred text editor and add the following script. Save and close the file.

      #! /bin/sh
      # chkconfig: 35 99 01
      # description: The Reprise License Manager daemon.
      # processname: dcv-rlm
      
      ### BEGIN INIT INFO
      # Provides: dcv-rlm
      # Required-Start: $local_fs $remote_fs $syslog
      # Required-Stop: $local_fs $remote_fs $syslog
      # Default-Start: 3 4 5
      # Default-Stop: 0 1 2 6
      # Short-Description: The Reprise License Manager daemon.
      # Description: A service that runs the Reprise License Manager daemon.
      ### END INIT INFO
      
      # user used to run the daemon
      RLM_USER="rlm"
      
      # root of rlm installation
      RLM_ROOT="/opt/nice/rlm"
      
      # license directory (license files should have .lic extension)
      RLM_LICENSE_DIR="/opt/nice/rlm/license"
      
      # log file
      RLM_LOG_FILE="/var/log/rlm.log"
      
      _getpid() {
          pidof -o $$ -o $PPID -o %PPID -x "$1"
      }
      
      start() {
          echo -n "Starting rlm: "
          touch ${RLM_LOG_FILE}
          chown "${RLM_USER}" ${RLM_LOG_FILE}
          su -p -s /bin/sh "${RLM_USER}" -c "${RLM_ROOT}/rlm -c ${RLM_LICENSE_DIR} \
              -nows -dlog +${RLM_LOG_FILE} &"
          if [ $? -ne 0 ]; then
              echo "FAILED"
              return 1
          fi
          echo "OK"
      }
      
      stop() {
          echo -n "Stopping rlm: "
          pid=`_getpid ${RLM_ROOT}/rlm`
          if [ -n "$pid" ]; then
              kill $pid >/dev/null 2>&1
              sleep 3
              if [ -d "/proc/$pid" ] ; then
                  echo "FAILED"
                  return 1
              fi
          fi
          echo "OK"
      }
      
      status() {
          pid=`_getpid ${RLM_ROOT}/rlm`
          if [ -z "$pid" ]; then
              echo "rlm is stopped"
              return 3
          fi
          echo "rlm (pid $pid) is running..."
          return 0
      }
      
      restart() {
          stop
          start
      }
      
      case "$1" in
          start)
              start
              ;;
          stop)
              stop
              ;;
          status)
              status
              ;;
          restart)
              restart
              ;;
          *)
              echo $"Usage: $0 {start|stop|status|restart}"
              exit 1
      esac
      
      exit $?
      
      # ex:ts=4:et:

   3. Make the script executable, copy it to /etc/init.d/, and then add it to the chkconfig utility:

      chmod +x /opt/nice/rlm/dcv-rlm 

      cp -a /opt/nice/rlm/dcv-rlm /etc/init.d/

      chkconfig --add dcv-rlm

4. Start the RLM server:

   $ service dcv-rlm start

5. Verify that the RLM server is running and functioning as expected. Open var/log/rlm.log with your preferred text editor and confirm that the following line appears:

   date_time (nice) Server started on license1 (hostid: host_id) for: dcv dcv-gl

   Note

   The contents of the rlm.log file might vary slightly depending on the RLM server version.

To configure the license-file configuration parameter on a Windows server

1. Open the Windows Registry Editor.

2. Navigate to the HKEY_USERS/S-1-5-18/Software/GSettings/com/nicesoftware/dcv/license/ key and select the license-file parameter.

   If there is no license-file parameter in the registry key, you must create it:

   1. Open the context (right-click) menu for the license key in the left pane and choose New, String Value.

   2. For Name, enter license-file and press Enter.

3. Open the license-file parameter. For Value data, enter the RLM server's port number and hostname in the RLM_server_port@RLM_server format. Check the note above if you need to setup connection to multiple RLM servers.

4. Choose OK and close the Windows Registry Editor.

To configure the license-file configuration parameter on a Linux server

1. Navigate to /etc/dcv/ and open the dcv.conf with your preferred text editor.

2. Locate the license-file parameter in the [license] section. Then, replace the existing path with the port and hostname of the RLM server in the RLM_server_port@RLM_server format.

   If there is no license-file parameter in the [license] section, add it manually using the following format:

   license-file = "RLM_server_port@RLM_server"

   Check the note above if you need to setup connection to multiple RLM servers.

3. Save and close the file.