User Manual
Start Remote Desktop listening and schedule automated starts
This page allows you to manage remote desktop connections (VNC) to your devices. You can start and stop the VNC server, view connection instructions, monitor your daily VNC usage, and schedule automated starts for convenient remote access.
Start Remote Desktop listening and schedule automated starts
Summary
This page provides comprehensive control over your device's remote desktop (VNC) functionality. You can initiate and terminate VNC server sessions, access detailed instructions for connecting to a running server, keep track of your daily VNC usage against your license limits, and set up schedules for the automatic activation of remote listening. This ensures secure and efficient remote management of your devices.
Page Access
You can access this page by navigating to: /devices_rdp
Page Functionalities
VNC Server Status and Control
- Status Indicator: Displays whether the VNC server is currently running or not.
- Start VNC Server: A large clickable area (marked with a 'Play' icon) that allows you to start the VNC server on your device. This button is only active if you are within your daily VNC usage limits.
- Stop VNC Server: If the VNC server is running, a 'Stop' button will appear, allowing you to terminate the active VNC session.
- Connection Instructions: When the VNC server is active, this section provides essential details and steps on how to connect to your device remotely using a VNC client.
Usage Monitoring
- Daily VNC Usage: A clear display showing your VNC time spent today (in minutes) compared to your total allowed daily minutes as per your license.
- Limit Exceeded Warning: If you exceed your daily VNC usage limit, a warning message will be displayed, and the option to start a new VNC session will be disabled. An 'Open Settings' button will also be available to manage your license.
Automated Activation Scheduling
- Schedule Automated Activation of awaBerry Anywhere: This section allows you to set up a schedule for automatically starting the VNC server. You can configure when the system should listen for incoming connections, for example, activating it every workday for remote access.
- Scheduler Configuration: Provides options to define specific days and times for automated VNC server activation.
Session Management
- Session Expiration Notifications: The system will notify you if your remote session is about to expire or has already expired.
- SSH Disconnection Handling: If the underlying SSH connection to your device is lost, the VNC management view will automatically close, ensuring session integrity.
Scenario Executions
Possible usage steps within this page
Scenario: Starting a VNC Session
You want to access your device remotely using VNC for a short period.
- Navigate to the Remote Desktop page (
/devices_rdp). - Observe the 'VNC server is not started' message and the 'Play' icon.
- Click the 'Play' icon or the 'Click to start VNC server' area.
- The page will show 'Starting VNC server...' with a loading indicator.
- Upon successful start, the page will display VNC connection instructions, including the server address and port, and a 'Stop' button.
- You can now connect to your device using your preferred VNC client with the provided details.
Scenario: Stopping an Active VNC Session
You have finished your remote work and want to close the VNC connection.
- Ensure you are on the Remote Desktop page (
/devices_rdp) and the VNC server is running, displaying connection instructions and a 'Stop' button. - Click the 'Stop' button.
- The page will show a loading indicator briefly as the server shuts down.
- Upon successful shutdown, the page will revert to the 'VNC server is not started' state, and the 'Play' icon will reappear.
Scenario: Scheduling Automated VNC Activation
You wish to have your VNC server automatically start every weekday morning for regular remote access.
- Navigate to the Remote Desktop page (
/devices_rdp). - Scroll down to the 'Schedule automated activation of awaBerry Anywhere' section.
- Within this section, use the provided controls (e.g., dropdowns for days, time inputs) to define your desired schedule (e.g., Monday-Friday, 9:00 AM).
- Save your schedule using the relevant save button within the scheduling interface.
- The system will now automatically activate the VNC server according to your set schedule.
Possible errors which may occur on this page
Error: Daily VNC Usage Limit Exceeded
Description: This error occurs when you have used up all the remote desktop (VNC) time allowed by your license for the current day. Your license might have a maximum number of minutes you can use VNC daily.
Impact: You will not be able to start a new VNC server session. The 'Start VNC server' button will be disabled, and a warning message stating 'You exceeded daily limit for remote desktop connections (VNC) included in your license: {maxMinutes} minutes' will be displayed.
Resolution: You can wait until the next day when your daily usage resets, or you can click the 'Open Settings' button to review your license details or upgrade your plan to allow for more VNC minutes.
Error: SSH Connection Disconnected
Description: The VNC functionality relies on an active secure shell (SSH) connection to your device. If this underlying connection is lost (e.g., due to network issues, device going offline, or session timeout), the VNC management page cannot function.
Impact: The current VNC management view will automatically close, and you will be returned to a previous screen or the main dashboard. You might also see a 'Session Expired' notification.
Resolution: Re-establish your SSH connection to the device. Once connected again, you can navigate back to the Remote Desktop page to manage VNC.
Error: VNC Server Fails to Start
Description: This can happen if there are network issues between your device and the awaBerry platform, or if there's a problem with the VNC server application on your remote device. The server command might not execute correctly.
Impact: After attempting to start the server, instead of seeing connection instructions, the page will either remain in the 'Starting VNC server...' state indefinitely or revert to 'VNC server is not started' without providing instructions. An error message might also appear.
Resolution: Check your device's internet connection and ensure it's online. You may need to investigate the status of the VNC server application directly on your device if problems persist, or restart the awaBerry application.
