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 has six (6) components:

• License Status: "Unlicensed" when no license has been entered, "Licensed" otherwise.
• License Customer
• Environment
• Expiration Date: the date when the license expired (at 00:00:00)
• Nodes: the number of allowed cluster nodes, or unlimited
• Transfers: the number of allowed transfers per month, or unlimited

The license has an explicit expiration date, regardless of when it is applied.

A notification will be provided by Stonebranch Product Management Team when the expiration date is close.

High Availability Licensed Cluster Nodes

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

When a Universal Data Mover Gateway has restrictions on the Cluster Nodes within its License, 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 starts up and adding 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 starts up after being offline, and the License is not in violation with respect to Cluster Nodes: 

• The usual process takes place with the Cluster Node starting up as Passive.

Number of Nodes exceeds or will exceed the License (Violation)

If a new Cluster Node starts up and adding a new Cluster Node violates the License, or the License is already in violation for Cluster Nodes:

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

If an existing Cluster Node starts up and there are more Cluster Nodes than the License allows; that is, 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 out of this mode in the following conditions:

• A new License is applied to the system that no longer makes the number of Cluster Nodes in violation of the License. A new license key must be requested from Stonebranch Support and applied with the Update License Key procedure. 
• A transitioning to OFFLINE mode of Cluster Node(s) occurs, 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 with the remote interfaces (command line or REST API); however, limited interaction is allowed:

• Transfer Activity Monitoring is not allowed.
• Transfer Management is not allowed. For example, it is not possible to initiate a file transfer to a remote partner.

$ 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.

• Properties can be updated, to allow a new license to be applied.

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.

The Cluster Node List shows all registered nodes with their status and details:

Selecting the active node(s)

In case it is required to select which UDMG Server node must be active whenhaving a license that limit the number of nodes, it is required to stop all the nodes and then start the desired one. The license will be applied when this node starts as the first node going online and switching to ACTIVE state. 

Number of Monthly Transfers

The Universal Data Mover Gateway is licensed by the number of executions per month; specifically, the number of transfer instances that completed as DONE over a period of one month. Customers that are using UAC and UDMG, the WLA task count excludes file transfer related tasks

(no, the WLA does not exclude the UDMG file transfer tasks) 

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.

what counts as a transfers? incoming/outgoing?

are they notified when they are close to it per month? - no; there is no system tracker – we need to think about how we communicate this; 

if so how? if not we should say PM manages it and communicate # to customer monthly; is there a a manual way to pull this? if i was them i would want to know how many i did regardless if we are going to stop them + sales needs to know to help put it in contractually

is it total transfers or per node? 

Apply the License Key

A license key must be provided to enable file transfers. This wil be typically be done during the initial system installation and for every license renewal.

License Information

The License option in the sidebar menu identifies license information for:

• License Status
• License Customer
• Environment
• Expiration Date
• Cluster Nodes
• Monthly Transfers

License Key Application

The following steps outline how to enter the license key:

License Key Update

The following steps outline how to update the license key: