Connections
In OpenVLE, connections define which users can connect to which virtual machines.
These connections are provided via Apache Guacamole and enable remote access directly in the browser -- without any additional software installation.
Each connection contains information such as the virtual machine, connection template, and user.
Administrators can create, delete, or monitor connections here.
Where can I find this section?
Via main menu: Connections → Connections
Alternatively accessible via: Linked from Virtual Machines or VM templates
Features at a glance
- View existing Guacamole connections
- Create new connections for users based on connection templates
- Use connection templates as a foundation
- Delete outdated or no longer needed connections
Important fields at a glance
| Field name | Description |
|---|---|
Connection template | The connection template used, which defines the protocol, port, and credentials. |
Event | (Optional) Assigned event, if the connection was automatically created as part of an event. |
Name | Display name of the connection. Shown in lists and dialogs -- this is also the connection name in Apache Guacamole that users see when logging in. |
User | User account to which this connection is assigned. Only this user can access the VM via Apache Guacamole. |
Virtual Machine (VM) | Reference to the VM that the user can connect to via this connection. |
Creating a connection
- Open the Connections → Connections section from the main menu.
- Click Add to create a new connection.
- Select the desired connection template.
- Select the user who should have access to the connection.
- Save the connection.
- The user can then immediately connect to the associated VM via Apache Guacamole.
Deleting a connection
- Open the Connections → Connections section from the main menu.
- Find the desired connection in the list.
- Click Delete, or open the context menu and select Delete.
- Confirm the deletion in the displayed dialog.
- The connection is then permanently removed.
After deletion, the user immediately loses access to the virtual machine in Apache Guacamole.
Example or use case
An administrator wants to give developers access to a Linux VM. She opens the Connections section and creates a new connection for each user based on a suitable connection template for the desired VM. The users can then start the connection directly in the browser -- securely and without local SSH software.
Notes / special considerations
- Every connection is based on a connection template.
- Changes to a connection take effect immediately.
- Sensitive data (e.g. passwords) cannot be viewed again.
- Active sessions can be viewed and terminated if needed via the Apache Guacamole server.
- Only administrators are allowed to create or delete connections.
- Connections are user-specific and cannot be assigned to multiple users.
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 |
|---|---|---|
| Connection template | Each connection is based on exactly one connection template. | No automatic changes when the template is updated or deleted. |
| Event | (Optional) A connection can be assigned to an event. | When the event is deleted, all associated connections are automatically deleted. |
| Tags | Objects can be tagged with any number of tags to categorize or filter them. | Automatic removal when the object is deleted. |
| Tasks | System-internal tasks that are automatically created and monitored for actions (e.g., starting, stopping, or cloning). | Automatic creation for certain processes or actions. |
| User | Each connection is assigned to exactly one user. | When the user is deleted, all associated connections are automatically deleted. |
| Virtual Machine (VM) | Each connection is assigned to exactly one VM. | When the VM is deleted, all associated connections 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 | / |
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.