Skip to content
Beginner 5 minutes

Partner Configurations

Understand A-End vs B-End partner configs on a VXC — why only one side typically needs one, and how to answer the interactive prompts

Prerequisites

  • Familiarity with Ports, MCRs, MVEs, and VXCs

Every VXC has two ends — A-End and B-End — and each end is either one of your own Megaport services (Port, MCR, MVE) or a partner destination (AWS, Azure, GCP, Megaport Internet). When the CLI provisions the VXC, your own services don't need any extra information beyond a UID and VLAN, but partner destinations need a small JSON block called a partner configuration that tells Megaport how to wire the connection on the partner side.

This is what the interactive mode is asking when it prompts:

text
Do you want to configure A-End partner? (yes/no):
Do you want to configure B-End partner? (yes/no):

It's asking whether to attach a partner-config block to that end of the VXC.


The rule

  • A-End is almost always your service (the Port, MCR, or MVE you're connecting from). Answer No.
  • B-End is the destination. Answer Yes only if it's a cloud or Megaport service that requires a partner-config block.

Decision table

ScenarioA-End partner?B-End partner?Why
Port → AWS Direct ConnectNoYesB-End needs connectType: "AWS" (or "AWSHC") plus ownerAccount, asn, etc.
Port → Azure ExpressRouteNoYesB-End needs connectType: "AZURE" plus serviceKey
Port → GCP Partner InterconnectNoYesB-End needs connectType: "GOOGLE" plus pairingKey
Port / MCR / MVE → Megaport InternetNoYesB-End needs connectType: "TRANSIT"
MCR → AWS / Azure / GCPNoYesSame as Port → cloud — partner config goes on B-End
MVE → AWS / Azure / GCPNoYesSame as above; specify --a-end-vnic-index for the MVE's vNIC
Port → Port (private peering on your own services)NoNoBoth ends are services you own
MCR → MCR (transit between your own routers)NoNoBoth ends are services you own
Port → another customer's service via Service KeyNoNoService key handles the partner side; no partner config block required
💡

The shortest mental model

Partner configs describe how to talk to something Megaport doesn't directly own — a cloud provider, a transit router, or a marketplace partner. If the destination is your own Port, MCR, or MVE, no partner config is needed.


Examples by destination

AWS — connectType: "AWS" or "AWSHC"

json
"bEndConfiguration": {
  "productUID": "<AWS-PARTNER-PORT-UID>",
  "partnerConfig": {
    "connectType": "AWS",
    "ownerAccount": "123456789012",
    "type": "private",
    "asn": 65000
  }
}

Azure — connectType: "AZURE"

json
"bEndConfiguration": {
  "partnerConfig": {
    "connectType": "AZURE",
    "serviceKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}

(Azure auto-discovers the partner port from the service key, so productUID is optional.)

GCP — connectType: "GOOGLE"

json
"bEndConfiguration": {
  "productUID": "<GCP-PARTNER-PORT-UID>",
  "partnerConfig": {
    "connectType": "GOOGLE",
    "pairingKey": "fbbf41b1-9513-4837-a91a-22a8bb065704/us-west1/2"
  }
}

Megaport Internet — connectType: "TRANSIT"

json
"bEndConfiguration": {
  "productUID": "<TRANSIT-PARTNER-PORT-UID>",
  "partnerConfig": {
    "connectType": "TRANSIT"
  }
}

Where partner configs go in CLI flags

ModeFlag / key
Flag mode--b-end-partner-config '{...}' (or --a-end-partner-config in rare cases)
JSON modebEndConfiguration.partnerConfig (or aEndConfiguration.partnerConfig)
InteractivePrompt: "Do you want to configure A-End/B-End partner? (yes/no)"

In every mode, you only fill in the side that points at a partner destination — typically B-End.


When would I configure A-End partner?

Rarely. The A-End partner-config slot exists for advanced cases where the source side of the VXC needs partner-side metadata — for example, certain marketplace flows or service-key consumers where Megaport needs to authenticate the A-End to a partner. If you're following the AWS / Azure / GCP / Megaport Internet tutorials, you can answer No to the A-End partner prompt every time.


What's next?