Oracle Cloud Infrastructure Documentation

Instance Console Connections

The Oracle Cloud Infrastructure Compute service provides console connections that enable you to remotely troubleshoot malfunctioning instances, such as:

  • An imported or customized image that does not complete a successful boot.
  • A previously working instance that stops responding.

There are two types of instance console connections:

  • Serial console connections

  • VNC console connections

Creating the Instance Console Connection

Before you can connect to the serial console or VNC console, you need to create the instance console connection.

To create the console connection for an instance

Once the console connection has been created and is available, the status changes to ACTIVE.

Connecting to the Serial Console

Once you have created the console connection for the instance, you can then connect to the serial console by using a Secure Shell (SSH) connection. Once you are finished with the serial console and have terminated the SSH connection, you should delete the serial console connection. If you do not disconnect from the session, Oracle Cloud Infrastructure will terminate the serial console session after 24 hours and you will need to re-authenticate to connect again.

Note

Serial console connections for VM instances launched prior to September 2017

Serial console connections only work for VM instances launched in September 2017 or later.

Note

Serial console connections for bare metal instances launched prior to November 2017

Serial console connections only work for Bare Metal instances launched in November 2017 or later.

Connecting from Mac OS X and Linux Operating Systems

You connect to the serial console by using an SSH client. Mac OS X and most Linux distributions by default include the SSH client OpenSSH.

To connect to the serial console for an instance using OpenSSH on Mac OS X or Linux

Connecting from Windows Operating Systems

Windows does not include an SSH client by default, so you need to install one. You can use PuTTY, or there are options that include a version of OpenSSH such as:

Note that the steps to connect to the serial console from the PuTTY client will be different than the steps for OpenSSH.

To connect to the serial console for an instance on Microsoft Windows

Connecting to the VNC Console

Warning

The VNC console connection uses SSH port forwarding to create a secure connection from your local system to the VNC server attached to your instance's console. While this is a secure way to use VNC over the internet, owners of multiuser systems should be aware that opening a port on the local system makes it available to all of the users on that system until a VNC client connects. For this reason, we don't recommend using this product on a multiuser system unless you take proper actions to secure the port or you isolate the VNC client by running it in a virtual environment, such as Oracle VM VirtualBox.

Once you have created the console connection for the instance, you need to set up a secure tunnel to the VNC server on the instance, and then you can connect with a VNC client.

Note

VNC console connections for VM instances launched prior to October 13th, 2017

VNC console connections only work for VM instances launched on October 13th, 2017 or later.

Note

VNC console connections for bare metal instances launched prior to February 21, 2019

VNC console connections only work for bare metal instances launched on February 21st, 2019 or later, using one of the following shapes:

  • BM.GPU2.2

  • BM.HPC2.36

  • BM.Standard2.52

  • BM.DenseIO2.52

To set up a secure tunnel to the VNC server on the instance using OpenSSH on Mac OS X or Linux
To set up a secure tunnel to the VNC server on the instance using PowerShell on Windows
Note

Secure Connection Warning

When you connect, you may see a warning from the VNC client that the connection is not encrypted. Since you are connecting through SSH, the connection is secure, so this is not an issue.

Troubleshooting Instances from Instance Console Connections

Once you are connected with an instance console connection, you can perform various tasks, such as:

  • Edit system configuration files.
  • Add or reset the SSH keys for the opc user.

Both of these tasks require you to boot into a bash shell, in maintenance mode.

Note

The following tasks describe steps specific to instances running Oracle Linux 7, connecting from OpenSSH. Other OS versions and SSH clients may require different steps.

To boot into maintenance mode

Once the instance has rebooted, you'll see the Bash shell command-line prompt, and you can proceed with either of the following procedures.

To edit the system configuration files
To add or reset the SSH key for the opc user

Exiting the Instance Console Connection

To exit the serial console connection
To exit the VNC console connection

Once you are finished using the console connection, delete the connection for the instance.

To delete the console connection for an instance