Connection templates
Connection templates define reusable settings for connections in OpenVLE.
They allow you to store standardized connection parameters such as protocol, port, username, or password, so that administrators can create new connections quickly and consistently.
Where can I find this section?
Via main menu: Connections → Templates
Alternatively accessible via: Linked from Virtual Machines, VM templates, or Connections
Features at a glance
- A connection template is always assigned to exactly one VM or VM template
- View all existing connection templates
- Create new templates with defined default values for protocols (e.g. RDP, SSH)
- Delete templates that are no longer needed
Important fields at a glance
| Field name | Description |
|---|---|
Label | Display name of the connection template. Shown in lists and dialogs and automatically generated. |
Password | Password for the specified user account. Used by the Apache Guacamole server to establish the connection. Not displayed again after creation. |
Port | Network port for the connection. Default is **22** for SSH and **3389** for RDP. |
Protocol | Communication protocol used for the connection. Supported values are **SSH** or **RDP**. |
Username | Login username used by the Apache Guacamole server for authentication on the VM. |
VM or VM template | Reference to the assigned VM or VM template that this connection template applies to. |
Creating a connection template
- Open the Connections → Templates section from the main menu.
- Click Add to create a new connection template.
- Select the desired protocol (e.g. RDP or SSH).
- Enter default parameters such as port, username, and password.
- Save the template.
- You can then use the template when creating new connections.
Connection templates cannot be edited, only recreated.
Deleting a connection template
- Open the Connections → Templates section from the main menu.
- Find the desired template in the list.
- Click Delete, or open the context menu and select Delete.
- Confirm the deletion in the displayed dialog.
- The connection template is then permanently removed.
Connection templates can only be deleted when no connections based on this template exist.
If dependent connections still exist, they must be deleted first before the template can be removed.
Automatic duplication
When a new VM is created, all connection templates assigned to the VM template used are automatically duplicated and assigned to the newly created VM.
This way, the newly generated connection templates can be used to establish connections to the VM -- either manually or as part of an event.
Example or use case
An administrator wants to ensure that all training VMs are created with the same RDP settings. She creates a new template in the Connection templates section, selects the RDP protocol, and enters the login credentials. Connections can then be created based on this connection template and assigned to the corresponding users or VMs.
Notes / special considerations
- Connection templates cannot be edited, only recreated.
- Templates serve to standardize and speed up the provisioning of new VMs or user connections.
- Existing connections retain their individual settings.
- The connection templates list allows you to see which VMs or connections use a specific template.
- Only administrators or users with the appropriate permissions may create or delete connection templates.
Relationships to other objects
Many objects in OpenVLE are related to other elements within the system. The following overview shows which relationships exist and whether they trigger certain automations.
| Object | Description | Automatic behavior |
|---|---|---|
| Permissions | Object-specific permissions can be assigned directly to the object. | Automatic removal when the object is deleted. |
| Tags | Objects can be tagged with any number of tags to categorize or filter them. | Automatic removal when the object is deleted. |
| VM / VM template | A connection template is assigned to exactly one VM or VM template. | When the VM or VM template is deleted, all associated connection templates and connections based on them are automatically deleted. |
Required permissions
The permissions required for actions can be assigned via roles or individually. If you lack certain rights, the corresponding functions in the user interface are hidden or disabled.
| Action | Required permission | Path | Additional information |
|---|---|---|---|
| View connections | guacamoles_read | / or /<objectID> | |
| Create connections | guacamoles_create | / | |
| Delete connections | guacamoles_delete | / or /<objectID> | |
| View connection templates | guacamole_connection_profiles_read | / or /<objectID> | |
| Create connection templates | guacamole_connection_profiles_create | / | |
| Delete connection templates | guacamole_connection_profiles_delete | / or /<objectID> | |
| View virtual machines | vms_read | / or /<objectID> | |
| Read VM templates | templates_read | / or /<objectID> |
Example:
/4a3bc312-d1af-4b3f-b222-f5e9cecbf007 – This gives the user access to this single object only.If the path / is used, the permission applies globally to all objects of this type.
For *_create permissions, only the global path / is allowed.