...
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 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)
- Expiration Date: the date when the license expired 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
The Each license has an explicit expiration date, regardless of when it is applied. A notification will be is provided by the Stonebranch Product Management Team when the expiration date is close.
Nodes
High Availability Licensed Cluster Nodes
The :icense license 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, 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 starts up and adding is started and the addition of a new Cluster Node is not in violation of the Licenselicense:
The usual process occurs where the Cluster Node is created and starts up as Passive PASSIVE.
If an existing Cluster Node starts up is started after being offline, and the License license is not in violation with respect to concerning Cluster Nodes:
The usual process takes place with where the Cluster Node starting starts up as Passive PASSIVE.
Number of Nodes
...
Exceeds or
...
Will Exceed the License (Violation)
If a new Cluster Node starts up and adding is started and the addition of a new Cluster Node violates the License, license or the License 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 is started and there are more Cluster Nodes than the License allows; that islicense allows (i.e., the License 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 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 from this mode status in the following conditions:
- A new License license is applied to the system that is 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 following the Update License Key Update procedure.
- A transitioning to OFFLINE mode of The Cluster Node(s) occurstransitions to an OFFLINE status, thereby removing the Cluster Node violation of the Licenselicense.
Unlicensed Node Limitations
A user can connect to an UNLICENSED Cluster Node from the UDMG Admin UI or with 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 allowedpermitted.
- Transfer Management is not allowed. For example, it is not possible to initiate the initiation of a file transfer to a remote partner is not permitted.
| Code Block | ||
|---|---|---|
| ||
$ 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.
The Cluster Node List shows 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)
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.
...
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 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.
...
| title | Note |
|---|
...
.
...
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
...
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 option in the sidebar menu identifies license information for:
- License Status
- License Customer
- Environment
- Expiration Date
- Cluster Nodes
- Monthly Transfers
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 operating system and 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 sidebar menuUDMG Admin UI navigation pane. |
Step 4 | Input the license key and press the Update License button.
|
| Step 5 | Refresh the the License license details. The License license key fields are updated with the following information:
|
| Step 6 | After a few minutes, the UDMG Server status switches to ACTIVE mode (see node status)
|
...
| Step 1 | Contact your Stonebranch representative or Customer Support to receive the updated license key for the intended operating system and environment. |
|---|---|
| Step 2 | Login to UDMG Admin UI. |
Step 3 | Click the License option in the sidebar menuUDMG Admin UI navigation pane. |
Step 4 | Input the new license key and press the Update License button.
|
| Step 5 | Refresh the the License license details. The License license key fields are updated (here the i.e., expiration date is updated):
|
...