> ## Documentation Index
> Fetch the complete documentation index at: https://docs.megaport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Using the MVE Console

> This help topic describes how to access and use the MVE Console directly from the Megaport Portal.

export const Video = ({url, text, duration, description}) => {
  const errorPrefix = '\x1b[31;1;4mERROR\x1b[0m: Video -';
  if (typeof url !== 'string') {
    url = String(url);
  }
  if (typeof text !== 'string') {
    text = String(text);
  }
  if (!url || url === 'undefined') {
    console.error(`${errorPrefix} the \`url\` property is required — rendering an empty string instead`);
    return <></>;
  }
  if (!text || text === 'undefined') {
    console.error(`${errorPrefix} the \`text\` property is required — rendering an empty string instead`);
    return <></>;
  }
  const youtubeIconMask = "url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 576 512'%3E%3Cpath d='M549.7 124.1c-6.3-23.7-24.8-42.3-48.3-48.6C458.8 64 288 64 288 64S117.2 64 74.6 75.5c-23.5 6.3-42 24.9-48.3 48.6-11.4 42.9-11.4 132.3-11.4 132.3s0 89.4 11.4 132.3c6.3 23.7 24.8 41.5 48.3 47.8C117.2 448 288 448 288 448s170.8 0 213.4-11.5c23.5-6.3 42-24.2 48.3-47.8 11.4-42.9 11.4-132.3 11.4-132.3s0-89.4-11.4-132.3zM232 336V176l142.7 80z'/%3E%3C/svg%3E\")";
  return <div className="video-callout">
      <div className="callout my-4 flex gap-3 overflow-hidden rounded-2xl border px-5 py-4">
        <div className="mt-0.5 w-4 shrink-0" data-component-part="callout-icon">
          <svg aria-hidden="true" className="size-4 shrink-0" style={{
    WebkitMaskImage: youtubeIconMask,
    maskImage: youtubeIconMask,
    WebkitMaskRepeat: 'no-repeat',
    maskRepeat: 'no-repeat',
    WebkitMaskPosition: 'center',
    maskPosition: 'center',
    backgroundColor: '#0284c7'
  }} />
        </div>
        <div className="min-w-0 w-full text-sm" data-component-part="callout-content">
          <strong>
            Video:{' '}
            <a href={url} target="_blank" rel="noopener noreferrer">
              {text}
              <span className="sr-only"> (opens in a new tab)</span>
            </a>
          </strong>
          {}
          {duration && <> ({duration})</>}
          {}
          {description && <p className="mt-1 mb-0 text-xs text-gray-500 dark:text-gray-400">
              {description}
            </p>}
        </div>
      </div>
    </div>;
};

