Enable Remote Access and Connect to a Virtual Machine

Overview

You can use this document to learn how to enable remote access and then connect to a virtual machine. 

After you enable remote access for a workload, all instances (containers and virtual machines) within the workload will have remote access enabled. For virtual machines, you can connect via a VNC or serial console. 

Note: Remote access allows any IP address with valid credentials to log in to your instance through StackPath’s SSH console. Access to your virtual machine is protected by your StackPath credentials, instance name, stack ID, and optional two-factor authentication.

Step 1: Enable remote access for a virtual machine

You can use these instructions to enable remote access for a virtual machine or for a container. 

1. In the StackPath Control Portal, in the left-side navigation, click Edge Compute. 
2. In the left-side navigation menu, click Workloads. 
3. Locate and select the desired workload. 
4. Navigate to Manage Your Instances, and then use the slider to enable Remote Management.
5. Above Manage Your Instances, navigate to Instances, and then select the desired instance. 
   • You will be redirected to the detailed screen for the selected instance. 
6. Navigate to Remote Management, and then review the on-screen instructions.
   • You can use the populated command to connect to your virtual machine and execute commands.   
   • For additional connection information, see Step 2: Connect to a virtual machine.

Step 2: Connect to a virtual machine

After you enable remote access for a virtual machine, you can connect to the virtual machine via a serial console or VNC.

• VNC (also known as Virtual Network Computing) is a graphical desktop sharing system that is used to remotely control another computer. It relays input events and visual updates between two connected computers, a VNC server and a VNC Client. StackPath manages a VNC server that coordinates communications between your VM and your local computer 's VNC Client.
  • To learn more, see Option 1: Connect to a VNC.
• The serial console utilizes serial communication to open a terminal to your virtual machine.
  • To learn more, see Option 2: Connect to a serial console.

Option 1: Connect to a VNC

1. Review the list of VNC clients that are compatible with remote access. (Other VNC clients may work but require additional configuration.) 
   • Windows
     • RealVNC Viewer
       • Additional Configuration: Change picture quality to Medium
         Select your connection > Properties > Options > General > Picture Quality
     • TigerVNC Viewer
     • TightVNC Viewer
   • MacOS
     • RealVNC Viewer
       • Additional Configuration: Change picture quality to Medium
         Select your connection > Properties > Options > General > Picture Quality
     • TigerVNC Viewer
     • iTeleport
   • Linux
     • RealVNC Viewer
       • Additional Configuration: Change picture quality to Medium
         Select your connection > Properties > Options > General > Picture Quality
     • TigerVNC Viewer
2. Open a command line interface, and enter the following command with your virtual machine's information:

   ssh -p 9600 -L 5900:vnc:5900 <stack-id>.<instance-name>.<portal-username>@vnc-console.edgeengine.io

   • As an option, you can copy and paste the populated command from the Remote Management section. 
3. Press Enter, and then when prompted, enter your StackPath account password.  

   $ ssh -p 9600 -L 5900:vnc:5900 <stack-id>.<instance-name>.<portal-username>@vnc-console.edgeengine.io
   Welcome to StackPath VNC
   Password: 

4. A VNC session is now open and ready to connect to using your VNC Client.
   • New connections will be accepted in the next 5 minutes.

Option 2: Connect to a serial console

1. Review the following command format: 

   ssh -p 9600 -L 5900:vnc:5900 <stack-id>.<instance-name>.<portal-username>@vnc-console.edgeengine.io

2. In a command line interface, enter the above command with your virtual machine's information.
   • As an option, you can copy and paste the populated command from the Remote Management section. 
3. Press Enter, and then when prompted, enter your StackPath account password. 

   $ ssh -p 9600 <stack-id>.<instance-name>.<portal-username>@serial-console.edgeengine.io
   Welcome to StackPath Serial Console
   Password: 

4. A serial connection will establish, and you will be forwarded to your last known state on the virtual machine.
   • If you are prompted to log in, then enter the username and password of your manually created user to log in to the instance.
   • You are now connected and have your user's full permissions to manage your virtual machine.