Skip to main content
Version: Developer

Server Enrollment Tokens

Server Enrollment Tokens streamline the onboarding process for multiple Windows servers by providing reusable tokens with pre-configured connection settings, credentials, zones, and access policies. This eliminates the need to manually configure each server individually during enrollment.

Servers List

Create Enrollment Token

To create a new enrollment token, navigate to Infrastructure->Servers->Enrollment Tokens and click Add. Fill in the required information about the token configuration.

PropertyDescription
EnabledWhether this token is active and can be used for server enrollment.
Friendly NameA descriptive name for the enrollment token to help identify its purpose.
Deployment ZoneWhich deployment zone enrolled servers will be placed in.
Server Pool(Optional) Which pool enrolled servers will join.
Max UsesMaximum number of times this token can be used for enrollment. Must be greater than 0.
Expiration DateDate when the token expires and can no longer be used. Defaults to 48 hours in the future.
Connection PortWhich port to connect to enrolled servers on.
Connection TypeRDP connection type for Windows servers.
Connection Credential TypeWhich type of credentials are used for enrolled servers. Options are Static Credentials, Dynamic User Accounts, SSO User Accounts, and Authenticate with Smartcard
SSO Username DomainThis field applies when Connection Credential Type is set to SSO User Accounts. Use this field to modify the username. For example, in Kasm the username may be john.smith@acme.com, but Windows may expect john.smith@acme.local. A value of localhost strips the domain name from the username, i.e. john.smith. A value ending in \ prepends this field to the username, i.e. acme.local\john.smith. All other values are appended to the username with @, i.e. john.smith@acme.local.
Connection UsernameThe username to use to connect to enrolled servers. Only visible with Static Credentials Connection Credential Type.
Connection PasswordThe password to use to connect to enrolled servers. Only visible with Static Credentials Connection Credential Type.
Connection Info(Optional) Additional connection info that needs to be passed to enrolled servers. For more information see the Connections section of the global settings
Max Simultaneous SessionsThe maximum amount of sessions that can connect to each enrolled server at a time. Must be greater than 0. For RDP servers with RemoteApps, admins may want to set this value higher than the Max Simultaneous Users setting to allow for multiple RemoteApps per user.
Max Simultaneous UsersFor RDP and SSH servers, the number of concurrently connected users per enrolled server.

Using Enrollment Tokens

Server Enrollment

Enrollment tokens can be used to enroll Windows servers either manually through the Admin UI or programmatically via scripts. For detailed instructions on both manual enrollment and automated scripting approaches, see the Kasm Desktop Service section.

Server Connectivity

Normally, the server hostname value is used to connect to the server however it cannot currently be templated and must be dynamically detected.

In order to do so we attempt to connect to the server, first via the server's FQDN and if that fails we attempt to connect using the request IP address.

If both attempts to establish connectivity to the server are unsuccessful, enrollment will fail.

Enrolled Server Management

Once servers are enrolled using tokens, they appear in the Infrastructure->Servers->Servers list and can be managed like any other server. The name of the server is derived from the template name plus the first 6 digits of the server ID. Enrolled servers display:

  • Which enrollment token was used
  • Enrollment timestamp
  • All standard server management options

In order for enrolled servers to be accessible to users, a Workspace must be created and then add the Workspace to a Group.

Token Management

Viewing Token Usage

Monitor enrollment token usage by navigating to Infrastructure->Servers->Server Enrollment Tokens. Each token displays:

  • Number of times used
  • Max uses
  • Expiration status

Disabling Tokens

To prevent further use of an enrollment token, navigate to Infrastructure->Servers->Server Enrollment Tokens and disable or delete the token. Existing enrolled servers remain unaffected.

Token Security

Treat enrollment tokens as sensitive credentials. Store tokens securely and rotate them regularly. Disabling or deleting a token does not affect servers that were previously enrolled using that token.