export const Link = ({href, children}) => {
  const errorPrefix = '\x1b[31;1;4mERROR\x1b[0m: Link -';
  if (typeof href !== 'string') {
    href = String(href);
  }
  if (!href || href === 'undefined') {
    console.error(`${errorPrefix} the \`href\` property is required — rendering an empty string instead`);
    return <></>;
  }
  if (href.includes('{') || href.toUpperCase().includes('%7B')) {
    console.error(`${errorPrefix} could not resolve a variable in href "${href}" — rendering an empty string instead`);
    return <></>;
  }
  const isExternal = (/^https?:\/\//).test(href);
  return <a href={href} className="link" target={isExternal ? '_blank' : undefined} rel={isExternal ? 'noreferrer' : undefined}>
      {children ?? href}
      {isExternal && <span className="sr-only"> (opens in a new tab)</span>}
    </a>;
};

export const InlineImage = ({src, alt, height = 16, shadow, width}) => {
  const errorPrefix = '\x1b[31;1;4mERROR\x1b[0m: InlineImage -';
  if (typeof src !== 'string') {
    src = String(src);
  }
  if (!src || src === 'undefined') {
    console.error(`${errorPrefix} \`src\` is required — rendering an empty string instead`);
    return <></>;
  }
  if (typeof alt !== 'string') {
    alt = String(alt);
  }
  if (alt === 'undefined') {
    console.error(`${errorPrefix} \`alt\` is required (use "" for decorative images) — rendering an empty string instead`);
    return <></>;
  }
  if (height) {
    height = height.toString().replaceAll(/\D/g, '');
  }
  if (width) {
    width = width.toString().replaceAll(/\D/g, '');
  }
  return <img className={['inline-icon', shadow ? 'shadow' : null, 'm-0'].filter(Boolean).join(' ')} src={src} alt={alt} height={height} width={width} style={{
    display: 'inline',
    verticalAlign: 'middle',
    maxHeight: height ? `${height}px` : undefined,
    maxWidth: width ? `${width}px` : undefined,
    height: height ? `${height}px` : undefined,
    width: width ? `${width}px` : undefined
  }} />;
};

This topic describes how to access and use the MVE Console directly from the Megaport Portal.

The MVE Console provides direct access to your MVE instance through a browser-based interface. You can troubleshoot connectivity issues, view system logs, configure your MVE, and perform administrative tasks without additional tools or VPN connections. For detailed configuration, troubleshooting, and advanced operations, see your vendor’s official documentation and supported management tool.

## Use cases for the MVE Console

These are the main use cases for the MVE Console:

* **Troubleshooting connectivity issues** -- Diagnose and resolve issues if your MVE loses network connectivity.
* **Initial configuration** -- Perform initial setup tasks before network connectivity is established.
* **System administration** -- View system logs, monitor resource usage, and perform maintenance tasks.
* **Emergency access** -- Access your MVE when other remote access methods are unavailable.
* **Power management** -- Perform shutdown, reboot, or reset operations from the console controls.

## Prerequisites

To access the MVE Console, you need:

* An active MVE service that supports MVE Console access.

  The MVE Console  access is enabled by default for supported MVE services, and no additional configuration in the Megaport Portal is required.
  When console access is not available, use the vendor-specific management tools or CLI methods for your MVE.

* Appropriate account permissions:
  * **Company Admins, Technical Admins, and Technical Contacts** -- Can access the console for their company's MVE services. For more information about which roles have console access, see [Managing User Roles](/portal-admin/user-management/roles).
  * **Partners** -- Can access the console for their managed accounts' MVE services when viewing those accounts in the Megaport Portal.
  * **Managed account users** -- Can access the console for their MVE services (subject to their account permissions).

<Note>
  Partners can access the console only when viewing a managed account's services. The Console Access button is not available when partners view their own company's MVE services.
</Note>

## Accessing the MVE Console

You can open the MVE Console from the Megaport Portal.

**To access the MVE Console**

1. In the <Link href="https://portal.megaport.com">Megaport Portal</Link>, go to the **Services** page.
2. Locate your MVE and click the <InlineImage src="/images/mve/console.png" alt="Console access icon" /> icon.

   The console automatically connects to your MVE when the page loads. The connection uses a secure, temporary authentication token that is valid for the duration of your session.

## Using the MVE Console

The MVE Console provides a full-screen view of your MVE instance, with a control bar at the top.

### Console controls

The control bar includes these options:

* **Connect** -- Manually connect to the MVE if the connection is not active.

* **Disconnect** -- Disconnect from the MVE Console session. Once disconnected, you can connect again manually by either closing the tab or clicking **Connect**.

  <Note>
    Power operations (shutdown, reboot, and reset) will interrupt your MVE service. Use these options carefully and only when necessary.

    If the connection is interrupted, the console automatically attempts to reconnect after a few seconds. You can also manually reconnect by clicking **Connect**.
  </Note>

* **Fullscreen** -- Toggle fullscreen mode for the console view.

* **Clipboard** -- Paste text into the MVE Console, including commands, configuration text, passwords, API keys, or any other content, from your local machine into the MVE Console.

  **To paste text to the MVE Console**

  1. Click **Clipboard**.
  2. In the Paste to Console screen, type or paste your text into the text area.
  3. Click **Paste to Console** to send the text to your MVE.

  The text is sent to the console as if you were typing it directly. Multi-line text is supported, with line breaks converted to Enter key presses. After the text is sent, the screen closes and the text area is cleared.

  <Note>
    The clipboard paste feature supports ASCII printable characters only (letters A-Z, numbers 0-9, common symbols, spaces, tabs, and line breaks). Non-ASCII characters such as accented letters (é, ñ), non-Latin scripts (中文, العربية), and emoji are automatically skipped during paste. If your text contains non-ASCII characters, you will need to type those characters manually after pasting the rest of your text.
  </Note>

  <Note>
    The Clipboard button is available only when the console is connected. If you are not connected, use the Connect button first.
  </Note>

* **Notifications**

  The Notifications button provides access to console event notifications and connection status messages. A badge on the button shows the number of unread notifications.

  Notifications include:

  * Connection status updates (connected, disconnected, reconnecting)
  * Session timeout warnings
  * Console bell signals from the remote system
  * Connection errors and diagnostic messages

  **To view notifications**

  1. Click **Notifications**.

     The notifications panel opens, displaying recent console events with timestamps.

  2. Click **Clear All** to remove all notifications from the panel.

  When you open the notifications panel, all notifications are automatically marked as read, and the badge counter is cleared. Important notifications also appear as pop-up messages in the console interface.

## Console session timeouts

Console sessions have time limits. Your console session can end for these reasons:

* **Maximum session duration** -- Each console session has a maximum allowed duration. When you connect to the console, your session token includes this time limit. You will receive a warning notification 10 minutes before your session expires.
* **Inactivity timeout** -- If you don't interact with the console for a period of time, your session automatically disconnects.

When a session timeout occurs:

1. The console automatically disconnects.
2. A notification appears explaining the reason for the disconnect.
3. You can reconnect immediately by clicking **Connect**.

To avoid losing work due to timeouts:

* Save your work frequently, especially when performing long-running configuration tasks.
* Watch for timeout warning notifications and reconnect if needed.
* Keep the console tab active when you are working on extended tasks.

<Note>
  Reconnecting after a timeout creates a new console session. If you were in the middle of a task, you might need to navigate back to where you were working.
</Note>

## Troubleshooting console access

Use these troubleshooting steps to resolve common MVE Console access issues.

### Console Access button is disabled

The Console Access button appears grayed out with a tooltip stating 'Not supported on this platform'. Your MVE vendor platform doesn't support the MVE Console access. This is a limitation of the specific MVE vendor or image you are using, not an account permission issue.

Your MVE service functions normally, only the browser-based console access feature is unavailable. To manage your MVE, use your vendor-specific management tools or CLI access methods.

### Cannot access the console

If you cannot access the MVE Console:

* Verify that your MVE is in a live state (not being provisioned or terminated).
* Confirm that you have the appropriate account permissions.
* Concurrent access is not supported. If a console session already exists for that MVE, close the session and use the existing one.
* Try refreshing the browser page to establish a new connection.
* **For partners**: Ensure you are viewing a managed account's services. The Console Access button is not available when viewing your own company's MVE services.

If you experience connection issues while using the console:

* Check your internet connection stability.
* Disable any browser extensions that might interfere with WebSocket connections.
* Try using a different browser if the issue persists.

### Connection fails with 'session already exists' error

The MVE Console allows only one active connection at a time. If you see a 'session already exists' notification, a console session is already open.

This can happen if:

* The console is open in another browser tab or window
* A previous session didn't close properly after a network interruption
* Another user with access to your account is connected to the console

To resolve this:

1. Check for other open console tabs or windows and close them.
2. If you don't have any other console sessions open, wait a few minutes for the previous session to time out.
3. If the issue persists, click **Disconnect**, then **Connect** to force a new connection.

If another authorized user needs console access, the current user must disconnect first.

## Console security and session management

The MVE Console uses the following security measures:

* Connections are encrypted using WebSocket Secure (WSS) protocol.
* Each console session uses a temporary authentication token that expires when the session ends.
* Console access requires appropriate account permissions and cannot be accessed without authentication.

<Note>
  For stronger security, Megaport recommends enabling Single Sign-On (SSO) or Multi-Factor Authentication (MFA) for your company. For more information, see [Setting up Single Sign-On](/setting-up/enforcing-sso) and [Multi-Factor Authentication](/setting-up/enforcing-mfa).
</Note>

Close the console browser tab or window when you are finished to ensure your session is terminated.

## Helpful references

<Video url="https://www.youtube.com/watch?v=MkYtlmAqRGY" text="How to Check the Status of Your Megaport Services" duration="1:02" description="This video shows how to check the status of Megaport services directly from the Megaport Portal." />

* [Monitoring MCR](/monitoring/mcr-monitoring)
* [Monitoring MVE](/monitoring/mve-monitoring)
* [Monitoring Ports, VXCs, Megaport Internet, and IXs](/monitoring/port-vxc-monitoring)
* [Viewing Activity Logs](/portal-admin/activity-logs)