Step 1: Install the RLM server Step 2: Get the host ID for the RLM server Step 3: Purchase the perpetual license or subscription Step 4: Modify the license file Step 5: Configure the RLM Server Step 6: Configure the Amazon DCV Server

Installing a production license

The following sections in this topic describes how to purchase and use a production license (perpetual license or subscription).

Topics

Step 1: Install the RLM server
Step 2: Get the host ID for the RLM server
Step 3: Purchase the perpetual license or subscription
Step 4: Modify the license file
Step 5: Configure the RLM Server
Step 6: Configure the Amazon DCV Server

Step 1: Install the RLM server

When you purchase a perpetual license or subscription, you get a license file that defines the terms of your license. You must install the license file on a Reprise License Manager (RLM) server.

For more information about RLM, see the Reprise Software website.

Install the RLM server on Windows

To install the RLM server on Windows

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

Note
Starting with Amazon 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.
Install the RLM License Administration Bundle to C:\RLM.

Install the RLM server on Linux

To install the RLM server on Linux

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

Note
Starting with Amazon 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.
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
```
Create the /opt/nice/rlm and /opt/nice/rlm/license directories required for the RLM server.
```
$ mkdir -p /opt/nice/rlm/license
```
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
```

Step 2: Get the host ID for the RLM server

After you install the RLM server, you must get the RLM server's host ID. You need to provide this host ID when purchasing a perpetual license or subscription.

Get the RLM server host ID on Windows

To get the the host ID for the server, open the command prompt,

Navigate to C:\RLM\, and then run the following command.


C:\> rlmutil.exe rlmhostid ether

The command returns the host ID for the RLM server is as follows.


Hostid of this machine: 06814example

Make note of the host ID. You need it for the next step.

Get the RLM server host ID on Linux

To get the server's host ID, single return

Navigate to /opt/nice/rlm/.
Run the following command:
```
$ ./rlmutil rlmhostid ether
```
The command returns the RLM server's host ID for each network interface as follows.
Record the host ID. You need it for the next step.

This procedure was run and the following single ID was returned:


Hostid of this machine: 0a1b2c3d4e5f

This ID is then recorded and will be used to purchase the license for DCV.

To get the server's host ID, multiple returns

Navigate to /opt/nice/rlm/.
Run the following command:
```
$ ./rlmutil rlmhostid ether
```
Multiple IDs will be returned in a list of IDs.

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.

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

The procedure was run and multiple IDs were returned in a list of multiple ID’s:


Hostid of this machine: 0a1b2c3d4e5f 1b2c3d4e5f6a 2c3d4e5f6a7b 3d4e5f6a7b8c

The interface command is run and returns the following ID:


Hostid of this machine: 0a1b2c3d4e5f

This ID is then recorded and will be used to purchase the license for DCV.

Step 3: Purchase the perpetual license or subscription

For information about how to purchase a Amazon DCV perpetual license or a subscription, see How to Buy on the Amazon DCV website and find a Amazon DCV distributor or reseller in your region.

You must provide the host ID for your RLM server. The host ID is embedded in the license file that Amazon DCV provides.

Step 4: Modify the license file

When you purchase a Amazon DCV perpetual license or subscription, you receive a license.lic file that defines the license. The license.lic file includes the following information:

The hostname of the RLM server.
The host ID of the RLM server that you provided when you purchased the license.
The TCP port number of the RLM server. The default is 5053.
The ISV port number. This is an optional port where the RLM server listens for Amazon DCV license requests. If not specified a random port is picked by RLM at startup.
The Amazon DCV products covered by the license, along with the following details for each product:
- The major version that's covered by the license (for example, 2017 for the 2017 Amazon DCV products).
- The expiration date. Permanent indicates that the license doesn't expire.
- The maximum number of concurrent sessions (for example, 10 for 10 concurrent sessions on the server).
- The license checksum.
- The license signature.

The following code block shows the format of the license.lic file:


HOST RLM_server_hostname RLM_server_host_id RLM_server_port
ISV nice port=port_number
LICENSE product_1 major_version expiration_date concurrent_sessions share=hi _ck=checksum sig="signature"
LICENSE product_2 major_version expiration_date concurrent_sessions share=hi _ck=checksum sig="signature"

