Skip to main content

Primary Domain

The Primary Domain is the default Domain created upon installation, which provides core functionality and management of UDMG.

The Primary Domain is the only Domain that allows for the creation of System Administrators, who have control of global configurations and all Configuration Items (Users, Endpoints, Pipelines, etc.) within the Domain. See Roles for more details on System Admin permissions.

For most use cases, the Primary Domain is sufficient for managing file transfers.

Before You Begin

This document explains how to configure the Primary Domain, and the actions you can perform from the Primary Domain, including adding, viewing, and deleting Secondary Domains.

If you are not yet familiar with the concept of Domains in general, make sure to read the Domains documentation before you continue.

tip

The actions listed on this page are specific to the Primary Domain. For information on actions that can be done in any Domain, see Domains.

Configuring the Primary Domain

The Primary Domain is automatically created upon installation. You cannot create more than one Primary Domain. All additional Domains are Secondary Domains by definition.

You can customize the branding, LDAP, and SSO configuration in the Primary Domain, as you can with any Domain (see Managing Domains).

The Primary Domain cannot be deleted. This is because it is the central administration Domain and includes the configuration for all global settings (see Managing UDMG from the Primary Domain, below). Nevertheless, it is possible to avoid using the Primary Domain for file transfers by keeping all Configuration Items in dedicated Secondary Domains.

Administration

A generic System Administrator User (username: udmg.sys-admin, password: udmg.sys-admin_password) is automatically generated upon installation. The username of the default System Admin cannot be changed. You should log in as this User when first setting up the Primary Domain, then create additional System Administrator User(s) with custom names and passwords, via the Users page. You can then log out as the default User and log in as your custom profile(s) instead.

Only Users in the Primary Domain can have the System Administrator Role.

danger

Be sure to change the password for the default System Admin so that unauthorized Users cannot log in as an Admin. Do not lose your new password. The default System Admin User cannot be restored if the password is lost.

Managing UDMG from the Primary Domain

System Administrators can configure global settings from the Configuration File. System Admins can also perform the following actions from the UDMG Admin UI in the Primary Domain:

info

When a new global setting is saved via the UDMG Admin UI OR Configuration File, the System Admin must restart the UDMG Server. This ensures that the propagation of the change is controlled by the operator.

Adding a Secondary Domain

System Admins can create Secondary Domains from the Primary Domain.

tip

Using multiple Domains adds complexity to the UDMG setup, but can be useful in some scenarios. Before adding Secondary Domains, we recommend considering the pros and cons of a multi-Domain setup.

To add a Secondary Domains, follow these steps:

  1. From the Sidebar, click Global > Primary Domain.
  2. Click the Add Domain button above the Domains table.
  3. Fill out the fields for the new Domain using the Field Descriptions table as a guide.
  4. Click Add.

Field Descriptions

This table describes the fields that display on the New Domain form.

NameDescriptionSpecificationsRequired
NameThe name of the new Domain.Yes
DescriptionThe description of the new Domain.Cannot be changed after saving.Yes
Domain Admin UsernameUsername of the default Domain Administrator (udmg.domain-admin).Read-only. The username of the default Domain Administrator cannot be changed.N/A
PasswordPassword for the Domain Administrator, used for the initial login to the new Domain. The password can be changed later (see Changing a User's Password).Must follow the global password policy.Yes

Viewing Domain Details

System Admins can view the details of any Domain from the Primary Domain. To view the details of a Domain, follow these steps:

  1. From the Sidebar, click Global > Primary Domain.
  2. Click the Name of the Domain you want to view. You will see a table of Domain details.

Domain details include the parameters given in the Field Descriptions table above (except the Domain Admin Username and Password), plus the following read-only metadata:

Domain Metadata

NameDescription
UUIDUniversally Unique Identifier of this Domain.
CreatedDate and time this Domain was created.
Updated DateDate and time this Domain was last updated.

Monitoring Cluster Nodes

System Admins can monitor Cluster Nodes from the Primary Domain. See Cluster Nodes for more information.

Deleting a Secondary Domain

System Admins can delete Secondary Domains from the Primary Domain. The Primary Domain itself cannot be deleted.

To delete a Domain, follow these steps:

  1. From the Sidebar, click Global > Primary Domain.
  2. Click the Name of the Domain you want to delete.
  3. Click the Delete button above the Domain details.
  4. You will be asked to confirm the deletion. Type the name of the Domain, then click Continue.
danger

If a Domain is deleted, all Configuration Items within the Domain, including Users, Accounts, Endpoints, and Pipelines, are deleted. Deletion cannot be undone.