Skip to content
Megaport Documentation
Service Keys

Setting Up Service Keys

A service key is a code that is given by one Megaport account holder to another to connect two separate businesses together. Customers who have separate Megaport accounts can connect their Ports to each other across the Megaport network, enabling business-to-business VXCs.

For example, suppose Company B wants to establish a connection with Company A. Company A wants Company B to connect to a particular Port on the Megaport network that they have already deployed, and they want the connection at a specific rate limit.

The service key process is:

  1. Company A creates a service key that is preconfigured with their required settings.
  2. Company A shares the service key with Company B.
  3. Company B accepts the service key and uses it to create a VXC back to Company A.

Play video   Watch a 7-minute video for service keys for VXCs.

Requirements and assumptions

Before you create a service key, ensure that you meet these requirements:

  • Access to the Megaport Portal
  • Both you and your customer have Ports on the Megaport network, with live cross connects on both ends
  • Layer 2/Layer 3 devices are on each end terminating the physical connections
  • Equipment supporting 802.1q trunking is on the two links connecting into Megaport

Creating a service key

You can create either a single use or a multi-use service key. With a multi-use key, the customer that you share the key with can request multiple connections using that key.

Important

Once you create service keys, they cannot be removed.

To create a service key

  1. In the Megaport Portal, go to the Services page and select the Port you want to use.

  2. Click the Service Keys icon.
    Service Keys icon

  3. Click Add.

  4. Enter a label (name) for the key.
  5. Select Single Use or Multi-Use.
  6. Enter a rate limit.
  7. For single use keys only, specify a VLAN ID. This the VLAN ID for the B-End. Megaport checks that the requested VLAN ID is available. If the VLAN ID is already in use, an error message tells you the VLAN is not available. When a customer uses this service key to create a connection, they can specify a VLAN ID for the A-End.
  8. Specify how long the key will be valid.
  9. Select Active.
    If you don’t want the key to be available right away, do not select Active. You can edit this key later to change this setting.
  10. Click Add to save the key.
    Service key configuration

Note

After you deploy a service key on a B-End circuit, you cannot reuse the associated B-End VLAN ID if there is already a service key using that same VLAN ID on that Port.

Viewing, copying, and editing a service key

When configured, service keys appear in the Portal. Click the Service Key icon for a Port to show the configured keys.

Note

The Service Key icon will display only if the Port is available for new connections, the current user has ordering privileges, and it does not already have an untagged VXC attached.

Click the clipboard icon to copy the key, or click Edit to make changes.

Service key details

To disable a service key

  1. In the Megaport Portal, go to the Services page and select the Port you want to use.

  2. Click the Service Keys icon.
    Service Keys icon

  3. Click Edit.

  4. Clear the Active check box.

  5. Click Save.

Sharing the key

You can share the key however you prefer, such as email or messaging.

When you copy and send the key, recipients can create a VXC to you based on your parameters. Remember, both you and your customers must have active Ports on the Megaport network for this to work.

Note

The end user cannot alter or modify the service key parameters.

Creating a VXC with a service key

Once the service key is created and shared, anybody with the key can create a connection.

To create a VXC with a service key

  1. In the Megaport Portal, go to the Services page and select the Port you want to use.

  2. Click +Connection then click Enter Service Key.
    Enter Service Key

  3. Enter the service key in the Megaport Service Key ID field.
    Megaport validates the key and displays basic information about the key.
    Service key validation

  4. Click Next.

  5. Specify the connection details:

    • Connection Name – The name of your VXC to be shown in the Megaport Portal.

    • Service Level Reference (optional) – Specify a unique identifying number for the VXC to be used for billing purposes, such as a cost center number or a unique customer ID. The service level reference number appears for each service under the Product section of the invoice. You can also edit this field for an existing service.

    • Rate Limit – The speed of your connection in Mbps, up to the maximum limit defined by the key.

    • VXC State – Select Enabled or Shut Down to define the initial state of the connection. For more information, see Shutting Down a VXC for Failover Testing.

      Note

      If you select Shut Down, traffic will not flow through this service and it will behave as if it was down on the Megaport network. Billing for this service will remain active and you will still be charged for this connection.

    • Preferred A-End VLAN (optional) – Specify an unused VLAN ID for this connection.
      This must be a unique VLAN ID on this Port and can range from 2 to 4093. If you specify a VLAN ID that is already in use, the system displays the next available VLAN number. The VLAN ID must be unique to proceed with the order. If you don’t specify a value, Megaport will assign one.

      The B-End VLAN for the provider side termination will be automatically populated based on the service key.

    • Minimum Term – Select No Minimum Term, 12 Months, 24 Months, or 36 Months. Longer terms result in a lower monthly rate. 12 Months is selected by default.
      Take note of the information on the screen to avoid early termination fees (ETF). See VXC Pricing and Contract Terms and VXC, Megaport Internet, and IX Billing for more information.

    Add VXC details

  6. Click Next.
    A summary page appears that includes the monthly cost. Click Back to make changes or click Add VXC to move this configuration to your cart. Once you have finished this configuration, you can configure additional VXCs or proceed through the ordering process.

  7. After ordering the key, a notification is sent to the company that you are connecting to, and the receiving company can either accept or reject the key. They cannot alter the key but can request modifications to the service key parameters before accepting it.
    The service key VXC will appear in the Megaport Portal for both companies as shown below.

    This image shows the service key VXC that both companies will see in the Megaport Portal

Last update: 2024-04-19