The following code block shows an example of a license.lic file with the ISV port omitted. The license file includes licenses for two Amazon DCV products, DCV and dcv-gl.


HOST My-RLM-server abcdef123456 5053
ISV nice
LICENSE nice dcv 2017 permanent 10 share=hi _ck=456789098a sig="abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqrstuvwxyz1234567890ab"
LICENSE nice dcv-gl 2017 permanent 10 share=hi _ck=123454323x sig="1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqrstuvwxyz12"

To edit the `license.lic` file

Open the file with your preferred text editor.
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.
(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.
Save and close the file.

Warning

Editing any other part of the license file corrupts the file's signature and invalidates the license.

Step 5: Configure the RLM Server

After you modified the license file, you must place it on your RLM server and then start the RLM service.

Topics

Configure the RLM Server on Windows
Configure the RLM server on Linux

Configure the RLM Server on Windows

To configure the RLM server on Windows

Connect to your RLM server.
Copy the edited license.lic file to C:\RLM\license\.
Copy the C:\Program Files\NICE\DCV\Server\license\nice.set file from your Amazon DCV server and place it in the C:\RLM\ folder on your RLM server.
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.
Start the RLM server.
```
C:\> net start dcv-rlm
```
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.

Configure the RLM server on Linux

To configure the RLM server on Linux

Copy the edited license.lic file to /opt/nice/rlm/license/.
Copy the /usr/share/dcv/license/nice.set file from your Amazon DCV server and place it in /opt/nice/rlm on your RLM server.

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

Create a file named dcv-rlm in the /opt/nice/rlm/ folder:
```
$ touch /opt/nice/rlm/dcv-rlm
```

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:

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
```

Start the RLM server:
```
$ service dcv-rlm start
```
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.

Step 6: Configure the Amazon DCV Server

Configure your Amazon DCV server to use the RLM server. To do this, you must configure the license-file configuration parameter on your Amazon DCV server.

The license-file parameter must be set with the specification of the RLM server to connect to, in the format RLM_server_port@RLM_server. The RLM server can be either specified as a hostname or as an IP address. If not configured explicitly, the RLM server port is by default 5053.

In case multiple RLM servers are in use, you can specify a list of multiple RLM servers specifications, separated by : on Linux, by ; on Windows. Then the server will try to connect to each one in turn, until one connection can be established with the corrresponding RLM server. This can be especially useful for example when using an RLM failover server to take over in case the primary RLM server is not reachable. In this case you can specify the license in the format: RLM_primary_server_port@RLM_primary_server:RLM_failover_server_port@RLM_failover_server

Note

In case the Amazon DCV Server is installed on Windows, you need to separate the entries in the specification with ;.

Topics

Windows Amazon DCV Server configuration
Linux Amazon DCV Server configuration

Windows Amazon DCV Server configuration

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

Open the Windows Registry Editor.
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.
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.
Choose OK and close the Windows Registry Editor.

Linux Amazon DCV Server configuration

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

Navigate to /etc/dcv/ and open the dcv.conf with your preferred text editor.
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.
Save and close the file.

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Installing an extended evaluation license

Updating the production license

Installing a production license

Topics

Step 1: Install the RLM server

Topics

Install the RLM server on Windows

To install the RLM server on Windows

Note

Install the RLM server on Linux

To install the RLM server on Linux

Note

Step 2: Get the host ID for the RLM server

Get the RLM server host ID on Windows

To get the the host ID for the server, open the command prompt,

Get the RLM server host ID on Linux

Step 3: Purchase the perpetual license or subscription

Step 4: Modify the license file

To edit the license.lic file

Warning

Warning

Warning

Step 5: Configure the RLM Server

Topics

Configure the RLM Server on Windows

To configure the RLM server on Windows

Note

Configure the RLM server on Linux

To configure the RLM server on Linux

Note

Step 6: Configure the Amazon DCV Server

Note

Topics

Windows Amazon DCV Server configuration

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

Linux Amazon DCV Server configuration

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

To edit the `license.lic` file

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

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