UDMG Licensing

The Universal Data Mover Gateway is licensed for a set time period, number of UDMG Server instances, and number of transfer executions per month and environment. The counted file transfer executions only include the number of transfer instances completed as DONE over one month. All environments must have an attached license key, including non-production environments.

License Information

The license includes six (6) components:

License Status: "Unlicensed" when no license has been entered, "Licensed" otherwise.
License Customer: name of customer
Environment: environment name (e.g., test, dev, non-prod, prod)
Expires On: the date when the license expires (at 00:00:00)
Nodes: the number of allowed cluster nodes, or unlimited
Transfers: the number of allowed transfers per month, or unlimited

Expiration Date

Each license has an explicit expiration date, regardless of when it is applied. A notification is provided by the Stonebranch Product Management Team when the expiration date is close.

Nodes

High Availability Licensed Cluster Nodes

The license and the restriction on the number of nodes is applied globally and the selection of active nodes is performed automatically during startup.

If the license has Cluster Node restrictions, then the following behavior is experienced when a new or existing Cluster Node is started up:

Number of Nodes within the License (No Violation)

If a new Cluster Node is started and the addition of a new Cluster Node is not in violation of the license:

The usual process occurs where the Cluster Node is created and starts up as PASSIVE.

If an existing Cluster Node is started after being offline, and the license is not in violation concerning Cluster Nodes:

The usual process takes place where the Cluster Node starts up as PASSIVE.

Number of Nodes Exceeds or Will Exceed the License (Violation)

If a new Cluster Node is started and the addition of a new Cluster Node violates the license or the license is already in violation for Cluster Nodes:

The new Cluster Node is added but runs as a new status of UNLICENSED.

If an existing Cluster Node is started and there are more Cluster Nodes than the license allows (i.e., the license is already in violation for Cluster Nodes):

A count of running Cluster Nodes is taken:
- If the number of running Cluster Nodes is less than the license, the Cluster Node starts up normally as PASSIVE.
- If the number of running Cluster Nodes exceeds the license, the Cluster Node starts up as UNLICENSED.

Unlicensed Node Processing

When a Cluster Node starts up as UNLICENSED, it can only transition from this status in the following conditions:

A new license is applied that is no longer in violation. A new license key must be requested from Stonebranch Support and applied following the License Key Update procedure.
The Cluster Node(s) transitions to an OFFLINE status, thereby removing the Cluster Node violation of the license.

Unlicensed Node Limitations

A user can connect to an UNLICENSED Cluster Node from the UDMG Admin UI or via the remote interfaces (command line or REST API); however, limited interaction is allowed:

Properties can be updated, to allow a new license to be applied.
Transfer Activity Monitoring is not permitted.
Transfer Management is not allowed. For example, the initiation of a file transfer to a remote partner is not permitted.

$ udmg-client_a transfer add -f myfile -l mylogin -p mypartner -r myrule -w send
unexpected error (405 Method Not Allowed): a valid license is required to perform this action

Local Server Commands like start, stop, restart, are not allowed to be executed.

Unlicensed Node UI

The Server Status button and pop-up shows an UNLICENSED Cluster Node, as seen below:

The button has a grey background, and the Controller service is marked as UNLICENSED.

From the UDMG Admin UI navigation pane, the Cluster Nodes service lists all registered nodes with their status and details:

Selecting the Active Node(s)

To change the ACTIVE Cluster Node in cases with restricted licenses, all nodes must be stopped and the desired node started first. The license is applied to the first node started and updates the node status to ACTIVE.

Transfers

The Universal Data Mover Gateway is licensed by the number of executions per month; specifically, the number of transfer instances that are completed as DONE over one month.

If the license is for an Unlimited number of monthly executions, then there is no limit on the number of transfer executions that can be run.

License Key Application

Each environment must have a license key to enable file transfers. The license key application should be done during the initial system installation and then for every license renewal.

Note

Only administrator users are allowed to apply and manage the UDMG license.

License Information

The license information is located in the License service in the UDMG Admin UI navigation pane.

License Key Application

The following steps outline how to enter the license key:

Step 1	Contact your Stonebranch representative or Customer Support to receive the license key for the intended environment.
Step 2	Login to UDMG Admin UI with an administrator user. The user must have "administration read" and "administration write" permissions.
Step 3	Click the License option in the UDMG Admin UI navigation pane.
Step 4	Input the license key and press the Update License button.
Step 5	Refresh the license details. The license key fields are updated with the following information: License Status License Customer Environment Expires On Nodes Transfers
Step 6	After a few minutes, the UDMG Server status switches to ACTIVE mode (see node status).

License Key Update

The following steps outline how to update the license key:

Step 1	Contact your Stonebranch representative or Customer Support to receive the updated license key for the intended environment.
Step 2	Login to UDMG Admin UI.
Step 3	Click the License option in the UDMG Admin UI navigation pane.
Step 4	Input the new license key and press the Update License button.
Step 5	Refresh the license details. The license key fields are updated (i.e., expiration date is updated):